Creates an authentication token or returns an existing one.

To refresh your API token, make a POST request to the https://app.ship.com/public/refresh endpoint.

Request Headers

Header	Value
email	string
password	string

Request Parameters

Field	Type	Max Length	Required	Description
email	string	100	Yes	User's email address
password	string	-	Yes	User's password
firstName	string	50	Yes	User's first name
lastName	string	50	Yes	User's last name
phoneNumber	string	10	Yes	User's phone number
address1	string	50	Yes	Primary address line
address2	string	50	Yes	Secondary address line
city	string	50	Yes	City name
state	string	2	Yes	Two-letter state code
zip	string	5	Yes	Five-digit zip code

Request Example

1{
2    "email": "string",
3    "password": "string",
4    "firstName": "string",
5    "lastName": "string",
6    "phoneNumber": "string",
7    "address1": "string",
8    "city": "string",
9    "state": "string",
10    "zip": "string"
11}

Request Parameters

Field	Type	Description
success	boolean	Indicates if the request was successful
error	object	Contains error details if request failed
oauth	object	Contains OAuth error details if authentication failed

Successful Response Example

1{
2	"success": true,
3    "error": null,
4    "oauth": {
5    	"token": "string",
6        "refreshToken": "string",
7        "expires": "date"
8    }
9}

< Token Generation

Order List >

On this page

Token Refresh Request Headers Request Parameters Request Example Request Parameters Successful Response Example