Class: Peddler::APIs::EasyShip20220323

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/easy_ship_2022_03_23.rb

Overview

Selling Partner API for Easy Ship

Use the Selling Partner API for Easy Ship to build applications for sellers to manage and ship Amazon Easy Ship orders. With this API, you can get available time slots, schedule and reschedule Easy Ship orders, and print shipping labels, invoices, and warranties. To review the differences in Easy Ship operations by marketplace, refer to [Marketplace support](developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support).

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

#create_scheduled_package(create_scheduled_package_request, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Schedules an Easy Ship order and returns the scheduled package information.

This operation does the following:

  • Specifies the time slot and handover method for the order to be scheduled for delivery.

  • Updates the Easy Ship order status.

  • Generates a shipping label and an invoice. Calling ‘createScheduledPackage` also generates a warranty document

if you specify a ‘SerialNumber` value. To get these documents, see How to get invoice, shipping label, and warranty documents.

  • Shows the status of Easy Ship orders when you call the ‘getOrders` operation of the Selling Partner API for

Orders and examine the ‘EasyShipShipmentStatus` property in the response body.

See the **Shipping Label**, Invoice, and Warranty columns in the Marketplace Support Table to see which documents are supported in each marketplace.

Parameters:

  • create_scheduled_package_request (Hash) —

    The request schema for the ‘createScheduledPackage` operation.

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

    Requests per second

Returns:



90
91
92
93
94
95
 
# File 'lib/peddler/apis/easy_ship_2022_03_23.rb', line 90

def create_scheduled_package(create_scheduled_package_request, rate_limit: 1.0)
  path = "/easyShip/2022-03-23/package"
  body = create_scheduled_package_request
  parser = Peddler::Types::EasyShip20220323::Package if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#create_scheduled_package_bulk(create_scheduled_packages_request, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

This operation automatically schedules a time slot for all the ‘amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the marketplace document support table).

Developers calling this operation may optionally assign a ‘packageDetails` object, allowing them to input a preferred time slot for each order in their request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, i.e., if the time slot is not provided, Amazon will then pick the earliest time slot possible.

Regarding the shipping label’s file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly.

This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn’t be scheduled, then Amazon adds the ‘rejectedOrders` list into the response, which contains an entry for each order we couldn’t process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action.

The table below displays the supported request and burst maximum rates:

Parameters:

  • create_scheduled_packages_request (Hash) —

    The request schema for the ‘createScheduledPackageBulk` operation.

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

    Requests per second

Returns:



142
143
144
145
146
147
 
# File 'lib/peddler/apis/easy_ship_2022_03_23.rb', line 142

def create_scheduled_package_bulk(create_scheduled_packages_request, rate_limit: 1.0)
  path = "/easyShip/2022-03-23/packages/bulk"
  body = create_scheduled_packages_request
  parser = Peddler::Types::EasyShip20220323::CreateScheduledPackagesResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#get_scheduled_package(amazon_order_id, marketplace_id, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status.

Parameters:

  • amazon_order_id (String) —

    An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.

  • marketplace_id (String) —

    An identifier for the marketplace in which the seller is selling.

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

    Requests per second

Returns:



56
57
58
59
60
61
62
63
64
 
# File 'lib/peddler/apis/easy_ship_2022_03_23.rb', line 56

def get_scheduled_package(amazon_order_id, marketplace_id, rate_limit: 1.0)
  path = "/easyShip/2022-03-23/package"
  params = {
    "amazonOrderId" => amazon_order_id,
    "marketplaceId" => marketplace_id,
  }.compact
  parser = Peddler::Types::EasyShip20220323::Package if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_handover_slots(list_handover_slots_request: nil, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies.

This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the Marketplace Support Table.

This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the Marketplace Support Table.

Parameters:

  • list_handover_slots_request (Hash) (defaults to: nil) —

    The request schema for the ‘listHandoverSlots` operation.

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

    Requests per second

Returns:



40
41
42
43
44
45
 
# File 'lib/peddler/apis/easy_ship_2022_03_23.rb', line 40

def list_handover_slots(list_handover_slots_request: nil, rate_limit: 1.0)
  path = "/easyShip/2022-03-23/timeSlot"
  body = list_handover_slots_request
  parser = Peddler::Types::EasyShip20220323::ListHandoverSlotsResponse if typed?
  meter(rate_limit).post(path, body:, parser:)
end

#update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Updates the time slot for handing over the package indicated by the specified ‘scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call.

See the **Update Package** column in the Marketplace Support Table to see which marketplaces this operation is supported in.

Parameters:

  • update_scheduled_packages_request (Hash) (defaults to: nil) —

    The request schema for the ‘updateScheduledPackages` operation.

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

    Requests per second

Returns:



109
110
111
112
113
114
 
# File 'lib/peddler/apis/easy_ship_2022_03_23.rb', line 109

def update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit: 1.0)
  path = "/easyShip/2022-03-23/package"
  body = update_scheduled_packages_request
  parser = Peddler::Types::EasyShip20220323::Packages if typed?
  meter(rate_limit).patch(path, body:, parser:)
end