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.

POST

/api/orders/create

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

{
  "order_number": "string"
}