Sign in
Authorization

Retrieve an Access Token

Retrieve an OAuth 2 Access Token.

There are two ways of accessing the child companies:

  1. Client Credentials Grant with a enterprise.child_company::access scope and a custom header X_EASYSHIP_COMPANY_ID in each request to our Public API.
  2. A custom Delegated Account Grant, that will generate access and refresh tokens associated with a specific child company defined in the easyship_company_id.
post/oauth2/token

Request body

OR
OR

Response

Access and Refresh Tokens from Delegated Account grant

access_tokenstring

OAuth 2 Access Token

token_type'Bearer'

OAuth 2 Token Type

expires_ininteger

OAuth 2 Access Token Expiration Time in Seconds

scopeScope — unresolved $ref
created_atinteger

OAuth 2 Access Token Creation Time

refresh_tokenstring nullable

OAuth 2 Refresh Token. Available only for Authorization Code Grant Type.

Changes