Class: MWS::FulfillmentInboundShipment::Client

Inherits:
Peddler::Client show all
Defined in:
lib/mws/fulfillment_inbound_shipment/client.rb

Overview

With the Fulfillment Inbound Shipment API, you can create and update inbound shipments of inventory in the Amazon Fulfillment Network. You can also request lists of inbound shipments or inbound shipment items based on criteria that you specify.

Instance Attribute Summary

Attributes inherited from Peddler::Client

#auth_token, #body, #merchant_id, #path, #primary_marketplace_id, #version

Instance Method Summary collapse

Methods inherited from Peddler::Client

#aws_endpoint, #defaults, #error_handler, #headers, #initialize, #marketplace, #marketplace_id, #marketplace_id=, on_error, #on_error, #operation, path, #run, version

Constructor Details

This class inherits a constructor from Peddler::Client

Instance Method Details

#confirm_preorder(shipment_id, need_by_date) ⇒ Peddler::XMLParser

Confirms a shipment for pre-order

Parameters:

  • shipment_id (String)
  • need_by_date (#iso8601)

Returns:

See Also:



126
127
128
129
130
131
132
133
134
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 126

def confirm_preorder(shipment_id, need_by_date)
  operation('ConfirmPreorder')
    .add(
      'ShipmentId' => shipment_id,
      'NeedByDate' => need_by_date
    )

  run
end

#confirm_transport_request(shipment_id) ⇒ Peddler::XMLParser

Confirms that you accept the Amazon-partnered shipping estimate and you request that the Amazon-partnered carrier ship your inbound shipment

Parameters:

  • shipment_id (String)

Returns:

See Also:



218
219
220
221
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 218

def confirm_transport_request(shipment_id)
  operation('ConfirmTransportRequest').add('ShipmentId' => shipment_id)
  run
end

#create_inbound_shipment(shipment_id, inbound_shipment_header, opts = {}) ⇒ Peddler::XMLParser

Creates an inbound shipment

Parameters:

  • shipment_id (String)
  • inbound_shipment_header (Struct, Hash)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :inbound_shipment_items (Array<Struct, Hash>)

Returns:

See Also:



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 76

def create_inbound_shipment(shipment_id, inbound_shipment_header, opts = {})
  build_inbound_shipment_operation(
    'CreateInboundShipment',
    shipment_id,
    inbound_shipment_header,
    opts
  )

  run
end

#create_inbound_shipment_plan(ship_from_address, inbound_shipment_plan_request_items, opts = {}) ⇒ Peddler::XMLParser

Returns the information required to create an inbound shipment

Parameters:

  • ship_from_address (Struct, Hash)
  • inbound_shipment_plan_request_items (Array<Struct, Hash>)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :label_prep_preference (String)

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 55

def create_inbound_shipment_plan(ship_from_address, inbound_shipment_plan_request_items, opts = {})
  operation('CreateInboundShipmentPlan')
    .add(
      opts.update(
        'ShipFromAddress' => ship_from_address,
        'InboundShipmentPlanRequestItems' => inbound_shipment_plan_request_items
      )
    )
    .structure!('InboundShipmentPlanRequestItems', 'member')

  run
end

#estimate_transport_request(shipment_id) ⇒ Peddler::XMLParser

Requests an estimate of the shipping cost for an inbound shipment

Parameters:

  • shipment_id (String)

Returns:

See Also:



197
198
199
200
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 197

def estimate_transport_request(shipment_id)
  operation('EstimateTransportRequest').add('ShipmentId' => shipment_id)
  run
end

#get_bill_of_lading(shipment_id) ⇒ Peddler::XMLParser

Returns PDF document data for printing a bill of lading for an inbound shipment

Parameters:

  • shipment_id (String)

Returns:

See Also:



296
297
298
299
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 296

def get_bill_of_lading(shipment_id)
  operation('GetBillOfLading').add('ShipmentId' => shipment_id)
  run
end

#get_inbound_guidance_for_asin(marketplace_id, *asins) ⇒ Peddler::XMLParser

Returns inbound guidance for a list of items by ASIN

Parameters:

  • marketplace_id (String)
  • one (String) —

    or more asins

Returns:

See Also:



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 36

def get_inbound_guidance_for_asin(marketplace_id, *asins)
  operation('GetInboundGuidanceForASIN')
    .add(
      'MarketplaceId' => marketplace_id,
      'ASINList' => asins
    )
    .structure!('ASINList', 'Id')

  run
end

#get_inbound_guidance_for_sku(marketplace_id, *seller_skus) ⇒ Peddler::XMLParser

Returns inbound guidance for a list of items by Seller SKU

Parameters:

  • marketplace_id (String)
  • one (String) —

    or more seller_skus

Returns:

See Also:



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 19

def get_inbound_guidance_for_sku(marketplace_id, *seller_skus)
  operation('GetInboundGuidanceForSKU')
    .add(
      'MarketplaceId' => marketplace_id,
      'SellerSKUList' => seller_skus
    )
    .structure!('SellerSKUList', 'Id')

  run
end

#get_package_labels(shipment_id, page_type, opts = {}) ⇒ Peddler::XMLParser

Returns PDF document data for printing package labels for an inbound shipment

Parameters:

  • shipment_id (String)
  • page_type (String)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :number_of_packages (Integer)

Returns:

See Also:



243
244
245
246
247
248
249
250
251
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 243

def get_package_labels(shipment_id, page_type, opts = {})
  operation('GetPackageLabels')
    .add(opts.update(
           'ShipmentId' => shipment_id,
           'PageType' => page_type
    ))

  run
end

#get_pallet_labels(shipment_id, page_type, number_of_pallets) ⇒ Peddler::XMLParser

Returns pallet labels

Parameters:

  • shipment_id (String)
  • page_type (String)
  • number_of_pallets (Integer)

Returns:

See Also:



279
280
281
282
283
284
285
286
287
288
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 279

def get_pallet_labels(shipment_id, page_type, number_of_pallets)
  operation('GetPalletLabels')
    .add(
      'ShipmentId' => shipment_id,
      'PageType' => page_type,
      'NumberOfPallets' => number_of_pallets
    )

  run
end

#get_preorder_info(shipment_id) ⇒ Peddler::XMLParser

Returns pre-order information, including dates

Parameters:

  • shipment_id (String)

Returns:

See Also:



111
112
113
114
115
116
117
118
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 111

def get_preorder_info(shipment_id)
  operation('GetPreorderInfo')
    .add(
      'ShipmentId' => shipment_id
    )

  run
end

#get_prep_instructions_for_asin(ship_to_country_code, *asins) ⇒ Peddler::XMLParser

Returns item preparation instructions to help with item sourcing decisions

Parameters:

  • ship_to_country_code (String)
  • one (String) —

    or more asins

Returns:

See Also:



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 159

def get_prep_instructions_for_asin(ship_to_country_code, *asins)
  operation('GetPrepInstructionsForASIN')
    .add(
      'ASINList' => asins,
      'ShipToCountryCode' => ship_to_country_code
    )
    .structure!('ASINList', 'Id')

  run
end

#get_prep_instructions_for_sku(ship_to_country_code, *seller_skus) ⇒ Peddler::XMLParser

Returns labeling requirements and item preparation instructions to help you prepare items for an inbound shipment

Parameters:

  • ship_to_country_code (String)
  • one (String) —

    or more seller_skus

Returns:

See Also:



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 142

def get_prep_instructions_for_sku(ship_to_country_code, *seller_skus)
  operation('GetPrepInstructionsForSKU')
    .add(
      'SellerSKUList' => seller_skus,
      'ShipToCountryCode' => ship_to_country_code
    )
    .structure!('SellerSKUList', 'Id')

  run
end

#get_service_status ⇒ Peddler::XMLParser

Gets the operational status of the API

Returns:

See Also:



361
362
363
364
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 361

def get_service_status
  operation('GetServiceStatus')
  run
end

#get_transport_content(shipment_id) ⇒ Peddler::XMLParser

Returns current transportation information about an inbound shipment

Parameters:

  • shipment_id (String)

Returns:

See Also:



207
208
209
210
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 207

def get_transport_content(shipment_id)
  operation('GetTransportContent').add('ShipmentId' => shipment_id)
  run
end

#get_unique_package_labels(shipment_id, page_type, package_labels_to_print) ⇒ Peddler::XMLParser

Returns unique package labels for faster and more accurate shipment processing at the Amazon fulfillment centre

Parameters:

  • shipment_id (String)
  • page_type (String)
  • package_labels_to_print (Array<String>)

Returns:

See Also:



260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 260

def get_unique_package_labels(shipment_id, page_type, package_labels_to_print)
  operation('GetUniquePackageLabels')
    .add(
      'ShipmentId' => shipment_id,
      'PageType' => page_type,
      'PackageLabelsToPrint' => package_labels_to_print
    )
    .structure!('PackageLabelsToPrint', 'member')

  run
end

#list_inbound_shipment_items(opts = {}) ⇒ Peddler::XMLParser

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame

Parameters:

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

Options Hash (opts):

  • :shipment_id (String)
  • :last_updated_after (String, #iso8601)
  • :last_updated_before (String, #iso8601)

Returns:

See Also:



340
341
342
343
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 340

def list_inbound_shipment_items(opts = {})
  operation('ListInboundShipmentItems').add(opts)
  run
end

#list_inbound_shipment_items_by_next_token(next_token) ⇒ Peddler::XMLParser

Returns the next page of inbound shipment items

Parameters:

  • next_token (String)

Returns:

See Also:



350
351
352
353
354
355
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 350

def list_inbound_shipment_items_by_next_token(next_token)
  operation('ListInboundShipmentItemsByNextToken')
    .add('NextToken' => next_token)

  run
end

#list_inbound_shipments(opts = {}) ⇒ Peddler::XMLParser

Returns a list of inbound shipments based on criteria that you specify

Parameters:

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

Options Hash (opts):

  • :shipment_status_list (Array<String>)
  • :shipment_id_list (Array<String>)
  • :last_updated_after (String, #iso8601)
  • :last_updated_before (String, #iso8601)

Returns:

See Also:



310
311
312
313
314
315
316
317
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 310

def list_inbound_shipments(opts = {})
  operation('ListInboundShipments')
    .add(opts)
    .structure!('ShipmentStatusList', 'member')
    .structure!('ShipmentIdList', 'member')

  run
end

#list_inbound_shipments_by_next_token(next_token) ⇒ Peddler::XMLParser

Returns the next page of inbound shipments

Parameters:

  • next_token (String)

Returns:

See Also:



324
325
326
327
328
329
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 324

def list_inbound_shipments_by_next_token(next_token)
  operation('ListInboundShipmentsByNextToken')
    .add('NextToken' => next_token)

  run
end

#put_transport_content(shipment_id, is_partnered, shipment_type, transport_details) ⇒ Peddler::XMLParser

Sends transportation information to Amazon about an inbound shipment

Parameters:

  • shipment_id (String)
  • is_partnered (Boolean)
  • shipment_type (String)
  • transport_details (Struct, Hash)

Returns:

See Also:



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 178

def put_transport_content(shipment_id, is_partnered, shipment_type, transport_details)
  operation('PutTransportContent')
    .add(
      'ShipmentId' => shipment_id,
      'IsPartnered' => is_partnered,
      'ShipmentType' => shipment_type,
      'TransportDetails' => transport_details
    )
    .structure!('PackageList', 'member')
    .structure!('PalletList', 'member')

  run
end

#update_inbound_shipment(shipment_id, inbound_shipment_header, opts = {}) ⇒ Peddler::XMLParser

Updates an existing inbound shipment

Parameters:

  • shipment_id (String)
  • inbound_shipment_header (Struct, Hash)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :inbound_shipment_items (Array<Struct, Hash>)

Returns:

See Also:



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 95

def update_inbound_shipment(shipment_id, inbound_shipment_header, opts = {})
  build_inbound_shipment_operation(
    'UpdateInboundShipment',
    shipment_id,
    inbound_shipment_header,
    opts
  )

  run
end

#void_transport_request(shipment_id) ⇒ Peddler::XMLParser

Voids a previously-confirmed request to ship your inbound shipment using an Amazon-partnered carrier

Parameters:

  • shipment_id (String)

Returns:

See Also:



229
230
231
232
 
# File 'lib/mws/fulfillment_inbound_shipment/client.rb', line 229

def void_transport_request(shipment_id)
  operation('VoidTransportRequest').add('ShipmentId' => shipment_id)
  run
end