Module: Usps::Api::Endpoints::PTSPod

Included in:
Usps::Api::Endpoints
Defined in:
lib/usps/api/endpoints/pts_pod.rb

Instance Method Summary collapse

Instance Method Details

#pts_pod(options = {}) ⇒ Object

Proof of Delivery is a letter that includes the recipient’s name and a copy of their signature. The Proof of Delivery API allows the customer to request proof of delivery notification via email. When you request access for this API, please identify your anticipated API volume, mailer ID and how you will be utilizing this API. A mailer identification number (MID) is a 6 or 9-digit number assigned to a customer through the USPS Business Customer Gateway (BCG). Please refer to the following links for help:

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • pts_pod_request (required, Hash) —

    • :track_id (required, String)

    • :client_ip (String)

    • :source_id (String)

    • :mp_suffix (required, integer)

    • :mp_date (required, String)

    • :request_type (required, String)

    • :first_name (required, String)

    • :last_name (required, String)

    • :email1 (String)

    • :email2 (String)

    • :email3 (String)

    • :fax_number (String)

    • :address_line1 (String)

    • :address_line2 (String)

    • :city (String)

    • :state (String)

    • :zip (String)

    • :verify_address (Boolean)

    • :table_code (required, String)

    • :cust_reg_id (String)



39
40
41
42
43
44
45
 
# File 'lib/usps/api/endpoints/pts_pod.rb', line 39

def pts_pod(options = {})
	request = build_request(:pts_pod, options)
	get('https://secure.shippingapis.com/ShippingAPI.dll', {
		API: 'PTSPod',
		XML: request,
	})
end