Atoship
Docs
Help CenterGitHub

Postman Collections

Download and use our official Postman collections to quickly test and integrate with the atoship API.

atoship API Collection
v2.1
Ready
Complete collection with 150+ API endpoints including modern V1 APIs, authentication, orders, shipping labels, tracking, and carrier management.
Download CollectionRun in Postman
Endpoints
155 API endpoints
Last Updated
2025-01-16
Size
3.2 MB
Format
Postman v2.1
Environment Variables
Required
Pre-configured environment variables for development, staging, and production environments.
DevelopmentProduction
Development Environment
http://localhost:3000
Local
Production Environment
https://atoship.com/api
Live

Getting Started

1. Import Collection

Download and import the atoship API collection into your Postman workspace.

2. Setup Environment

Configure your API keys and base URLs using our environment templates.

3. Test Endpoints

Start testing API endpoints with pre-configured requests and examples.

4. Automation

Use Newman or Postman CLI to run collections in your CI/CD pipeline.

Environment Setup

Required Variables
Set these environment variables in your Postman environment to authenticate and configure API requests.
api_key

Your atoship API key

sk_test_1234567890abcdef
base_url

API base URL

https://atoship.com/api/v1
environment

Environment type

development | production
timeout

Request timeout (ms)

30000
Environment Templates
Pre-configured environments for different stages of development.

Development Environment
Local

{
  "name": "atoship Development",
  "values": [
    {
      "key": "base_url",
      "value": "http://localhost:3000/api",
      "enabled": true
    },
    {
      "key": "api_key", 
      "value": "sk_test_1234567890abcdef",
      "enabled": true
    },
    {
      "key": "environment",
      "value": "development",
      "enabled": true
    }
  ]
}

Production Environment
Live

{
  "name": "atoship Production",
  "values": [
    {
      "key": "base_url",
      "value": "https://atoship.com/api/v1",
      "enabled": true
    },
    {
      "key": "api_key",
      "value": "sk_live_your_production_key",
      "enabled": true
    },
    {
      "key": "environment",
      "value": "production",
      "enabled": true
    }
  ]
}
Setup Instructions
Step-by-step guide to configure your Postman environment.
1

Import Environment File

Download and import the environment JSON file into Postman using the "Import" button.

2

Update API Key

Replace the placeholder API key with your actual atoship API key from the dashboard.

3

Select Environment

Choose the imported environment from the environment dropdown in the top-right corner.

4

Test Connection

Run a simple GET request to verify your environment configuration is working correctly.

API Coverage

Complete API Endpoint Coverage
Our Postman collection covers all available API endpoints organized by functionality.

Authentication

V1

API key management for sandbox and production.

  • • Create API Key
  • • List API Keys
  • • Delete API Key

Account

Core

Account settings, balance, users, and carriers.

  • • Get/Update Account
  • • Balance & Transactions
  • • Users & Teams
  • • Carrier Accounts (BYOCA)

Addresses

Core

Create, validate, and manage shipping addresses.

  • • Create Address
  • • Verify Address
  • • Get/List Addresses

Rates

Core

Get shipping rates from multiple carriers.

  • • Get Shipping Rates
  • • BYOCA Rate Support
  • • Multi-carrier Comparison

Labels

Popular

Create, manage, and download shipping labels.

  • • Create/Get/List Labels
  • • Tracking Integration
  • • Void/Refund Labels
  • • Insurance Coverage
  • • Fee Breakdown

Returns & Webhooks

Advanced

Return labels, QR codes, and event notifications.

  • • Create Return Labels/QR
  • • Webhook Endpoints
  • • Real-time Events
  • • Claims Management

Collection Features

Pre-request Scripts

Automatic authentication token management and request signing.

Test Scripts

Built-in response validation and error handling tests.

Example Responses

Real API responses for every endpoint with sample data.

Error Scenarios

Test cases for various error conditions and edge cases.

Workflows

End-to-end workflows for common integration patterns.

Documentation

Inline documentation and usage examples for each endpoint.

Quick Start Workflow

Complete Shipping Workflow Example
Test a complete end-to-end shipping process using our pre-configured requests.

Basic Flow (5 steps)

1
Create/Verify Address
POST /v1/addresses
2
Get Shipping Rates
POST /v1/rates
3
Create Label
POST /v1/labels
4
Track Package
GET /v1/tracking/:tracking_number
5
Configure Webhooks
POST /v1/webhooks

Advanced Features

Batch
Bulk Operations

Process multiple shipments simultaneously with batch APIs

AI
Smart Routing

AI-powered carrier selection and route optimization

Webhook
Real-time Updates

Automatic notifications for tracking and status changes

Returns
Return Labels

Generate return labels and manage return workflows

Ready to start testing?

Import our collection and follow the workflow above

Download CollectionTry API Playground
atoship © 2026