Skip to content

ShipSaving Legacy API (v1)

Overview
License
Languages
Servers
Production server
https://api.shipsaving.com

Label Management

Operations

Order Management

Operations

Address Verification

Operations

SCAN Form

Operations

Create USPS SCAN Form

Request

Creates a USPS SCAN Form for the provided list of shipment tracking codes. Only applicable to shipments with valid USPS tracking numbers.
Rate limit: 60 requests per minute.

Security
ApiTokenAuth
Bodyapplication/jsonrequired
tracking_codesArray of stringsrequired

List of shipment tracking codes

curl -i -X POST \
  'https://api.shipsaving.com/api/shipments/scan-forms/create?api_token=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tracking_codes": [
      "9434611899562089592093",
      "9434611899562089592048"
    ]
  }'

Responses

Successfully retrieved manifest PDF URL

Bodyapplication/json
urlstring(uri)

Manifest URL to the SCAN Form document (PDF)

Response
application/json
{ "url": "https://...../forms/2024-11-01/12345667.pdf" }

Create DHL eCommerce SCAN Form

Request

Initiates the asynchronous creation of a DHL eCommerce SCAN Form. Returns a request ID that can be used with the Get DHL eCommerce SCAN Form endpoint to retrieve the final manifest PDF.
Rate limit: 60 requests per minute.

Security
ApiTokenAuth
Bodyapplication/jsonrequired
tracking_codesArray of stringsrequired

List of shipment tracking codes

curl -i -X POST \
  'https://api.shipsaving.com/api/shipments/scan-forms/dhl/ecommerce/create?api_token=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tracking_codes": [
      "40EB09B82E1146DE9166C499A0B4EA",
      "40EB09B82E1146DE9166C499A0B4DD"
    ]
  }'

Responses

SCAN Form request accepted

Bodyapplication/json
requestinteger

Request ID for fetching the manifest later

Response
application/json
{ "request": 202 }

Get DHL eCommerce SCAN Form

Request

Returns the DHL eCommerce SCAN Form PDF URL based on the request ID from the creation endpoint.
Rate limit: 60 requests per minute.

Security
ApiTokenAuth
Query
request_idintegerrequired

Request ID returned from the Create SCAN Form API

curl -i -X GET \
  'https://api.shipsaving.com/api/shipments/scan-forms/dhl/ecommerce/get?request_id=0&api_token=YOUR_API_KEY_HERE'

Responses

Successfully retrieved manifest PDF URL

Bodyapplication/json
urlstring(uri)

Manifest URL to the SCAN Form document (PDF)

Response
application/json
{ "url": "https://...../forms/2024-11-01/12345667.pdf" }

Carrier Management

Operations

Account Management

Operations