Skip to content
/
Create Orders

ShipSaving Legacy API (v1)

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

Label Management

Operations

Order Management

Operations

Create Orders

Request

Creates a new order in the ShipSaving system. Typically used to pre-create orders before generating shipping labels.
Rate limit: 300 requests per minute.

Security
ApiTokenAuth
Bodyapplication/jsonrequired
store_namestringrequired

Store nickname as registered in your ShipSaving account (Stores > Stores Nickname).

Example: "CS"
order_numberstring

Unique identifier for the order. If omitted, one will be generated automatically.

Example: "202402071641"
warehouse_namestringrequired

Warehouse name as listed in your ShipSaving account (Warehouses > Warehouses name).

Example: "WH"
verify_addressbooleanrequired

Indicates whether the recipient address should be verified.

Example: true
client_namestringrequired

Full name of the recipient.

Example: "full name"
client_companystring

Company name of the recipient (if applicable).

Example: "company name"
client_emailstring

Email address of the recipient.

Example: ""
client_phonestring

Phone number of the recipient. Required for international shipments.

Example: "1234567890"
client_streetstringrequired

Primary street address of the recipient.

Example: "123 street name"
client_street2string

Secondary address line, such as apartment or suite number.

Example: "apt 123"
client_citystringrequired

City of the recipient's address.

Example: "city"
client_statestringrequired

State or province of the recipient's address.

Example: "state"
client_zipstringrequired

ZIP or postal code of the recipient's address.

Example: "zipcode"
client_countrystring(country)required

2-letter code for origin country. This field’s value will be an ISO 3166-1 two-digit code.

Example: "US"
shipmentsArray of objectsrequired

List of shipment packages included in the order.

shipments[].​lengthnumber

Length of the package in inches.

Example: 6
shipments[].​widthnumber

Width of the package in inches.

Example: 6
shipments[].​heightnumber

Height of the package in inches.

Example: 3
shipments[].​weightnumber

Weight of the package in pounds.

Example: 0.4
shipments[].​signaturestring

Signature requirement for delivery.

Enum"NO_SIGNATURE""SIGNATURE""ADULT_SIGNATURE"
Example: "NO_SIGNATURE"
shipments[].​insurance_providerstring

Insurance provider for the shipment.

Enum"SHIPSURANCE""CARRIER."
Example: "SHIPSURANCE"
shipments[].​insurance_amountnumber

Value of insurance coverage in USD.

Example: 200
shipments[].​custom_print1string

Custom text to appear on the first line of the shipping label.

Example: "this is a custom print 1 field"
shipments[].​custom_print2string

Custom text to appear on the second line of the shipping label.

Example: "this is a custom print 2 field"
shipments[].​itemsArray of objects

List of individual items in the package.

shipments[].​notesArray of strings

Optional notes or instructions related to the shipment.

Example: ["note 1","note 2"]
curl -i -X POST \
  'https://api.shipsaving.com/api/orders/create?api_token=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "store_name": "CS",
    "order_number": "202402071641",
    "warehouse_name": "WH",
    "verify_address": true,
    "client_name": "full name",
    "client_company": "company name",
    "client_email": "",
    "client_phone": "1234567890",
    "client_street": "123 street name",
    "client_street2": "apt 123",
    "client_city": "city",
    "client_state": "state",
    "client_zip": "zipcode",
    "client_country": "US",
    "shipments": [
      {
        "length": 6,
        "width": 6,
        "height": 3,
        "weight": 0.4,
        "signature": "NO_SIGNATURE",
        "insurance_provider": "SHIPSURANCE",
        "insurance_amount": 200,
        "custom_print1": "this is a custom print 1 field",
        "custom_print2": "this is a custom print 2 field",
        "items": [
          {
            "sku": "2PCSFLCX-BLACK_PINK-S",
            "title": "2 t-shirts",
            "quantity": 1,
            "price": 20,
            "tax": 1.2,
            "shipping_cost": 10
          }
        ],
        "notes": [
          "note 1",
          "note 2"
        ]
      }
    ]
  }'

Responses

Order successfully created

Bodyapplication/json
order_numberstring

Order number

Response
application/json
{
  "order_number": "string"
}

Check Order Labels

Request

Retrieves the shipment label details for a specified store and order number. Applicable only to orders with a purchased shipping label.
Rate limit: 120 requests per minute.

Security
ApiTokenAuth
Query
store_namestringrequired

Store name in the ShipSaving system

order_numberstringrequired

Order number associated with the purchased label

curl -i -X GET \
  'https://api.shipsaving.com/api/shipments/get?store_name=string&order_number=string&api_token=YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/jsonArray [
packing_slip_numberinteger

Packing slip number

Example: 100108
carrierstring

Carrier's name

Example: "UPS"
predefined_packagestring

Carrier’s predefined packaging type

Example: ""
service_levelstring

Carrier service type

Example: "ups_ground"
tracking_codestring

Tracking number

Example: "1ZXXXXXXXXXXXXXXXX"
lengthnumber(float)

Package length (inch)

Example: 6
widthnumber(float)

Package width (inch)

Example: 6
heightnumber(float)

Package height (inch)

Example: 6
weightnumber(float)

Package weight (lb)

Example: 1
ratenumber(float)

Shipping rate

Example: 5.99
service_feenumber(float)

System service fee

Example: 0.05
label_widthnumber(float)

Label width (inch)

Example: 4
label_heightnumber(float)

Label height (inch)

Example: 6
label_urlsArray of strings

List of image URLs for shipping labels

Example: ["https://…/labels/2024-10-23/9524d5ac21a744a1954e16ebda769772_0.png"]
commercial_invoice_urlsArray of strings

List of image URLs for commercial invoices

Example: null
]
Response
application/json
[
  {
    "packing_slip_number": 100108,
    "carrier": "UPS",
    "predefined_package": "",
    "service_level": "ups_ground",
    "tracking_code": "1ZXXXXXXXXXXXXXXXX",
    "length": 6,
    "width": 6,
    "height": 6,
    "weight": 1,
    "rate": 5.99,
    "service_fee": 0.05,
    "label_width": 4,
    "label_height": 6,
    "label_urls": [ … ],
    "commercial_invoice_urls": null
  }
]

Delete an order

Request

Deletes an existing order from the ShipSaving system by specifying both the store name and order number. This action is irreversible and will permanently remove the order and its associated data.
Rate limit: 300 requests per minute.

Security
ApiTokenAuth
Bodyapplication/jsonrequired
store_namestringrequired

The store name associated with the order.

Example: "xxx 3C Store"
order_numberstringrequired

Unique identifier of the order to be deleted.

Example: "20240201125047532"
curl -i -X DELETE \
  'https://api.shipsaving.com/api/orders/delete?api_token=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "store_name": "xxx 3C Store",
    "order_number": "20240201125047532"
  }'

Responses

Order deleted successfully

Bodyapplication/jsonArray [
any
]
Response
application/json
[]

Address Verification

Operations

SCAN Form

Operations

Carrier Management

Operations

Account Management

Operations
Copyright © 2026 ShipSaving. All Rights Reserved.