Capabilities

print_mail.snap_packs.retrieve_capabilities() -> SnapPackRetrieveCapabilitiesResponse

GET/print-mail/v1/snap_packs/capabilities

Provides sizes and mailing classes available for the destination.

ParametersExpand Collapse

return_country_code: str

The country code where mail may be returned to.

destination_country_code: Optional[str]

The country code of where the snap pack will be sent to. One of mailingList or destinationCountryCode must be supplied but not both.

mailing_list: Optional[str]

Sources destination countries from the provided mailing list. One of mailingList or destinationCountryCode must be supplied but not both.

ReturnsExpand Collapse

class SnapPackRetrieveCapabilitiesResponse: …

mailing_classes: List[Literal["first_class", "standard_class", "express", 23 more]]

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

sizes: List[Literal["8.5x11_bifold_v"]]

Capabilities

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
response = client.print_mail.snap_packs.retrieve_capabilities(
    return_country_code="returnCountryCode",
)
print(response.mailing_classes)

{
  "sizes": [
    "8.5x11_bifold_v"
  ],
  "mailingClasses": [
    "express",
    "usps_express_2_day"
  ]
}

Returns Examples

{
  "sizes": [
    "8.5x11_bifold_v"
  ],
  "mailingClasses": [
    "express",
    "usps_express_2_day"
  ]
}