Class: Peddler::APIs::ShipmentInvoicingV0
- Inherits:
-
Peddler::API
- Object
- Peddler::API
- Peddler::APIs::ShipmentInvoicingV0
- Defined in:
- lib/peddler/apis/shipment_invoicing_v0.rb
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.
Instance Attribute Summary
Attributes inherited from Peddler::API
#access_token, #endpoint, #retries
Instance Method Summary collapse
-
#get_invoice_status(shipment_id, rate_limit: 1.133) ⇒ Peddler::Response
Returns the invoice status for the shipment you specify.
-
#get_shipment_details(shipment_id, rate_limit: 1.133) ⇒ Peddler::Response
Returns the shipment details required to issue an invoice for the specified shipment.
-
#submit_invoice(shipment_id, body, rate_limit: 1.133) ⇒ Peddler::Response
Submits a shipment invoice document for a given shipment.
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
#get_invoice_status(shipment_id, rate_limit: 1.133) ⇒ Peddler::Response
This operation can make a static sandbox call.
Returns the invoice status for the shipment you specify.
54 55 56 57 58 |
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 54 def get_invoice_status(shipment_id, rate_limit: 1.133) path = "/fba/outbound/brazil/v0/shipments/#{percent_encode(shipment_id)}/invoice/status" parser = Peddler::Types::ShipmentInvoicingV0::GetInvoiceStatusResponse if typed? meter(rate_limit).get(path, parser:) end |
#get_shipment_details(shipment_id, rate_limit: 1.133) ⇒ Peddler::Response
This operation can make a static sandbox call.
Returns the shipment details required to issue an invoice for the specified shipment.
29 30 31 32 33 |
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 29 def get_shipment_details(shipment_id, rate_limit: 1.133) path = "/fba/outbound/brazil/v0/shipments/#{percent_encode(shipment_id)}" parser = Peddler::Types::ShipmentInvoicingV0::GetShipmentDetailsResponse if typed? meter(rate_limit).get(path, parser:) end |
#submit_invoice(shipment_id, body, rate_limit: 1.133) ⇒ Peddler::Response
This operation can make a static sandbox call.
Submits a shipment invoice document for a given shipment.
42 43 44 45 46 |
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 42 def submit_invoice(shipment_id, body, rate_limit: 1.133) path = "/fba/outbound/brazil/v0/shipments/#{percent_encode(shipment_id)}/invoice" parser = Peddler::Types::ShipmentInvoicingV0::SubmitInvoiceResponse if typed? meter(rate_limit).post(path, body:, parser:) end |