Class: Peddler::APIs::FulfillmentInbound20240320

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/fulfillment_inbound_2024_03_20.rb

Overview

The Selling Partner API for FBA inbound operations.

The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon’s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.

See Also:

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #typed, #typed?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#cancel_inbound_plan(inbound_plan_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



102
103
104
105
106
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 102

def cancel_inbound_plan(inbound_plan_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/cancellation"
  parser = Peddler::Types::FulfillmentInbound20240320::CancelInboundPlanResponse if typed?
  meter(rate_limit).put(path, parser:)
end

#cancel_self_ship_appointment(inbound_plan_id, shipment_id, body, rate_limit: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • body (Hash) —

    The body of the request to ‘cancelSelfShipAppointment`.

  • rate_limit (Float) (defaults to: nil) —

    Requests per second

Returns:



556
557
558
559
560
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 556

def cancel_self_ship_appointment(inbound_plan_id, shipment_id, body, rate_limit: nil)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentCancellation"
  parser = Peddler::Types::FulfillmentInbound20240320::CancelSelfShipAppointmentResponse if typed?
  meter(rate_limit).put(path, body:, parser:)
end

#confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program ‘CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    The shipment to confirm the delivery window option for.

  • delivery_window_option_id (String) —

    The id of the delivery window option to be confirmed.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



485
486
487
488
489
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 485

def confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryWindowOptions/#{percent_encode(delivery_window_option_id)}/confirmation"
  parser = Peddler::Types::FulfillmentInbound20240320::ConfirmDeliveryWindowOptionsResponse if typed?
  meter(rate_limit).post(path, parser:)
end

#confirm_packing_option(inbound_plan_id, packing_option_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Confirms the packing option for an inbound plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • packing_option_id (String) —

    Identifier of a packing option.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



241
242
243
244
245
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 241

def confirm_packing_option(inbound_plan_id, packing_option_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions/#{percent_encode(packing_option_id)}/confirmation"
  parser = Peddler::Types::FulfillmentInbound20240320::ConfirmPackingOptionResponse if typed?
  meter(rate_limit).post(path, parser:)
end

#confirm_placement_option(inbound_plan_id, placement_option_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • placement_option_id (String) —

    The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



310
311
312
313
314
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 310

def confirm_placement_option(inbound_plan_id, placement_option_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions/#{percent_encode(placement_option_id)}/confirmation"
  parser = Peddler::Types::FulfillmentInbound20240320::ConfirmPlacementOptionResponse if typed?
  meter(rate_limit).post(path, parser:)
end

#confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Confirm a shipment content update preview and accept the changes in transportation cost.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • content_update_preview_id (String) —

    Identifier of a content update preview.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



415
416
417
418
419
420
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 415

def confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id,
  rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews/#{percent_encode(content_update_preview_id)}/confirmation"
  parser = Peddler::Types::FulfillmentInbound20240320::ConfirmShipmentContentUpdatePreviewResponse if typed?
  meter(rate_limit).post(path, parser:)
end

#confirm_transportation_options(inbound_plan_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • body (Hash) —

    The body of the request to ‘confirmTransportationOptions`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



699
700
701
702
703
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 699

def confirm_transportation_options(inbound_plan_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions/confirmation"
  parser = Peddler::Types::FulfillmentInbound20240320::ConfirmTransportationOptionsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#create_inbound_plan(body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon’s fufillment network.

Parameters:

  • body (Hash) —

    The body of the request to ‘createInboundPlan`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



56
57
58
59
60
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 56

def create_inbound_plan(body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans"
  parser = Peddler::Types::FulfillmentInbound20240320::CreateInboundPlanResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#create_marketplace_item_labels(body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

For a given marketplace - creates labels for a list of MSKUs.

Parameters:

  • body (Hash) —

    The body of the request to ‘createMarketplaceItemLabels`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



759
760
761
762
763
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 759

def create_marketplace_item_labels(body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/items/labels"
  parser = Peddler::Types::FulfillmentInbound20240320::CreateMarketplaceItemLabelsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#generate_delivery_window_options(inbound_plan_id, shipment_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Generates available delivery window options for a given shipment.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    The shipment to generate delivery window options for.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



466
467
468
469
470
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 466

def generate_delivery_window_options(inbound_plan_id, shipment_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryWindowOptions"
  parser = Peddler::Types::FulfillmentInbound20240320::GenerateDeliveryWindowOptionsResponse if typed?
  meter(rate_limit).post(path, parser:)
end

#generate_packing_options(inbound_plan_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Generates available packing options for the inbound plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



228
229
230
231
232
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 228

def generate_packing_options(inbound_plan_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions"
  parser = Peddler::Types::FulfillmentInbound20240320::GeneratePackingOptionsResponse if typed?
  meter(rate_limit).post(path, parser:)
end

#generate_placement_options(inbound_plan_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Generates placement options for the inbound plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • body (Hash) —

    The body of the request to ‘generatePlacementOptions`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



296
297
298
299
300
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 296

def generate_placement_options(inbound_plan_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions"
  parser = Peddler::Types::FulfillmentInbound20240320::GeneratePlacementOptionsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body, rate_limit: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • body (Hash) —

    The body of the request to ‘generateSelfShipAppointmentSlots`.

  • rate_limit (Float) (defaults to: nil) —

    Requests per second

Returns:



596
597
598
599
600
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 596

def generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body, rate_limit: nil)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots"
  parser = Peddler::Types::FulfillmentInbound20240320::GenerateSelfShipAppointmentSlotsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • body (Hash) —

    The body of the request to ‘generateShipmentContentUpdatePreviews`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



385
386
387
388
389
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 385

def generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews"
  parser = Peddler::Types::FulfillmentInbound20240320::GenerateShipmentContentUpdatePreviewsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#generate_transportation_options(inbound_plan_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Generates available transportation options for a given placement option.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • body (Hash) —

    The body of the request to ‘generateTransportationOptions`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



685
686
687
688
689
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 685

def generate_transportation_options(inbound_plan_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions"
  parser = Peddler::Types::FulfillmentInbound20240320::GenerateTransportationOptionsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#get_delivery_challan_document(inbound_plan_id, shipment_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provide delivery challan document for PCP transportation in IN marketplace.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



429
430
431
432
433
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 429

def get_delivery_challan_document(inbound_plan_id, shipment_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryChallanDocument"
  parser = Peddler::Types::FulfillmentInbound20240320::GetDeliveryChallanDocumentResponse if typed?
  meter(rate_limit).get(path, parser:)
end

#get_inbound_operation_status(operation_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Gets the status of the processing of an asynchronous API call.

Parameters:

  • operation_id (String) —

    Identifier of an asynchronous operation.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



813
814
815
816
817
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 813

def get_inbound_operation_status(operation_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/operations/#{percent_encode(operation_id)}"
  parser = Peddler::Types::FulfillmentInbound20240320::InboundOperationStatus if typed?
  meter(rate_limit).get(path, parser:)
end

#get_inbound_plan(inbound_plan_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Fetches the top level information about an inbound plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



68
69
70
71
72
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 68

def get_inbound_plan(inbound_plan_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}"
  parser = Peddler::Types::FulfillmentInbound20240320::InboundPlan if typed?
  meter(rate_limit).get(path, parser:)
end

#get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • page_size (Integer) (defaults to: 10) —

    The number of self ship appointment slots to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: nil) —

    Requests per second

Returns:



576
577
578
579
580
581
582
583
584
585
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 576

def get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil,
  rate_limit: nil)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::GetSelfShipAppointmentSlotsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#get_shipment(inbound_plan_id, shipment_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides the full details for a specific shipment within an inbound plan. The ‘transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



324
325
326
327
328
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 324

def get_shipment(inbound_plan_id, shipment_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}"
  parser = Peddler::Types::FulfillmentInbound20240320::Shipment if typed?
  meter(rate_limit).get(path, parser:)
end

#get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • content_update_preview_id (String) —

    Identifier of a content update preview.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



401
402
403
404
405
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 401

def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews/#{percent_encode(content_update_preview_id)}"
  parser = Peddler::Types::FulfillmentInbound20240320::ContentUpdatePreview if typed?
  meter(rate_limit).get(path, parser:)
end

#list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the ‘generateDeliveryWindowOptions` operation before becoming available.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    The shipment to get delivery window options for.

  • page_size (Integer) (defaults to: 10) —

    The number of delivery window options to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



448
449
450
451
452
453
454
455
456
457
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 448

def list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil,
  rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryWindowOptions"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListDeliveryWindowOptionsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a paginated list of box packages in an inbound plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • page_size (Integer) (defaults to: 10) —

    The number of boxes to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



84
85
86
87
88
89
90
91
92
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 84

def list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/boxes"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListInboundPlanBoxesResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a paginated list of item packages in an inbound plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • page_size (Integer) (defaults to: 10) —

    The number of items to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



118
119
120
121
122
123
124
125
126
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 118

def list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/items"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListInboundPlanItemsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • page_size (Integer) (defaults to: 10) —

    The number of pallets to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



258
259
260
261
262
263
264
265
266
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 258

def list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/pallets"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListInboundPlanPalletsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_by: nil, sort_order: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a list of inbound plans with minimal information.

Parameters:

  • page_size (Integer) (defaults to: 10) —

    The number of inbound plans to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • status (String) (defaults to: nil) —

    The status of an inbound plan.

  • sort_by (String) (defaults to: nil) —

    Sort by field.

  • sort_order (String) (defaults to: nil) —

    The sort order.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 35

def list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_by: nil, sort_order: nil,
  rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
    "status" => status,
    "sortBy" => sort_by,
    "sortOrder" => sort_order,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListInboundPlansResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_item_compliance_details(mskus, marketplace_id, rate_limit: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

List the inbound compliance details for MSKUs in a given marketplace.

Note: MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](developer-docs.amazon.com/sp-api/docs/url-encoding).

The following characters must be double percent encoded:

  • ‘%`

  • ‘+`

  • ‘,`

Examples: An MSKU value of ‘test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.

Parameters:

  • mskus (Array<String>) —

    A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.

  • marketplace_id (String) —

    The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](developer-docs.amazon.com/sp-api/docs/marketplace-ids).

  • rate_limit (Float) (defaults to: nil) —

    Requests per second

Returns:



725
726
727
728
729
730
731
732
733
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 725

def list_item_compliance_details(mskus, marketplace_id, rate_limit: nil)
  path = "/inbound/fba/2024-03-20/items/compliance"
  params = {
    "mskus" => stringify_array(mskus),
    "marketplaceId" => marketplace_id,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListItemComplianceDetailsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieves a page of boxes from a given packing group. These boxes were previously provided through the ‘setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • packing_group_id (String) —

    Identifier of a packing group.

  • page_size (Integer) (defaults to: 10) —

    The number of packing group boxes to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 153

def list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil,
  rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingGroups/#{percent_encode(packing_group_id)}/boxes"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListPackingGroupBoxesResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • packing_group_id (String) —

    Identifier of a packing group.

  • page_size (Integer) (defaults to: 10) —

    The number of packing group items to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 176

def list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil,
  rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingGroups/#{percent_encode(packing_group_id)}/items"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListPackingGroupItemsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • page_size (Integer) (defaults to: 10) —

    The number of packing options to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



212
213
214
215
216
217
218
219
220
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 212

def list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListPackingOptionsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • page_size (Integer) (defaults to: 10) —

    The number of placement options to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



279
280
281
282
283
284
285
286
287
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 279

def list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListPlacementOptionsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_prep_details(marketplace_id, mskus, rate_limit: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Get preparation details for a list of MSKUs in a specified marketplace.

Note: MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](developer-docs.amazon.com/sp-api/docs/url-encoding).

The following characters must be double percent encoded:

  • ‘%`

  • ‘+`

  • ‘,`

Examples: An MSKU value of ‘test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.

Parameters:

  • marketplace_id (String) —

    The marketplace ID. For a list of possible values, refer to [Marketplace IDs](developer-docs.amazon.com/sp-api/docs/marketplace-ids).

  • mskus (Array<String>) —

    A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.

  • rate_limit (Float) (defaults to: nil) —

    Requests per second

Returns:



785
786
787
788
789
790
791
792
793
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 785

def list_prep_details(marketplace_id, mskus, rate_limit: nil)
  path = "/inbound/fba/2024-03-20/items/prepDetails"
  params = {
    "marketplaceId" => marketplace_id,
    "mskus" => stringify_array(mskus),
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListPrepDetailsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a paginated list of box packages in a shipment.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • page_size (Integer) (defaults to: 10) —

    The number of boxes to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



341
342
343
344
345
346
347
348
349
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 341

def list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/boxes"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListShipmentBoxesResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • page_size (Integer) (defaults to: 10) —

    The number of content update previews to return.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 364

def list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil,
  rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListShipmentContentUpdatePreviewsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a paginated list of item packages in a shipment.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • page_size (Integer) (defaults to: 10) —

    The number of items to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



502
503
504
505
506
507
508
509
510
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 502

def list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/items"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListShipmentItemsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • page_size (Integer) (defaults to: 10) —

    The number of pallets to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



537
538
539
540
541
542
543
544
545
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 537

def list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/pallets"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListShipmentPalletsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_transportation_options(inbound_plan_id, page_size: 10, pagination_token: nil, placement_option_id: nil, shipment_id: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieves all transportation options for a shipment. Transportation options must first be generated by the ‘generateTransportationOptions` operation before becoming available.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • page_size (Integer) (defaults to: 10) —

    The number of transportation options to return in the response matching the given query.

  • pagination_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the ‘pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

  • placement_option_id (String) (defaults to: nil) —

    The placement option to get transportation options for. Either ‘placementOptionId` or `shipmentId` must be specified.

  • shipment_id (String) (defaults to: nil) —

    The shipment to get transportation options for. Either ‘placementOptionId` or `shipmentId` must be specified.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 665

def list_transportation_options(inbound_plan_id, page_size: 10, pagination_token: nil, placement_option_id: nil,
  shipment_id: nil, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions"
  params = {
    "pageSize" => page_size,
    "paginationToken" => pagination_token,
    "placementOptionId" => placement_option_id,
    "shipmentId" => shipment_id,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::ListTransportationOptionsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body, rate_limit: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • slot_id (String) —

    An identifier to a self-ship appointment slot.

  • body (Hash) —

    The body of the request to ‘scheduleSelfShipAppointment`.

  • rate_limit (Float) (defaults to: nil) —

    Requests per second

Returns:



612
613
614
615
616
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 612

def schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body, rate_limit: nil)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots/#{percent_encode(slot_id)}/schedule"
  parser = Peddler::Types::FulfillmentInbound20240320::ScheduleSelfShipAppointmentResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#set_packing_information(inbound_plan_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • body (Hash) —

    The body of the request to ‘setPackingInformation`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



195
196
197
198
199
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 195

def set_packing_information(inbound_plan_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingInformation"
  parser = Peddler::Types::FulfillmentInbound20240320::SetPackingInformationResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#set_prep_details(body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Set the preparation details for a list of MSKUs in a specified marketplace.

Parameters:

  • body (Hash) —

    The body of the request to ‘setPrepDetails`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



801
802
803
804
805
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 801

def set_prep_details(body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/items/prepDetails"
  parser = Peddler::Types::FulfillmentInbound20240320::SetPrepDetailsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#update_inbound_plan_name(inbound_plan_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Updates the name of an existing inbound plan.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • body (Hash) —

    The body of the request to ‘updateInboundPlanName`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



135
136
137
138
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 135

def update_inbound_plan_name(inbound_plan_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/name"
  meter(rate_limit).put(path, body:)
end

#update_item_compliance_details(marketplace_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.

Parameters:

  • marketplace_id (String) —

    The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](developer-docs.amazon.com/sp-api/docs/marketplace-ids).

  • body (Hash) —

    The body of the request to ‘updateItemComplianceDetails`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



744
745
746
747
748
749
750
751
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 744

def update_item_compliance_details(marketplace_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/items/compliance"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = Peddler::Types::FulfillmentInbound20240320::UpdateItemComplianceDetailsResponse if typed?
  meter(rate_limit).put(path, body:, params:, parser:)
end

#update_shipment_name(inbound_plan_id, shipment_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Updates the name of an existing shipment.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • body (Hash) —

    The body of the request to ‘updateShipmentName`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



520
521
522
523
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 520

def update_shipment_name(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/name"
  meter(rate_limit).put(path, body:)
end

#update_shipment_source_address(inbound_plan_id, shipment_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • body (Hash) —

    The body of the request to ‘updateShipmentSourceAddress`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



629
630
631
632
633
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 629

def update_shipment_source_address(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/sourceAddress"
  parser = Peddler::Types::FulfillmentInbound20240320::UpdateShipmentSourceAddressResponse if typed?
  meter(rate_limit).put(path, body:, parser:)
end

#update_shipment_tracking_details(inbound_plan_id, shipment_id, body, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Updates a shipment’s tracking details.

Parameters:

  • inbound_plan_id (String) —

    Identifier of an inbound plan.

  • shipment_id (String) —

    Identifier of a shipment. A shipment contains the boxes and units being inbounded.

  • body (Hash) —

    The body of the request to ‘updateShipmentTrackingDetails`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



643
644
645
646
647
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 643

def update_shipment_tracking_details(inbound_plan_id, shipment_id, body, rate_limit: 2.0)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/trackingDetails"
  parser = Peddler::Types::FulfillmentInbound20240320::UpdateShipmentTrackingDetailsResponse if typed?
  meter(rate_limit).put(path, body:, parser:)
end