On-Behalf-Of Account Access

Using your Partner API key, you may make a request on behalf of an authorized ShipStation or ShipEngine user.

You may access any endpoint the same way as you normally would, just add the On-Behalf-Of header with the account API Key.

Example

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
4
GET /v1/environment/whoami HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
On-Behalf-Of: __CUSTOMER_API_KEY_HERE__

1
2
3
4
5
6
{
  "data": {
    "username": "1172793"
  },
  "request_id": "d0f79270-bd60-4e9d-8183-a4cee193036e"
}