Class: Peddler::APIs::FulfillmentInbound20240320

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/fulfillment_inbound_2024_03_20.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/box.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/item.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/dates.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/error.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/quote.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/pallet.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/region.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/weight.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/window.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/address.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/carrier.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/shipment.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/tax_rate.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/box_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/incentive.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/dimensions.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/error_list.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/item_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/pagination.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/tax_details.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/inbound_plan.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/pallet_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/weight_range.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/window_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/address_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/msku_quantity.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/packing_option.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/shipment_source.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/appointment_slot.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/box_requirements.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/box_update_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/msku_prep_detail.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/placement_option.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/prep_instruction.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/shipment_summary.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/tracking_details.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/compliance_detail.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/document_download.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/operation_problem.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/requested_updates.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/spd_tracking_item.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/carrier_appointment.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/contact_information.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/freight_information.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/ltl_tracking_detail.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/spd_tracking_detail.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/inbound_plan_summary.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/shipment_destination.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/appointment_slot_time.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/packing_configuration.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/shipping_requirements.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/transportation_option.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/content_update_preview.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/custom_placement_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/delivery_window_option.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/msku_prep_detail_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/package_grouping_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/packing_option_summary.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/shipping_configuration.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/tracking_details_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/spd_tracking_item_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/inbound_operation_status.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/placement_option_summary.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/selected_delivery_window.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/set_prep_details_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/transportation_selection.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/ltl_tracking_detail_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/set_prep_details_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/spd_tracking_detail_input.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_prep_details_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/create_inbound_plan_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_inbound_plans_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/cancel_inbound_plan_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/create_inbound_plan_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_shipment_boxes_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_shipment_items_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_shipment_name_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_packing_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/self_ship_appointment_details.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_shipment_pallets_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/confirm_packing_option_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_placement_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/set_packing_information_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_inbound_plan_boxes_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_inbound_plan_items_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/set_packing_information_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_inbound_plan_name_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/confirm_placement_option_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_packing_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_packing_group_boxes_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_packing_group_items_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_placement_options_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_inbound_plan_pallets_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_placement_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/cancel_self_ship_appointment_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_transportation_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/cancel_self_ship_appointment_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_delivery_window_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_item_compliance_details_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/shipment_transportation_configuration.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/confirm_transportation_options_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/create_marketplace_item_labels_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/get_delivery_challan_document_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/schedule_self_ship_appointment_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_item_compliance_details_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_shipment_source_address_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/confirm_transportation_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/create_marketplace_item_labels_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_transportation_options_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/schedule_self_ship_appointment_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_item_compliance_details_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_shipment_source_address_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/confirm_delivery_window_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_transportation_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/get_self_ship_appointment_slots_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/self_ship_appointment_slots_availability.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_shipment_tracking_details_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_delivery_window_options_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/update_shipment_tracking_details_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_self_ship_appointment_slots_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_self_ship_appointment_slots_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/list_shipment_content_update_previews_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/confirm_shipment_content_update_preview_response.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_shipment_content_update_previews_request.rb,
lib/peddler/apis/fulfillment_inbound_2024_03_20/generate_shipment_content_update_previews_response.rb,
sig/peddler/apis/fulfillment_inbound_2024_03_20.rbs

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:

Defined Under Namespace

Classes: Address, AddressInput, AppointmentSlot, AppointmentSlotTime, Box, BoxInput, BoxRequirements, BoxUpdateInput, CancelInboundPlanResponse, CancelSelfShipAppointmentRequest, CancelSelfShipAppointmentResponse, Carrier, CarrierAppointment, ComplianceDetail, ConfirmDeliveryWindowOptionsResponse, ConfirmPackingOptionResponse, ConfirmPlacementOptionResponse, ConfirmShipmentContentUpdatePreviewResponse, ConfirmTransportationOptionsRequest, ConfirmTransportationOptionsResponse, ContactInformation, ContentUpdatePreview, CreateInboundPlanRequest, CreateInboundPlanResponse, CreateMarketplaceItemLabelsRequest, CreateMarketplaceItemLabelsResponse, CustomPlacementInput, Dates, DeliveryWindowOption, Dimensions, DocumentDownload, Error, ErrorList, FreightInformation, GenerateDeliveryWindowOptionsResponse, GeneratePackingOptionsResponse, GeneratePlacementOptionsRequest, GeneratePlacementOptionsResponse, GenerateSelfShipAppointmentSlotsRequest, GenerateSelfShipAppointmentSlotsResponse, GenerateShipmentContentUpdatePreviewsRequest, GenerateShipmentContentUpdatePreviewsResponse, GenerateTransportationOptionsRequest, GenerateTransportationOptionsResponse, GetDeliveryChallanDocumentResponse, GetSelfShipAppointmentSlotsResponse, InboundOperationStatus, InboundPlan, InboundPlanSummary, Incentive, Item, ItemInput, ListDeliveryWindowOptionsResponse, ListInboundPlanBoxesResponse, ListInboundPlanItemsResponse, ListInboundPlanPalletsResponse, ListInboundPlansResponse, ListItemComplianceDetailsResponse, ListPackingGroupBoxesResponse, ListPackingGroupItemsResponse, ListPackingOptionsResponse, ListPlacementOptionsResponse, ListPrepDetailsResponse, ListShipmentBoxesResponse, ListShipmentContentUpdatePreviewsResponse, ListShipmentItemsResponse, ListShipmentPalletsResponse, ListTransportationOptionsResponse, LtlTrackingDetail, LtlTrackingDetailInput, MskuPrepDetail, MskuPrepDetailInput, MskuQuantity, OperationProblem, PackageGroupingInput, PackingConfiguration, PackingOption, PackingOptionSummary, Pagination, Pallet, PalletInput, PlacementOption, PlacementOptionSummary, PrepInstruction, Quote, Region, RequestedUpdates, ScheduleSelfShipAppointmentRequest, ScheduleSelfShipAppointmentResponse, SelectedDeliveryWindow, SelfShipAppointmentDetails, SelfShipAppointmentSlotsAvailability, SetPackingInformationRequest, SetPackingInformationResponse, SetPrepDetailsRequest, SetPrepDetailsResponse, Shipment, ShipmentDestination, ShipmentSource, ShipmentSummary, ShipmentTransportationConfiguration, ShippingConfiguration, ShippingRequirements, SpdTrackingDetail, SpdTrackingDetailInput, SpdTrackingItem, SpdTrackingItemInput, TaxDetails, TaxRate, TrackingDetails, TrackingDetailsInput, TransportationOption, TransportationSelection, UpdateInboundPlanNameRequest, UpdateItemComplianceDetailsRequest, UpdateItemComplianceDetailsResponse, UpdateShipmentNameRequest, UpdateShipmentSourceAddressRequest, UpdateShipmentSourceAddressResponse, UpdateShipmentTrackingDetailsRequest, UpdateShipmentTrackingDetailsResponse, Weight, WeightRange, Window, WindowInput

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#cancel_inbound_plan(inbound_plan_id) ⇒ 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.

  • (String)

Returns:



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

def cancel_inbound_plan(inbound_plan_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/cancellation"
  parser = -> { CancelInboundPlanResponse }
  put(path, parser:)
end

#cancel_self_ship_appointment(inbound_plan_id, shipment_id, body) ⇒ 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: 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.

  • (String)
  • (String)
  • (Hash[untyped, untyped])

Returns:



511
512
513
514
515
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 511

def cancel_self_ship_appointment(inbound_plan_id, shipment_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentCancellation"
  parser = -> { CancelSelfShipAppointmentResponse }
  put(path, body:, parser:)
end

#confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id) ⇒ 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.

  • (String)
  • (String)
  • (String)

Returns:



444
445
446
447
448
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 444

def confirm_delivery_window_options(inbound_plan_id, shipment_id, delivery_window_option_id)
  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 = -> { ConfirmDeliveryWindowOptionsResponse }
  post(path, parser:)
end

#confirm_packing_option(inbound_plan_id, packing_option_id) ⇒ 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.

  • (String)
  • (String)

Returns:



217
218
219
220
221
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 217

def confirm_packing_option(inbound_plan_id, packing_option_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions/#{percent_encode(packing_option_id)}/confirmation"
  parser = -> { ConfirmPackingOptionResponse }
  post(path, parser:)
end

#confirm_placement_option(inbound_plan_id, placement_option_id) ⇒ 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.

  • (String)
  • (String)

Returns:



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

def confirm_placement_option(inbound_plan_id, placement_option_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions/#{percent_encode(placement_option_id)}/confirmation"
  parser = -> { ConfirmPlacementOptionResponse }
  post(path, parser:)
end

#confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id) ⇒ 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.

  • (String)
  • (String)
  • (String)

Returns:



380
381
382
383
384
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 380

def confirm_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id)
  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 = -> { ConfirmShipmentContentUpdatePreviewResponse }
  post(path, parser:)
end

#confirm_transportation_options(inbound_plan_id, body) ⇒ 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.

  • (String)
  • (Hash[untyped, untyped])

Returns:



645
646
647
648
649
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 645

def confirm_transportation_options(inbound_plan_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions/confirmation"
  parser = -> { ConfirmTransportationOptionsResponse }
  post(path, body:, parser:)
end

#create_inbound_plan(body) ⇒ 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.

  • (Hash[untyped, untyped])

Returns:



45
46
47
48
49
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 45

def create_inbound_plan(body)
  path = "/inbound/fba/2024-03-20/inboundPlans"
  parser = -> { CreateInboundPlanResponse }
  post(path, body:, parser:)
end

#create_marketplace_item_labels(body) ⇒ 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.

  • (Hash[untyped, untyped])

Returns:



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

def create_marketplace_item_labels(body)
  path = "/inbound/fba/2024-03-20/items/labels"
  parser = -> { CreateMarketplaceItemLabelsResponse }
  post(path, body:, parser:)
end

#generate_delivery_window_options(inbound_plan_id, shipment_id) ⇒ 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.

  • (String)
  • (String)

Returns:



426
427
428
429
430
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 426

def generate_delivery_window_options(inbound_plan_id, shipment_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryWindowOptions"
  parser = -> { GenerateDeliveryWindowOptionsResponse }
  post(path, parser:)
end

#generate_packing_options(inbound_plan_id) ⇒ 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.

  • (String)

Returns:



205
206
207
208
209
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 205

def generate_packing_options(inbound_plan_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingOptions"
  parser = -> { GeneratePackingOptionsResponse }
  post(path, parser:)
end

#generate_placement_options(inbound_plan_id, body) ⇒ 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.

  • (String)
  • (Hash[untyped, untyped])

Returns:



269
270
271
272
273
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 269

def generate_placement_options(inbound_plan_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/placementOptions"
  parser = -> { GeneratePlacementOptionsResponse }
  post(path, body:, parser:)
end

#generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body) ⇒ 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: 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.

  • (String)
  • (String)
  • (Hash[untyped, untyped])

Returns:



548
549
550
551
552
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 548

def generate_self_ship_appointment_slots(inbound_plan_id, shipment_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots"
  parser = -> { GenerateSelfShipAppointmentSlotsResponse }
  post(path, body:, parser:)
end

#generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body) ⇒ 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.

  • (String)
  • (String)
  • (Hash[untyped, untyped])

Returns:



352
353
354
355
356
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 352

def generate_shipment_content_update_previews(inbound_plan_id, shipment_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/contentUpdatePreviews"
  parser = -> { GenerateShipmentContentUpdatePreviewsResponse }
  post(path, body:, parser:)
end

#generate_transportation_options(inbound_plan_id, body) ⇒ 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.

  • (String)
  • (Hash[untyped, untyped])

Returns:



632
633
634
635
636
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 632

def generate_transportation_options(inbound_plan_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/transportationOptions"
  parser = -> { GenerateTransportationOptionsResponse }
  post(path, body:, parser:)
end

#get_delivery_challan_document(inbound_plan_id, shipment_id) ⇒ 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.

  • (String)
  • (String)

Returns:



392
393
394
395
396
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 392

def get_delivery_challan_document(inbound_plan_id, shipment_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/deliveryChallanDocument"
  parser = -> { GetDeliveryChallanDocumentResponse }
  get(path, parser:)
end

#get_inbound_operation_status(operation_id) ⇒ 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.

  • (String)

Returns:



749
750
751
752
753
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 749

def get_inbound_operation_status(operation_id)
  path = "/inbound/fba/2024-03-20/operations/#{percent_encode(operation_id)}"
  parser = -> { InboundOperationStatus }
  get(path, parser:)
end

#get_inbound_plan(inbound_plan_id) ⇒ 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.

  • (String)

Returns:



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

def get_inbound_plan(inbound_plan_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}"
  parser = -> { InboundPlan }
  get(path, parser:)
end

#get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: 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: 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



530
531
532
533
534
535
536
537
538
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 530

def get_self_ship_appointment_slots(inbound_plan_id, shipment_id, page_size: 10, pagination_token: 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 = -> { GetSelfShipAppointmentSlotsResponse }
  get(path, params:, parser:)
end

#get_shipment(inbound_plan_id, shipment_id) ⇒ 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.

  • (String)
  • (String)

Returns:



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

def get_shipment(inbound_plan_id, shipment_id)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}"
  parser = -> { Shipment }
  get(path, parser:)
end

#get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id) ⇒ 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.

  • (String)
  • (String)
  • (String)

Returns:



367
368
369
370
371
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 367

def get_shipment_content_update_preview(inbound_plan_id, shipment_id, content_update_preview_id)
  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 = -> { ContentUpdatePreview }
  get(path, parser:)
end

#list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



410
411
412
413
414
415
416
417
418
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 410

def list_delivery_window_options(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
  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 = -> { ListDeliveryWindowOptionsResponse }
  get(path, params:, parser:)
end

#list_inbound_plan_boxes(inbound_plan_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



71
72
73
74
75
76
77
78
79
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 71

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

#list_inbound_plan_items(inbound_plan_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



103
104
105
106
107
108
109
110
111
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 103

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

#list_inbound_plan_pallets(inbound_plan_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



233
234
235
236
237
238
239
240
241
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 233

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

#list_inbound_plans(page_size: 10, pagination_token: nil, status: nil, sort_by: nil, sort_order: nil) ⇒ 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.

  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)
  • status: (String, nil) (defaults to: nil)
  • sort_by: (String, nil) (defaults to: nil)
  • sort_order: (String, nil) (defaults to: nil)

Returns:



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 26

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

#list_item_compliance_details(mskus, marketplace_id) ⇒ 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.

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.

  • (Array[String])
  • (String)

Returns:



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

def list_item_compliance_details(mskus, marketplace_id)
  path = "/inbound/fba/2024-03-20/items/compliance"
  params = {
    "mskus" => stringify_array(mskus),
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { ListItemComplianceDetailsResponse }
  get(path, params:, parser:)
end

#list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



136
137
138
139
140
141
142
143
144
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 136

def list_packing_group_boxes(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil)
  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 = -> { ListPackingGroupBoxesResponse }
  get(path, params:, parser:)
end

#list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



157
158
159
160
161
162
163
164
165
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 157

def list_packing_group_items(inbound_plan_id, packing_group_id, page_size: 10, pagination_token: nil)
  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 = -> { ListPackingGroupItemsResponse }
  get(path, params:, parser:)
end

#list_packing_options(inbound_plan_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



190
191
192
193
194
195
196
197
198
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 190

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

#list_placement_options(inbound_plan_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



253
254
255
256
257
258
259
260
261
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 253

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

#list_prep_details(marketplace_id, mskus) ⇒ 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.

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.

  • mskus (Array<String>) —

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

  • (String)
  • (Array[String])

Returns:



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

def list_prep_details(marketplace_id, mskus)
  path = "/inbound/fba/2024-03-20/items/prepDetails"
  params = {
    "marketplaceId" => marketplace_id,
    "mskus" => stringify_array(mskus),
  }.compact
  parser = -> { ListPrepDetailsResponse }
  get(path, params:, parser:)
end

#list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



311
312
313
314
315
316
317
318
319
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 311

def list_shipment_boxes(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
  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 = -> { ListShipmentBoxesResponse }
  get(path, params:, parser:)
end

#list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



333
334
335
336
337
338
339
340
341
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 333

def list_shipment_content_update_previews(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
  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 = -> { ListShipmentContentUpdatePreviewsResponse }
  get(path, params:, parser:)
end

#list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



460
461
462
463
464
465
466
467
468
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 460

def list_shipment_items(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
  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 = -> { ListShipmentItemsResponse }
  get(path, params:, parser:)
end

#list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil) ⇒ 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.

  • (String)
  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)

Returns:



493
494
495
496
497
498
499
500
501
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 493

def list_shipment_pallets(inbound_plan_id, shipment_id, page_size: 10, pagination_token: nil)
  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 = -> { ListShipmentPalletsResponse }
  get(path, params:, parser:)
end

#list_transportation_options(inbound_plan_id, page_size: 10, pagination_token: nil, placement_option_id: nil, shipment_id: nil) ⇒ 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.

  • (String)
  • page_size: (Integer, nil) (defaults to: 10)
  • pagination_token: (String, nil) (defaults to: nil)
  • placement_option_id: (String, nil) (defaults to: nil)
  • shipment_id: (String, nil) (defaults to: nil)

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 613

def list_transportation_options(inbound_plan_id, page_size: 10, pagination_token: nil, placement_option_id: nil,
  shipment_id: nil)
  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 = -> { ListTransportationOptionsResponse }
  get(path, params:, parser:)
end

#schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body) ⇒ 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: 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.

  • (String)
  • (String)
  • (String)
  • (Hash[untyped, untyped])

Returns:



563
564
565
566
567
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 563

def schedule_self_ship_appointment(inbound_plan_id, shipment_id, slot_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/selfShipAppointmentSlots/#{percent_encode(slot_id)}/schedule"
  parser = -> { ScheduleSelfShipAppointmentResponse }
  post(path, body:, parser:)
end

#set_packing_information(inbound_plan_id, body) ⇒ 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.

  • (String)
  • (Hash[untyped, untyped])

Returns:



174
175
176
177
178
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 174

def set_packing_information(inbound_plan_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/packingInformation"
  parser = -> { SetPackingInformationResponse }
  post(path, body:, parser:)
end

#set_prep_details(body) ⇒ 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.

  • (Hash[untyped, untyped])

Returns:



738
739
740
741
742
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 738

def set_prep_details(body)
  path = "/inbound/fba/2024-03-20/items/prepDetails"
  parser = -> { SetPrepDetailsResponse }
  post(path, body:, parser:)
end

#update_inbound_plan_name(inbound_plan_id, body) ⇒ 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.

  • (String)
  • (Hash[untyped, untyped])

Returns:



119
120
121
122
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 119

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

#update_item_compliance_details(marketplace_id, body) ⇒ 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.

  • body (Hash) —

    The body of the request to updateItemComplianceDetails.

  • (String)
  • (Hash[untyped, untyped])

Returns:



686
687
688
689
690
691
692
693
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 686

def update_item_compliance_details(marketplace_id, body)
  path = "/inbound/fba/2024-03-20/items/compliance"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { UpdateItemComplianceDetailsResponse }
  put(path, body:, params:, parser:)
end

#update_shipment_name(inbound_plan_id, shipment_id, body) ⇒ 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.

  • (String)
  • (String)
  • (Hash[untyped, untyped])

Returns:



477
478
479
480
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 477

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

#update_shipment_source_address(inbound_plan_id, shipment_id, body) ⇒ 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.

  • (String)
  • (String)
  • (Hash[untyped, untyped])

Returns:



579
580
581
582
583
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 579

def update_shipment_source_address(inbound_plan_id, shipment_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/sourceAddress"
  parser = -> { UpdateShipmentSourceAddressResponse }
  put(path, body:, parser:)
end

#update_shipment_tracking_details(inbound_plan_id, shipment_id, body) ⇒ 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.

  • (String)
  • (String)
  • (Hash[untyped, untyped])

Returns:



592
593
594
595
596
 
# File 'lib/peddler/apis/fulfillment_inbound_2024_03_20.rb', line 592

def update_shipment_tracking_details(inbound_plan_id, shipment_id, body)
  path = "/inbound/fba/2024-03-20/inboundPlans/#{percent_encode(inbound_plan_id)}/shipments/#{percent_encode(shipment_id)}/trackingDetails"
  parser = -> { UpdateShipmentTrackingDetailsResponse }
  put(path, body:, parser:)
end