API Overview

Export

v1.0

API Base URL

• Sandbox: https://sandbox-api.aftership.com/postmen/v3
• Production: https://api.aftership.com/postmen/v3

Security

API Key

An API key is a token that you provide when making API calls. Include the token in a header parameter called as-api-key.

Example: as-api-key: 123

Additional Information

For more assistance, Contact AfterShip Support.

For terms and conditions, please refer to our Terms of Service.

Important: The OAS Schema can be downloaded here.

QUICKSTART

• API Quick Start
• Authentication
• SignString

OAuth

• Overview
• Getting Started
• Scope List
• Rate Limit
• Body Envelope
• Request Errors

CHANGELOG

• Changelog

REFERENCE

• API Overview v3

Rates

• Get rates
• Calculate rates
• Get a rate

Labels

• Get labels
• Create a label
• Get a label

Manifests

• Get manifests
• Create a manifest
• Get a manifest

Couriers

• Get all couriers

Cancel Labels

• Get the cancelled labels
• Cancel a label
• Get a cancelled label

Pickups

• Get pickups
• Create a pickup
• Get a pickup

Cancel Pickups

• Get the cancelled pickups
• Cancel a pickup
• Get a cancelled pickup

Shipper Accounts

• Get shipper accounts
• Create a shipper account
• Get a shipper account
• Delete a shipper account
• Update a shipper account's information
• Update a shipper account's credentials
• Update a shipper account's settings

Specific Shipper Accounts

• Create a FedEx shipper account
• Update a FedEx shipper account

Address Validations (Beta)

• Create an address validation

Locations

• Get locations

MODEL

Envelope

• Meta v3
• Error v3

Primitive

• Billing v3
• Customs v3
• Shipment v3
• Address v3
• Parcel v3
• Item v3
• Courier v3
• Reference v3
• Money v3
• PaymentMethodAccount v3
• Dimension v3
• Weight v3
• Volume v3
• Aes v3
• NoEei v3

Resource

• Rate v3
• RateRecord v3
• Label v3
• Manifest v3
• ShipperAccount v3
• CancelLabel v3
• AddressValidation (Beta) v3
• Location v3
• Pickup v3
• CancelPickup v3

Carrier Guide

• Supported Carriers

ENUM

• Shipper Accounts Credentials
• Service Types and Service Options List
• All Service Options

Webhook

• Webhook Overview
• Webhook Specifications
• Webhook Signature
• Webhook Outgoing IPs

SDK

• Java SDK
• Node.js SDK

Open Source

• phone
• email-verifier

Support

• Contact Support