Skip to content

ShipSaving New API (v2)

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

Authentication

Operations

Get Access Token

Request

Issue a short-lived access token using the OAuth 2.1 Client Credentials grant.

Provide:

  • Authorization: Basic base64(AppKey:AppSecret)
  • Content-Type: application/x-www-form-urlencoded
Security
basicAuth
Bodyapplication/x-www-form-urlencodedrequired
grant_typestringrequired

Must be client_credentials.

Value"client_credentials"
scopestring

Optional space-delimited scopes.

Example: "API"
curl -i -X POST \
  -u <username>:<password> \
  https://x-api.shipsaving.com/oauth2/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d grant_type=client_credentials \
  -d scope=API

Responses

Access token issued

Bodyapplication/json
access_tokenstring

JWT access token.

token_typestring
Example: "Bearer"
expires_ininteger(int32)

Expiration time in seconds (default 1800).

scopestring

Granted scopes (if returned).

Response
application/json
{ "access_token": "eyJraWQiOiIxIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJTU19MSVZFX3RoNXE5S0pUZTBrdllsM3pRSFFmU0Q3NW5ETGlZQ2s4dlowSSIsImF1ZCI6IlNTX0xJVkVfdGg1cTlLSlRlMGt2WWwzelFIUWZTRDc1bkRMaVlDazh2WjBJIiwibmJmIjoxNzU0MzU1MzM0LCJjb21wYW55X2lkIjoiMTgyMyIsInVzZXJfaWQiOiIyNDA3Iiwic2NvcGUiOlsiQVBJIl0sImlzX3ZhbGlkIjp0cnVlLCJpc3MiOiJodHRwczovL3gtYXBpLnNoaXBzYXZpbmcudXMiLCJleHAiOjE3NTQzNTcxMzQsImlhdCI6MTc1NDM1NTMzNCwidGVzdF9tb2RlbCI6ZmFsc2V9.CsOfJozZUmd5cFrSodxGuDH0xxRQjau_qKwyOuJBPWigJeZXeoB_FgOl7r2kDfVndrru7IkXw5XCEmePkTJ25nyTD7RiysInBOuU0a89mfj4czedC8qHIHU-EI1CfRopHan2dCHfSog5skNT6edAmQfSNndj6mV18Pr0AclnhEgIG-CsfYkxZXRITXeqFKqiLfbUt8A4YsqT9zhXHqqttk42rBNzSddgBcBkHNGdys-qltEPc7xB_NpV02tZbsfl-hcHbHZYt_ufT4u4BLy5g7p6bd4Tt2vgUbRrVx-umCWuT3dad5di2Loj9vs2boywSCQshM1Aj4Fxzg8Sk-GsBw", "scope": "API", "token_type": "Bearer", "expires_in": 1799 }

Shipment

Operations

Tracking

Operations

Pickup

Operations

Address Validation

Operations