Class: Peddler::APIs::VendorDirectFulfillmentShipping20211228

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/item.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/error.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/weight.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/address.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/package.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/packages.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/container.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/dimensions.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/error_list.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/label_data.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/pagination.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/packed_item.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/packing_slip.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/item_quantity.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/shipping_label.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/container_label.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/customer_invoice.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/shipment_details.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/packing_slip_list.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/shipment_schedule.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/shipping_label_list.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/party_identification.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/customer_invoice_list.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/shipment_confirmation.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/status_update_details.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/transaction_reference.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/shipment_status_update.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/shipping_label_request.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/tax_registration_details.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/create_container_label_request.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/create_shipping_labels_request.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/submit_shipping_labels_request.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/create_container_label_response.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/submit_shipment_confirmations_request.rb,
lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28/submit_shipment_status_updates_request.rb,
sig/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rbs

Overview

Selling Partner API for Direct Fulfillment Shipping

Use the Selling Partner API for Direct Fulfillment Shipping to access a direct fulfillment vendor's shipping data.

See Also:

Defined Under Namespace

Classes: Address, Container, ContainerLabel, CreateContainerLabelRequest, CreateContainerLabelResponse, CreateShippingLabelsRequest, CustomerInvoice, CustomerInvoiceList, Dimensions, Error, ErrorList, Item, ItemQuantity, LabelData, Package, Packages, PackedItem, PackingSlip, PackingSlipList, Pagination, PartyIdentification, ShipmentConfirmation, ShipmentDetails, ShipmentSchedule, ShipmentStatusUpdate, ShippingLabel, ShippingLabelList, ShippingLabelRequest, StatusUpdateDetails, SubmitShipmentConfirmationsRequest, SubmitShipmentStatusUpdatesRequest, SubmitShippingLabelsRequest, TaxRegistrationDetails, TransactionReference, Weight

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

#create_container_label(body, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Creates a container (pallet) label for the associated shipment package.

Parameters:

  • body (Hash) —

    Request body containing the container label data.

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

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



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

def create_container_label(body, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/containerLabel"
  parser = -> { CreateContainerLabelResponse }
  post(path, body:, rate_limit:, parser:)
end

#create_shipping_labels(purchase_order_number, body, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Creates shipping labels for a purchase order and returns the labels.

Parameters:

  • purchase_order_number (String) —

    The purchase order number for which you want to return the shipping labels. It should be the same number as the purchaseOrderNumber in the order.

  • body (Hash) —

    The request payload that contains the parameters for creating shipping labels.

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

    Requests per second

  • (String)
  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



80
81
82
83
84
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 80

def create_shipping_labels(purchase_order_number, body, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/#{percent_encode(purchase_order_number)}"
  parser = -> { ShippingLabel }
  post(path, body:, rate_limit:, parser:)
end

#get_customer_invoice(purchase_order_number, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a customer invoice based on the purchaseOrderNumber that you specify.

Parameters:

  • purchase_order_number (String) —

    Purchase order number of the shipment for which to return the invoice.

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

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



150
151
152
153
154
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 150

def get_customer_invoice(purchase_order_number, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/customerInvoices/#{percent_encode(purchase_order_number)}"
  parser = -> { CustomerInvoice }
  get(path, rate_limit:, parser:)
end

#get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil, next_token: nil, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.

Parameters:

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

    The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.

  • limit (Integer) (defaults to: nil) —

    The limit to the number of records returned

  • created_after (String) —

    Orders that became available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

  • created_before (String) —

    Orders that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

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

    Sort ASC or DESC by order creation date.

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

    Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.

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

    Requests per second

  • (String)
  • (String)
  • ship_from_party_id: (String, nil) (defaults to: nil)
  • limit: (Integer, nil) (defaults to: nil)
  • sort_order: (String, nil) (defaults to: nil)
  • next_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 129

def get_customer_invoices(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: nil,
  next_token: nil, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/customerInvoices"
  params = {
    "shipFromPartyId" => ship_from_party_id,
    "limit" => limit,
    "createdAfter" => created_after,
    "createdBefore" => created_before,
    "sortOrder" => sort_order,
    "nextToken" => next_token,
  }.compact
  parser = -> { CustomerInvoiceList }
  get(path, params:, rate_limit:, parser:)
end

#get_packing_slip(purchase_order_number, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a packing slip based on the purchaseOrderNumber that you specify.

Parameters:

  • purchase_order_number (String) —

    The purchaseOrderNumber for the packing slip that you want.

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

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



193
194
195
196
197
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 193

def get_packing_slip(purchase_order_number, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/packingSlips/#{percent_encode(purchase_order_number)}"
  parser = -> { PackingSlip }
  get(path, rate_limit:, parser:)
end

#get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC", next_token: nil, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.

Parameters:

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

    The vendor warehouseId for order fulfillment. If not specified, the result contains orders for all warehouses.

  • limit (Integer) (defaults to: nil) —

    The maximum number of records to return.

  • created_after (String) —

    Packing slips that become available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

  • created_before (String) —

    Packing slips that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

  • sort_order (String) (defaults to: "ASC") —

    The packing slip creation dates, which are sorted by ascending or descending order.

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

    Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.

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

    Requests per second

  • (String)
  • (String)
  • ship_from_party_id: (String, nil) (defaults to: nil)
  • limit: (Integer, nil) (defaults to: nil)
  • sort_order: (String, nil) (defaults to: "ASC")
  • next_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 172

def get_packing_slips(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC",
  next_token: nil, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/packingSlips"
  params = {
    "shipFromPartyId" => ship_from_party_id,
    "limit" => limit,
    "createdAfter" => created_after,
    "createdBefore" => created_before,
    "sortOrder" => sort_order,
    "nextToken" => next_token,
  }.compact
  parser = -> { PackingSlipList }
  get(path, params:, rate_limit:, parser:)
end

#get_shipping_label(purchase_order_number, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a shipping label for the purchaseOrderNumber that you specify.

Parameters:

  • purchase_order_number (String) —

    The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber that you received in the order.

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

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



66
67
68
69
70
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 66

def get_shipping_label(purchase_order_number, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels/#{percent_encode(purchase_order_number)}"
  parser = -> { ShippingLabel }
  get(path, rate_limit:, parser:)
end

#get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC", next_token: nil, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Returns a list of shipping labels created during the time frame that you specify. Use the createdAfter and createdBefore parameters to define the time frame. You must use both of these parameters. The date range to search must not be more than seven days.

Parameters:

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

    The vendor warehouseId for order fulfillment. If not specified, the result contains orders for all warehouses.

  • limit (Integer) (defaults to: nil) —

    The limit to the number of records returned.

  • created_after (String) —

    Shipping labels that became available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

  • created_before (String) —

    Shipping labels that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

  • sort_order (String) (defaults to: "ASC") —

    The sort order creation date. You can choose between ascending (ASC) or descending (DESC) sort order.

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

    Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.

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

    Requests per second

  • (String)
  • (String)
  • ship_from_party_id: (String, nil) (defaults to: nil)
  • limit: (Integer, nil) (defaults to: nil)
  • sort_order: (String, nil) (defaults to: "ASC")
  • next_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 32

def get_shipping_labels(created_after, created_before, ship_from_party_id: nil, limit: nil, sort_order: "ASC",
  next_token: nil, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels"
  params = {
    "shipFromPartyId" => ship_from_party_id,
    "limit" => limit,
    "createdAfter" => created_after,
    "createdBefore" => created_before,
    "sortOrder" => sort_order,
    "nextToken" => next_token,
  }.compact
  parser = -> { ShippingLabelList }
  get(path, params:, rate_limit:, parser:)
end

#submit_shipment_confirmations(body, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Submits one or more shipment confirmations for vendor orders.

Parameters:

  • body (Hash) —

    Request body containing the shipment confirmations data.

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

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



92
93
94
95
96
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 92

def submit_shipment_confirmations(body, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/shipmentConfirmations"
  parser = -> { TransactionReference }
  post(path, body:, rate_limit:, parser:)
end

#submit_shipment_status_updates(body, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.

Parameters:

  • body (Hash) —

    Request body containing the shipment status update data.

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

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



106
107
108
109
110
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 106

def submit_shipment_status_updates(body, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/shipmentStatusUpdates"
  parser = -> { TransactionReference }
  post(path, body:, rate_limit:, parser:)
end

#submit_shipping_label_request(body, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a dynamic sandbox call.

Creates a shipping label for a purchase order and returns a transactionId for reference.

Parameters:

  • body (Hash) —

    The request body that contains the shipping labels data.

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

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



53
54
55
56
57
 
# File 'lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb', line 53

def submit_shipping_label_request(body, rate_limit: 10.0)
  path = "/vendor/directFulfillment/shipping/2021-12-28/shippingLabels"
  parser = -> { TransactionReference }
  post(path, body:, rate_limit:, parser:)
end