Method: Peddler::APIs::VendorOrdersV1#get_purchase_order

Defined in:
lib/peddler/apis/vendor_orders_v1.rb

#get_purchase_order(purchase_order_number, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns a purchase order based on the ‘purchaseOrderNumber` value that you specify.

Parameters:

  • purchase_order_number (String)

    The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.

  • rate_limit (Float) (defaults to: 10.0)

    Requests per second

Returns:



80
81
82
83
84
# File 'lib/peddler/apis/vendor_orders_v1.rb', line 80

def get_purchase_order(purchase_order_number, rate_limit: 10.0)
  path = "/vendor/orders/v1/purchaseOrders/#{percent_encode(purchase_order_number)}"

  meter(rate_limit).get(path)
end