Class: MWS::ShipmentInvoicing::Client

Inherits:
Peddler::Client show all
Defined in:
lib/mws/shipment_invoicing/client.rb

Overview

Note:

This functionality is available only in the Brazil marketplace.

With the Shipment Invoicing API section, you can integrate invoicing into Amazon's shipping process for a seller's FBA order.

Instance Attribute Summary

Attributes inherited from Peddler::Client

#auth_token, #body, #marketplace, #merchant_id

Instance Method Summary collapse

Methods inherited from Peddler::Client

#initialize

Constructor Details

This class inherits a constructor from Peddler::Client

Instance Method Details

#get_fba_outbound_shipment_detail(marketplace_id, amazon_shipment_id) ⇒ Peddler::XMLParser

Returns the information required to generate an invoice for the shipment of a Fulfillment by Amazon order

Parameters:

  • marketplace_id (String)
  • amazon_shipment_id (String)

Returns:

  • (Peddler::XMLParser)

See Also:


22
23
24
25
26
27
28
# File 'lib/mws/shipment_invoicing/client.rb', line 22

def get_fba_outbound_shipment_detail(marketplace_id, amazon_shipment_id)
  operation('GetFBAOutboundShipmentDetail')
    .add('MarketplaceId' => marketplace_id,
         'AmazonShipmentId' => amazon_shipment_id)

  run
end

#get_fba_outbound_shipment_invoice_status(marketplace_id, amazon_shipment_id) ⇒ Peddler::XMLParser

Gets the invoice processing status for the shipments that you specify

Parameters:

  • marketplace_id (String)
  • amazon_shipment_id (String)

Returns:

  • (Peddler::XMLParser)

See Also:


55
56
57
58
59
60
61
62
# File 'lib/mws/shipment_invoicing/client.rb', line 55

def get_fba_outbound_shipment_invoice_status(marketplace_id,
                                             amazon_shipment_id)
  operation('GetFBAOutboundShipmentInvoiceStatus')
    .add('MarketplaceId' => marketplace_id,
         'AmazonShipmentId' => amazon_shipment_id)

  run
end

#get_service_statusPeddler::XMLParser

Gets the operational status of the API


68
69
70
71
# File 'lib/mws/shipment_invoicing/client.rb', line 68

def get_service_status
  operation('GetServiceStatus')
  run
end

#submit_fba_outbound_shipment_invoice(marketplace_id, amazon_shipment_id, invoice_content) ⇒ Peddler::XMLParser

Submits shipment invoice data for a given shipment

Parameters:

  • marketplace_id (String)
  • amazon_shipment_id (String)
  • invoice_content (String)

Returns:

  • (Peddler::XMLParser)

See Also:


37
38
39
40
41
42
43
44
45
46
47
# File 'lib/mws/shipment_invoicing/client.rb', line 37

def submit_fba_outbound_shipment_invoice(marketplace_id,
                                         amazon_shipment_id,
                                         invoice_content)
  self.body = invoice_content

  operation('SubmitFBAOutboundShipmentInvoice')
    .add('MarketplaceId' => marketplace_id,
         'AmazonShipmentId' => amazon_shipment_id)

  run
end