Class: Peddler::APIs::ShipmentInvoicingV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/shipment_invoicing_v0.rb,
lib/peddler/apis/shipment_invoicing_v0/error.rb,
lib/peddler/apis/shipment_invoicing_v0/address.rb,
lib/peddler/apis/shipment_invoicing_v0/error_list.rb,
lib/peddler/apis/shipment_invoicing_v0/shipment_item.rb,
lib/peddler/apis/shipment_invoicing_v0/buyer_tax_info.rb,
lib/peddler/apis/shipment_invoicing_v0/shipment_items.rb,
lib/peddler/apis/shipment_invoicing_v0/shipment_detail.rb,
lib/peddler/apis/shipment_invoicing_v0/tax_classification.rb,
lib/peddler/apis/shipment_invoicing_v0/payment_information.rb,
lib/peddler/apis/shipment_invoicing_v0/serial_numbers_list.rb,
lib/peddler/apis/shipment_invoicing_v0/marketplace_tax_info.rb,
lib/peddler/apis/shipment_invoicing_v0/submit_invoice_request.rb,
lib/peddler/apis/shipment_invoicing_v0/submit_invoice_response.rb,
lib/peddler/apis/shipment_invoicing_v0/tax_classification_list.rb,
lib/peddler/apis/shipment_invoicing_v0/payment_information_list.rb,
lib/peddler/apis/shipment_invoicing_v0/get_invoice_status_response.rb,
lib/peddler/apis/shipment_invoicing_v0/shipment_invoice_status_info.rb,
lib/peddler/apis/shipment_invoicing_v0/get_shipment_details_response.rb,
lib/peddler/apis/shipment_invoicing_v0/payment_method_detail_item_list.rb,
lib/peddler/apis/shipment_invoicing_v0/shipment_invoice_status_response.rb,
sig/peddler/apis/shipment_invoicing_v0.rbs

Overview

Selling Partner API for Shipment Invoicing

The Selling Partner API for Shipment Invoicing helps you programmatically retrieve shipment invoice information in the Brazil marketplace for a selling partner’s Fulfillment by Amazon (FBA) orders.

See Also:

Defined Under Namespace

Classes: Address, BuyerTaxInfo, Error, ErrorList, GetInvoiceStatusResponse, GetShipmentDetailsResponse, MarketplaceTaxInfo, PaymentInformation, PaymentInformationList, PaymentMethodDetailItemList, SerialNumbersList, ShipmentDetail, ShipmentInvoiceStatusInfo, ShipmentInvoiceStatusResponse, ShipmentItem, ShipmentItems, SubmitInvoiceRequest, SubmitInvoiceResponse, TaxClassification, TaxClassificationList

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

#get_invoice_status(shipment_id, rate_limit: 1.133) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the invoice status for the shipment you specify.

Parameters:

  • shipment_id (String) —

    The shipment identifier for the shipment.

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

    Requests per second

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

Returns:



48
49
50
51
52
 
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 48

def get_invoice_status(shipment_id, rate_limit: 1.133)
  path = "/fba/outbound/brazil/v0/shipments/#{percent_encode(shipment_id)}/invoice/status"
  parser = -> { GetInvoiceStatusResponse }
  get(path, rate_limit:, parser:)
end

#get_shipment_details(shipment_id, rate_limit: 1.133) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the shipment details required to issue an invoice for the specified shipment.

Parameters:

  • shipment_id (String) —

    The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the href="https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide">https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide Notifications API Use Case Guide.

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

    Requests per second

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

Returns:



23
24
25
26
27
 
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 23

def get_shipment_details(shipment_id, rate_limit: 1.133)
  path = "/fba/outbound/brazil/v0/shipments/#{percent_encode(shipment_id)}"
  parser = -> { GetShipmentDetailsResponse }
  get(path, rate_limit:, parser:)
end

#submit_invoice(shipment_id, body, rate_limit: 1.133) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Submits a shipment invoice document for a given shipment.

Parameters:

  • shipment_id (String) —

    The identifier for the shipment.

  • body (Hash)
  • rate_limit (Float) (defaults to: 1.133) —

    Requests per second

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

Returns:



36
37
38
39
40
 
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 36

def submit_invoice(shipment_id, body, rate_limit: 1.133)
  path = "/fba/outbound/brazil/v0/shipments/#{percent_encode(shipment_id)}/invoice"
  parser = -> { SubmitInvoiceResponse }
  post(path, body:, rate_limit:, parser:)
end