Class: AmznSpApi::FulfillmentInboundApiModel::FbaInboundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FbaInboundApi

Returns a new instance of FbaInboundApi.



14
15
16
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 14

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



12
13
14
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 12

def api_client
  @api_client
end

Instance Method Details

#confirm_preorder(shipment_id, need_by_date, marketplace_id, opts = {}) ⇒ ConfirmPreorderResponse

Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • need_by_date —

    Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace the shipment is tied to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 24

def confirm_preorder(shipment_id, need_by_date, marketplace_id, opts = {})
  data, _status_code, _headers = confirm_preorder_with_http_info(shipment_id, need_by_date, marketplace_id, opts)
  data
end

#confirm_preorder_with_http_info(shipment_id, need_by_date, marketplace_id, opts = {}) ⇒ Array<(ConfirmPreorderResponse, Integer, Hash)>

Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • need_by_date —

    Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace the shipment is tied to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ConfirmPreorderResponse, Integer, Hash)>) —

    ConfirmPreorderResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 35

def confirm_preorder_with_http_info(shipment_id, need_by_date, marketplace_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.confirm_preorder ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.confirm_preorder" if @api_client.config.client_side_validation && shipment_id.nil?
  # verify the required parameter 'need_by_date' is set
  raise ArgumentError, "Missing the required parameter 'need_by_date' when calling FbaInboundApi.confirm_preorder" if @api_client.config.client_side_validation && need_by_date.nil?
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.confirm_preorder" if @api_client.config.client_side_validation && marketplace_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/preorder/confirm'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:NeedByDate] = need_by_date
  query_params[:MarketplaceId] = marketplace_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'ConfirmPreorderResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#confirm_preorder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#confirm_transport(shipment_id, opts = {}) ⇒ ConfirmTransportResponse

Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller’s account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 82

def confirm_transport(shipment_id, opts = {})
  data, _status_code, _headers = confirm_transport_with_http_info(shipment_id, opts)
  data
end

#confirm_transport_with_http_info(shipment_id, opts = {}) ⇒ Array<(ConfirmTransportResponse, Integer, Hash)>

Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller&#x27;s account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ConfirmTransportResponse, Integer, Hash)>) —

    ConfirmTransportResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 91

def confirm_transport_with_http_info(shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.confirm_transport ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.confirm_transport" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport/confirm'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'ConfirmTransportResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#confirm_transport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#create_inbound_shipment(body, shipment_id, opts = {}) ⇒ InboundShipmentResponse

Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



133
134
135
136
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 133

def create_inbound_shipment(body, shipment_id, opts = {})
  data, _status_code, _headers = create_inbound_shipment_with_http_info(body, shipment_id, opts)
  data
end

#create_inbound_shipment_plan(body, opts = {}) ⇒ CreateInboundShipmentPlanResponse

Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon’s fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 188

def create_inbound_shipment_plan(body, opts = {})
  data, _status_code, _headers = create_inbound_shipment_plan_with_http_info(body, opts)
  data
end

#create_inbound_shipment_plan_with_http_info(body, opts = {}) ⇒ Array<(CreateInboundShipmentPlanResponse, Integer, Hash)>

Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon&#x27;s fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

Raises:

  • (ArgumentError) 


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 197

def create_inbound_shipment_plan_with_http_info(body, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.create_inbound_shipment_plan ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaInboundApi.create_inbound_shipment_plan" if @api_client.config.client_side_validation && body.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/plans'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'CreateInboundShipmentPlanResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#create_inbound_shipment_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#create_inbound_shipment_with_http_info(body, shipment_id, opts = {}) ⇒ Array<(InboundShipmentResponse, Integer, Hash)>

Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InboundShipmentResponse, Integer, Hash)>) —

    InboundShipmentResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 143

def create_inbound_shipment_with_http_info(body, shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.create_inbound_shipment ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaInboundApi.create_inbound_shipment" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.create_inbound_shipment" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'InboundShipmentResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#create_inbound_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#estimate_transport(shipment_id, opts = {}) ⇒ EstimateTransportResponse

Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 240

def estimate_transport(shipment_id, opts = {})
  data, _status_code, _headers = estimate_transport_with_http_info(shipment_id, opts)
  data
end

#estimate_transport_with_http_info(shipment_id, opts = {}) ⇒ Array<(EstimateTransportResponse, Integer, Hash)>

Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EstimateTransportResponse, Integer, Hash)>) —

    EstimateTransportResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 249

def estimate_transport_with_http_info(shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.estimate_transport ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.estimate_transport" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport/estimate'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'EstimateTransportResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#estimate_transport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_bill_of_lading(shipment_id, opts = {}) ⇒ GetBillOfLadingResponse

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



290
291
292
293
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 290

def get_bill_of_lading(shipment_id, opts = {})
  data, _status_code, _headers = get_bill_of_lading_with_http_info(shipment_id, opts)
  data
end

#get_bill_of_lading_with_http_info(shipment_id, opts = {}) ⇒ Array<(GetBillOfLadingResponse, Integer, Hash)>

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetBillOfLadingResponse, Integer, Hash)>) —

    GetBillOfLadingResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 299

def get_bill_of_lading_with_http_info(shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_bill_of_lading ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.get_bill_of_lading" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/billOfLading'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetBillOfLadingResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_bill_of_lading\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_inbound_guidance(marketplace_id, opts = {}) ⇒ GetInboundGuidanceResponse

Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon’s fulfillment network. Sellers may still ship items that are not recommended, at their discretion. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :seller_sku_list (Array<String>) —

    A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.

  • :asin_list (Array<String>) —

    A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.

Returns:



342
343
344
345
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 342

def get_inbound_guidance(marketplace_id, opts = {})
  data, _status_code, _headers = get_inbound_guidance_with_http_info(marketplace_id, opts)
  data
end

#get_inbound_guidance_with_http_info(marketplace_id, opts = {}) ⇒ Array<(GetInboundGuidanceResponse, Integer, Hash)>

Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon&#x27;s fulfillment network. Sellers may still ship items that are not recommended, at their discretion. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :seller_sku_list (Array<String>) —

    A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.

  • :asin_list (Array<String>) —

    A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon&#x27;s fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.

Returns:

  • (Array<(GetInboundGuidanceResponse, Integer, Hash)>) —

    GetInboundGuidanceResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 353

def get_inbound_guidance_with_http_info(marketplace_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_inbound_guidance ...' if @api_client.config.debugging
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_inbound_guidance" if @api_client.config.client_side_validation && marketplace_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/itemsGuidance'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:MarketplaceId] = marketplace_id
  query_params[:SellerSKUList] = @api_client.build_collection_param(opts[:seller_sku_list], :csv) unless opts[:seller_sku_list].nil?
  query_params[:ASINList] = @api_client.build_collection_param(opts[:asin_list], :csv) unless opts[:asin_list].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetInboundGuidanceResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_inbound_guidance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_labels(shipment_id, page_type, label_type, opts = {}) ⇒ GetLabelsResponse

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • page_type —

    The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

  • label_type —

    The type of labels requested.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :number_of_packages (Integer) —

    The number of packages in the shipment.

  • :package_labels_to_print (Array<String>) —

    A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.

  • :number_of_pallets (Integer) —

    The number of pallets in the shipment. This returns four identical labels for each pallet.

  • :page_size (Integer) —

    The page size for paginating through the total packages&#x27; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.

  • :page_start_index (Integer) —

    The page start index for paginating through the total packages&#x27; labels. This is a required parameter for Non-Partnered LTL Shipments.

Returns:



404
405
406
407
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 404

def get_labels(shipment_id, page_type, label_type, opts = {})
  data, _status_code, _headers = get_labels_with_http_info(shipment_id, page_type, label_type, opts)
  data
end

#get_labels_with_http_info(shipment_id, page_type, label_type, opts = {}) ⇒ Array<(GetLabelsResponse, Integer, Hash)>

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • page_type —

    The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

  • label_type —

    The type of labels requested.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :number_of_packages (Integer) —

    The number of packages in the shipment.

  • :package_labels_to_print (Array<String>) —

    A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.

  • :number_of_pallets (Integer) —

    The number of pallets in the shipment. This returns four identical labels for each pallet.

  • :page_size (Integer) —

    The page size for paginating through the total packages&#x27; labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.

  • :page_start_index (Integer) —

    The page start index for paginating through the total packages&#x27; labels. This is a required parameter for Non-Partnered LTL Shipments.

Returns:

  • (Array<(GetLabelsResponse, Integer, Hash)>) —

    GetLabelsResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 420

def get_labels_with_http_info(shipment_id, page_type, label_type, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_labels ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.get_labels" if @api_client.config.client_side_validation && shipment_id.nil?
  # verify the required parameter 'page_type' is set
  raise ArgumentError, "Missing the required parameter 'page_type' when calling FbaInboundApi.get_labels" if @api_client.config.client_side_validation && page_type.nil?
  # verify enum value
  raise ArgumentError, "invalid value for 'page_type', must be one of PackageLabel_Letter_2, PackageLabel_Letter_4, PackageLabel_Letter_6, PackageLabel_Letter_6_CarrierLeft, PackageLabel_A4_2, PackageLabel_A4_4, PackageLabel_Plain_Paper, PackageLabel_Plain_Paper_CarrierBottom, PackageLabel_Thermal, PackageLabel_Thermal_Unified, PackageLabel_Thermal_NonPCP, PackageLabel_Thermal_No_Carrier_Rotation" if @api_client.config.client_side_validation && !%w[PackageLabel_Letter_2 PackageLabel_Letter_4 PackageLabel_Letter_6 PackageLabel_Letter_6_CarrierLeft PackageLabel_A4_2 PackageLabel_A4_4 PackageLabel_Plain_Paper PackageLabel_Plain_Paper_CarrierBottom PackageLabel_Thermal PackageLabel_Thermal_Unified PackageLabel_Thermal_NonPCP PackageLabel_Thermal_No_Carrier_Rotation].include?(page_type)
  # verify the required parameter 'label_type' is set
  raise ArgumentError, "Missing the required parameter 'label_type' when calling FbaInboundApi.get_labels" if @api_client.config.client_side_validation && label_type.nil?
  # verify enum value
  raise ArgumentError, "invalid value for 'label_type', must be one of BARCODE_2D, UNIQUE, PALLET" if @api_client.config.client_side_validation && !%w[BARCODE_2D UNIQUE PALLET].include?(label_type)

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/labels'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:PageType] = page_type
  query_params[:LabelType] = label_type
  query_params[:NumberOfPackages] = opts[:number_of_packages] unless opts[:number_of_packages].nil?
  query_params[:PackageLabelsToPrint] = @api_client.build_collection_param(opts[:package_labels_to_print], :csv) unless opts[:package_labels_to_print].nil?
  query_params[:NumberOfPallets] = opts[:number_of_pallets] unless opts[:number_of_pallets].nil?
  query_params[:PageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:PageStartIndex] = opts[:page_start_index] unless opts[:page_start_index].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetLabelsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_preorder_info(shipment_id, marketplace_id, opts = {}) ⇒ GetPreorderInfoResponse

Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace the shipment is tied to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



477
478
479
480
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 477

def get_preorder_info(shipment_id, marketplace_id, opts = {})
  data, _status_code, _headers = get_preorder_info_with_http_info(shipment_id, marketplace_id, opts)
  data
end

#get_preorder_info_with_http_info(shipment_id, marketplace_id, opts = {}) ⇒ Array<(GetPreorderInfoResponse, Integer, Hash)>

Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace the shipment is tied to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetPreorderInfoResponse, Integer, Hash)>) —

    GetPreorderInfoResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 487

def get_preorder_info_with_http_info(shipment_id, marketplace_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_preorder_info ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.get_preorder_info" if @api_client.config.client_side_validation && shipment_id.nil?
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_preorder_info" if @api_client.config.client_side_validation && marketplace_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/preorder'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:MarketplaceId] = marketplace_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetPreorderInfoResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_preorder_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_prep_instructions(ship_to_country_code, opts = {}) ⇒ GetPrepInstructionsResponse

Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon’s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • ship_to_country_code —

    The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :seller_sku_list (Array<String>) —

    A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon&#x27;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon&#x27;s retail website. If you include a seller SKU that you have never used to list an item on Amazon&#x27;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.

  • :asin_list (Array<String>) —

    A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.

Returns:



533
534
535
536
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 533

def get_prep_instructions(ship_to_country_code, opts = {})
  data, _status_code, _headers = get_prep_instructions_with_http_info(ship_to_country_code, opts)
  data
end

#get_prep_instructions_with_http_info(ship_to_country_code, opts = {}) ⇒ Array<(GetPrepInstructionsResponse, Integer, Hash)>

Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon&#x27;s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • ship_to_country_code —

    The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :seller_sku_list (Array<String>) —

    A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon&#x27;s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon&#x27;s retail website. If you include a seller SKU that you have never used to list an item on Amazon&#x27;s retail website, the seller SKU is returned in the InvalidSKUList property in the response.

  • :asin_list (Array<String>) —

    A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.

Returns:

  • (Array<(GetPrepInstructionsResponse, Integer, Hash)>) —

    GetPrepInstructionsResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 544

def get_prep_instructions_with_http_info(ship_to_country_code, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_prep_instructions ...' if @api_client.config.debugging
  # verify the required parameter 'ship_to_country_code' is set
  raise ArgumentError, "Missing the required parameter 'ship_to_country_code' when calling FbaInboundApi.get_prep_instructions" if @api_client.config.client_side_validation && ship_to_country_code.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/prepInstructions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:ShipToCountryCode] = ship_to_country_code
  query_params[:SellerSKUList] = @api_client.build_collection_param(opts[:seller_sku_list], :csv) unless opts[:seller_sku_list].nil?
  query_params[:ASINList] = @api_client.build_collection_param(opts[:asin_list], :csv) unless opts[:asin_list].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetPrepInstructionsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_prep_instructions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_shipment_items(query_type, marketplace_id, opts = {}) ⇒ GetShipmentItemsResponse

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • query_type —

    Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :last_updated_after (DateTime) —

    A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :last_updated_before (DateTime) —

    A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :next_token (String) —

    A string token returned in the response to your previous request.

Returns:



592
593
594
595
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 592

def get_shipment_items(query_type, marketplace_id, opts = {})
  data, _status_code, _headers = get_shipment_items_with_http_info(query_type, marketplace_id, opts)
  data
end

#get_shipment_items_by_shipment_id(shipment_id, marketplace_id, opts = {}) ⇒ GetShipmentItemsResponse

Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier used for selecting items in a specific inbound shipment.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



656
657
658
659
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 656

def get_shipment_items_by_shipment_id(shipment_id, marketplace_id, opts = {})
  data, _status_code, _headers = get_shipment_items_by_shipment_id_with_http_info(shipment_id, marketplace_id, opts)
  data
end

#get_shipment_items_by_shipment_id_with_http_info(shipment_id, marketplace_id, opts = {}) ⇒ Array<(GetShipmentItemsResponse, Integer, Hash)>

Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier used for selecting items in a specific inbound shipment.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetShipmentItemsResponse, Integer, Hash)>) —

    GetShipmentItemsResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 666

def get_shipment_items_by_shipment_id_with_http_info(shipment_id, marketplace_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_shipment_items_by_shipment_id ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.get_shipment_items_by_shipment_id" if @api_client.config.client_side_validation && shipment_id.nil?
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_shipment_items_by_shipment_id" if @api_client.config.client_side_validation && marketplace_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/items'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:MarketplaceId] = marketplace_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetShipmentItemsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_shipment_items_by_shipment_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_shipment_items_with_http_info(query_type, marketplace_id, opts = {}) ⇒ Array<(GetShipmentItemsResponse, Integer, Hash)>

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • query_type —

    Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :last_updated_after (DateTime) —

    A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :last_updated_before (DateTime) —

    A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :next_token (String) —

    A string token returned in the response to your previous request.

Returns:

  • (Array<(GetShipmentItemsResponse, Integer, Hash)>) —

    GetShipmentItemsResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 605

def get_shipment_items_with_http_info(query_type, marketplace_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_shipment_items ...' if @api_client.config.debugging
  # verify the required parameter 'query_type' is set
  raise ArgumentError, "Missing the required parameter 'query_type' when calling FbaInboundApi.get_shipment_items" if @api_client.config.client_side_validation && query_type.nil?
  # verify enum value
  raise ArgumentError, "invalid value for 'query_type', must be one of DATE_RANGE, NEXT_TOKEN" if @api_client.config.client_side_validation && !%w[DATE_RANGE NEXT_TOKEN].include?(query_type)
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_shipment_items" if @api_client.config.client_side_validation && marketplace_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipmentItems'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:QueryType] = query_type
  query_params[:MarketplaceId] = marketplace_id
  query_params[:LastUpdatedAfter] = opts[:last_updated_after] unless opts[:last_updated_after].nil?
  query_params[:LastUpdatedBefore] = opts[:last_updated_before] unless opts[:last_updated_before].nil?
  query_params[:NextToken] = opts[:next_token] unless opts[:next_token].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetShipmentItemsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_shipment_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_shipments(query_type, marketplace_id, opts = {}) ⇒ GetShipmentsResponse

Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • query_type —

    Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :shipment_status_list (Array<String>) —

    A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.

  • :shipment_id_list (Array<String>) —

    A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

  • :last_updated_after (DateTime) —

    A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :last_updated_before (DateTime) —

    A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :next_token (String) —

    A string token returned in the response to your previous request.

Returns:



716
717
718
719
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 716

def get_shipments(query_type, marketplace_id, opts = {})
  data, _status_code, _headers = get_shipments_with_http_info(query_type, marketplace_id, opts)
  data
end

#get_shipments_with_http_info(query_type, marketplace_id, opts = {}) ⇒ Array<(GetShipmentsResponse, Integer, Hash)>

Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • query_type —

    Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.

  • marketplace_id —

    A marketplace identifier. Specifies the marketplace where the product would be stored.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :shipment_status_list (Array<String>) —

    A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.

  • :shipment_id_list (Array<String>) —

    A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

  • :last_updated_after (DateTime) —

    A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :last_updated_before (DateTime) —

    A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

  • :next_token (String) —

    A string token returned in the response to your previous request.

Returns:

  • (Array<(GetShipmentsResponse, Integer, Hash)>) —

    GetShipmentsResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 731

def get_shipments_with_http_info(query_type, marketplace_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_shipments ...' if @api_client.config.debugging
  # verify the required parameter 'query_type' is set
  raise ArgumentError, "Missing the required parameter 'query_type' when calling FbaInboundApi.get_shipments" if @api_client.config.client_side_validation && query_type.nil?
  # verify enum value
  raise ArgumentError, "invalid value for 'query_type', must be one of SHIPMENT, DATE_RANGE, NEXT_TOKEN" if @api_client.config.client_side_validation && !%w[SHIPMENT DATE_RANGE NEXT_TOKEN].include?(query_type)
  # verify the required parameter 'marketplace_id' is set
  raise ArgumentError, "Missing the required parameter 'marketplace_id' when calling FbaInboundApi.get_shipments" if @api_client.config.client_side_validation && marketplace_id.nil?
  raise ArgumentError, 'invalid value for "shipment_status_list", must include one of WORKING, READY_TO_SHIP, SHIPPED, RECEIVING, CANCELLED, DELETED, CLOSED, ERROR, IN_TRANSIT, DELIVERED, CHECKED_IN' if @api_client.config.client_side_validation && opts[:shipment_status_list] && !opts[:shipment_status_list].all? { |item| %w[WORKING READY_TO_SHIP SHIPPED RECEIVING CANCELLED DELETED CLOSED ERROR IN_TRANSIT DELIVERED CHECKED_IN].include?(item) }

  # resource path
  local_var_path = '/fba/inbound/v0/shipments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:QueryType] = query_type
  query_params[:MarketplaceId] = marketplace_id
  query_params[:ShipmentStatusList] = @api_client.build_collection_param(opts[:shipment_status_list], :csv) unless opts[:shipment_status_list].nil?
  query_params[:ShipmentIdList] = @api_client.build_collection_param(opts[:shipment_id_list], :csv) unless opts[:shipment_id_list].nil?
  query_params[:LastUpdatedAfter] = opts[:last_updated_after] unless opts[:last_updated_after].nil?
  query_params[:LastUpdatedBefore] = opts[:last_updated_before] unless opts[:last_updated_before].nil?
  query_params[:NextToken] = opts[:next_token] unless opts[:next_token].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetShipmentsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_shipments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_transport_details(shipment_id, opts = {}) ⇒ GetTransportDetailsResponse

Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



784
785
786
787
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 784

def get_transport_details(shipment_id, opts = {})
  data, _status_code, _headers = get_transport_details_with_http_info(shipment_id, opts)
  data
end

#get_transport_details_with_http_info(shipment_id, opts = {}) ⇒ Array<(GetTransportDetailsResponse, Integer, Hash)>

Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetTransportDetailsResponse, Integer, Hash)>) —

    GetTransportDetailsResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 793

def get_transport_details_with_http_info(shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_transport_details ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.get_transport_details" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetTransportDetailsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#get_transport_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_transport_details(body, shipment_id, opts = {}) ⇒ PutTransportDetailsResponse

Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



835
836
837
838
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 835

def put_transport_details(body, shipment_id, opts = {})
  data, _status_code, _headers = put_transport_details_with_http_info(body, shipment_id, opts)
  data
end

#put_transport_details_with_http_info(body, shipment_id, opts = {}) ⇒ Array<(PutTransportDetailsResponse, Integer, Hash)>

Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PutTransportDetailsResponse, Integer, Hash)>) —

    PutTransportDetailsResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 845

def put_transport_details_with_http_info(body, shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.put_transport_details ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaInboundApi.put_transport_details" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.put_transport_details" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'PutTransportDetailsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#put_transport_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#update_inbound_shipment(body, shipment_id, opts = {}) ⇒ InboundShipmentResponse

Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



891
892
893
894
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 891

def update_inbound_shipment(body, shipment_id, opts = {})
  data, _status_code, _headers = update_inbound_shipment_with_http_info(body, shipment_id, opts)
  data
end

#update_inbound_shipment_with_http_info(body, shipment_id, opts = {}) ⇒ Array<(InboundShipmentResponse, Integer, Hash)>

Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • body
  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InboundShipmentResponse, Integer, Hash)>) —

    InboundShipmentResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 901

def update_inbound_shipment_with_http_info(body, shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.update_inbound_shipment ...' if @api_client.config.debugging
  # verify the required parameter 'body' is set
  raise ArgumentError, "Missing the required parameter 'body' when calling FbaInboundApi.update_inbound_shipment" if @api_client.config.client_side_validation && body.nil?
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.update_inbound_shipment" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body)

  return_type = opts[:return_type] || 'InboundShipmentResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#update_inbound_shipment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#void_transport(shipment_id, opts = {}) ⇒ VoidTransportResponse

Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The ‘x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



946
947
948
949
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 946

def void_transport(shipment_id, opts = {})
  data, _status_code, _headers = void_transport_with_http_info(shipment_id, opts)
  data
end

#void_transport_with_http_info(shipment_id, opts = {}) ⇒ Array<(VoidTransportResponse, Integer, Hash)>

Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 30 | The &#x60;x-amzn-RateLimit-Limit&#x60; response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • shipment_id —

    A shipment identifier originally returned by the createInboundShipmentPlan operation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoidTransportResponse, Integer, Hash)>) —

    VoidTransportResponse data, response status code and response headers

Raises:

  • (ArgumentError) 


955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'lib/fulfillment_inbound_api_model/api/fba_inbound_api.rb', line 955

def void_transport_with_http_info(shipment_id, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.void_transport ...' if @api_client.config.debugging
  # verify the required parameter 'shipment_id' is set
  raise ArgumentError, "Missing the required parameter 'shipment_id' when calling FbaInboundApi.void_transport" if @api_client.config.client_side_validation && shipment_id.nil?

  # resource path
  local_var_path = '/fba/inbound/v0/shipments/{shipmentId}/transport/void'.sub('{' + 'shipmentId' + '}', shipment_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'VoidTransportResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: FbaInboundApi#void_transport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end