Skip to main content
GET
List Document Mailing Services

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

zip
string
required

Recipient ZIP code — services are rated against it.

Maximum string length: 20
country
string
default:US

Recipient country.

Maximum string length: 2
pages
integer
default:0

Total attachment pages you plan to send. Rates the heavier envelope so the quote matches what you will be billed. An estimate — the rate at create time is authoritative. Capped at the same 50-page limit create enforces.

Required range: 0 <= x <= 50
document_pages
integer
default:1

Pages in the document itself. Every shipment has one, so this defaults to 1. Billed per page just like attachments — an estimate for the quote, not a create-time limit.

Required range: 1 <= x <= 50

Response

The mailing services offered to you, priced for this destination.

status_code
integer
required

HTTP status code for the response.

data
DocumentShippingMethodQuote · object[]
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.