Skip to content

Create and Manage Postsale API Keys

Connect your own systems to the Postsale API

Updated August 20, 20263 min readThird-Party Integrations

Use Application Programming Interface (API) keys to connect your own systems to the Postsale API. Each key can use only the Shipment API and Order API permissions that you select.

This article guides you through:

  • Creating a Postsale API key with the permissions your integration needs
  • Enabling, disabling, editing, regenerating, reviewing, and revoking an existing API key

Before You Begin

Here are a few suggestions to help you get started with your Postsale API keys:

  • Create a separate API key for each integration so you can assign only the permissions it needs and manage the key without affecting other integrations.
  • Decide which Shipment API and Order API permissions your integration requires
  • For added security:
    • Grant read-only access wherever possible and avoid permissions the integration does not need
    • Treat every API key like a password because the key acts on your Postsale account
  • Prepare a secure password manager or secret manager where you can store the API key
    • Postsale API keys are shown only once upon creation. Be sure to save your key(s) for later access if needed.

Good To Know

  • Send an API key as a bearer token in the Authorization header
  • API keys cannot access billing or account-security endpoints
  • API keys cannot access templates or automations
  • The API Keys pop-up shows each key's selected permissions, creation date, usage status, and logging status
  • Disable a key when you need a reversible pause, and revoke it only when you wish to remove its access permanently

Available Permissions

Select the appropriate tab to view a list of available permissions and their descriptions.

Shipments

  • Read Shipments: Look up and search shipments.
  • Get Rate Quotes: Compare carrier rates for a shipment. Costs the account nothing.
  • Create Shipments: Add new shipments, with their packages and addresses.
  • Edit Shipments: Change existing shipments, including adding and removing packages.
  • Delete Shipments: Remove shipments. They stop being reachable, and this cannot be undone.

Labels

  • Read Labels: Retrieve labels and their tracking details.
  • Buy Labels: Purchase postage. Spends money against the account payment method.
  • Void Labels: Cancel a purchased label and request a refund.

Carriers

  • Read Carriers: See connected carrier accounts, their settings, and carrier drop-off locations.
  • Manage Carriers: Connect, edit, and disconnect carrier accounts. Disconnecting one stops every future shipment on it.

Pickups

  • Check Pickup Availability: Ask a carrier when it could collect. Currently FedEx only.
  • Schedule Pickups: Book a carrier collection. This sends a courier to the address.
  • Cancel Pickups: Cancel a booked collection.

Manifests

  • Read Manifests: See end-of-day manifests and which shipments are eligible for one.
  • Create Manifests: Close out the day by submitting a manifest to the carrier.

Addresses

  • Read Addresses: See saved ship-from addresses, and look up or autocomplete an address.
  • Manage Addresses: Add, edit, and remove ship-from addresses.

Shipping Rules

  • Read Shipping Rules: See the rules that pick a service and packaging, and what they would do for a shipment.
  • Manage Shipping Rules: Create, edit, and delete shipping rules.

Documents

  • Read Documents: Retrieve customs paperwork and commercial invoices attached to a shipment.
  • Manage Documents: Upload, replace, and remove customs documents.

Shipping Settings

  • Read Shipping Settings: See account-level shipping settings.
  • Manage Shipping Settings: Change account-level shipping settings.

Insurance

  • Read Insurance Claims: See claims filed against a shipment.

Related

Keep reading