Skip to content
Full API Reference/
/
Add funds to carrier acco...

ShipStation V1 API (Legacy) (1.0.0)

The ShipStation V1 API (Legacy) provides comprehensive functionality for managing orders, shipments, carriers, and more within the ShipStation platform.

Getting Started

New integrations should use ShipStation API V2 whenever possible. This V1 API is maintained for existing integrations.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://www.shipstation.com/contact/
ShipStation Support
support@shipstation.com
License
MIT
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/
Production Server
https://ssapi.shipstation.com/

Accounts

Account management and tag operations

Operations

Carriers

Carrier information and package/service listings

Operations

List carriers

Request

List all shipping providers connected to this account

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/carriers

Responses

List of carriers retrieved successfully

Bodyapplication/jsonArray [
namestring
Example: "FedEx"
codestring
Example: "fedex"
accountNumberstring
Example: "297929999"
requiresFundedAccountboolean
Example: false
balancenumber
Example: 0
nicknamestring or null
Example: "SS"
Any of:
string
shippingProviderIdinteger
Example: 12348
primaryboolean
Example: true
]
Response
application/json
[
  {
    "name": "FedEx",
    "code": "fedex",
    "accountNumber": "297929999",
    "requiresFundedAccount": false,
    "balance": 0,
    "nickname": "SS",
    "shippingProviderId": 12348,
    "primary": true
  }
]

Add funds to carrier account

Request

Adds funds to a carrier account using the payment information on file.

IMPORTANT: Requires approval from apisupport@shipstation.com before use.

Security
basicAuth
Bodyapplication/jsonrequired
carrierCodestringrequired

The carrier to add funds to

Example: "fedex"
amountnumber[ 10 .. 10000 ]required

Dollar amount to add (min $10, max $10,000)

Example: 20
curl -i -X POST \
  -u <username>:<password> \
  https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/carriers/addfunds \
  -H 'Content-Type: application/json' \
  -d '{
    "carrierCode": "fedex",
    "amount": 20
  }'

Responses

Funds added successfully

Bodyapplication/json
namestring
Example: "Stamps.com"
codestring
Example: "stamps_com"
accountNumberstring
Example: "SS123"
requiresFundedAccountboolean
Example: true
balancenumber
Example: 24.14
Response
application/json
{
  "name": "Stamps.com",
  "code": "stamps_com",
  "accountNumber": "SS123",
  "requiresFundedAccount": true,
  "balance": 24.14
}

Get carrier by code

Request

Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.

Security
basicAuth
Query
carrierCodestringrequired

The code for the carrier account to retrieve

Example: carrierCode=stamps_com
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/carriers/getcarrier?carrierCode=stamps_com'

Responses

Carrier retrieved successfully

Bodyapplication/json
namestring
Example: "Stamps.com"
codestring
Example: "stamps_com"
accountNumberstring
Example: "SS123"
requiresFundedAccountboolean
Example: true
balancenumber
Example: 24.27
nicknamestring or null
Example: null
Any of:
string
shippingProviderIdinteger
Example: 12345
primaryboolean
Example: true
Response
application/json
{
  "name": "Stamps.com",
  "code": "stamps_com",
  "accountNumber": "SS123",
  "requiresFundedAccount": true,
  "balance": 24.27,
  "nickname": null,
  "shippingProviderId": 12345,
  "primary": true
}

List packages

Request

Retrieves a list of packages for the specified carrier

Security
basicAuth
Query
carrierCodestringrequired

The carrier's code

Example: carrierCode=fedex
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/carriers/listpackages?carrierCode=fedex'

Responses

List of packages retrieved successfully

Bodyapplication/jsonArray [
carrierCodestring
Example: "express_1"
codestring
Example: "flat_rate_envelope"
namestring
Example: "Flat Rate Envelope"
domesticboolean
Example: true
internationalboolean
Example: true
]
Response
application/json
[
  {
    "carrierCode": "express_1",
    "code": "flat_rate_envelope",
    "name": "Flat Rate Envelope",
    "domestic": true,
    "international": true
  }
]

List services

Request

Retrieves the list of available shipping services provided by the specified carrier

Security
basicAuth
Query
carrierCodestringrequired

The carrier's code

Example: carrierCode=fedex
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.shipstation.com/_mock/apis/shipstation-v1/openapi/carriers/listservices?carrierCode=fedex'

Responses

List of services retrieved successfully

Bodyapplication/jsonArray [
carrierCodestring
Example: "fedex"
codestring
Example: "fedex_ground"
namestring
Example: "FedEx Ground®"
domesticboolean
Example: true
internationalboolean
Example: false
]
Response
application/json
[
  {
    "carrierCode": "fedex",
    "code": "fedex_ground",
    "name": "FedEx Ground®",
    "domestic": true,
    "international": false
  }
]

Customers

Customer management

Operations

Fulfillments

Fulfillment operations

Operations

Orders

Order management and operations

Operations

Products

Product catalog management

Operations

Shipments

Shipment operations and rate shopping

Operations

Stores

Store configuration and management

Operations

Users

User management

Operations

Warehouses

Warehouse and fulfillment location management

Operations

Webhooks

Webhook subscription management

Operations
Shipstation
  • Facebook
  • Linkedin
  • Instagram
Auctane
ShipStation is powered by Auctane, a global delivery experience company. © 2026 Auctane, Inc. All rights reserved