class Peddler::API::ShipmentInvoicingV0

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.

Public Instance Methods

get_invoice_status(shipment_id, rate_limit: 1.133) click to toggle source

Returns the invoice status for the shipment you specify.

@note This operation can make a static sandbox call. @param shipment_id [String] The shipment identifier for the shipment. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/shipment_invoicing_v0.rb, line 52
def get_invoice_status(shipment_id, rate_limit: 1.133)
  path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice/status"

  meter(rate_limit).get(path)
end
get_shipment_details(shipment_id, rate_limit: 1.133) click to toggle source

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

@note This operation can make a static sandbox call. @param shipment_id [String] The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus

notification. For information about subscribing to notifications, see the
{https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide Notifications API Use Case
Guide}.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/shipment_invoicing_v0.rb, line 27
def get_shipment_details(shipment_id, rate_limit: 1.133)
  path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}"

  meter(rate_limit).get(path)
end
submit_invoice(shipment_id, body, rate_limit: 1.133) click to toggle source

Submits a shipment invoice document for a given shipment.

@note This operation can make a static sandbox call. @param shipment_id [String] The identifier for the shipment. @param body [Hash] @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/shipment_invoicing_v0.rb, line 40
def submit_invoice(shipment_id, body, rate_limit: 1.133)
  path = "/fba/outbound/brazil/v0/shipments/#{shipment_id}/invoice"

  meter(rate_limit).post(path, body:)
end