Class: Peddler::APIs::ShipmentInvoicingV0

Inherits:
Peddler::API show all
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.

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

#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

Returns:



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

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

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 Notifications API Use Case Guide.

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

    Requests per second

Returns:



31
32
33
34
35
 
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 31

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

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

Returns:



44
45
46
47
48
 
# File 'lib/peddler/apis/shipment_invoicing_v0.rb', line 44

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