These docs are for v1.0. Click to read the latest docs for v1.2.

Partner sessions

Example Payload

{
  "session": {
    "email": "[email protected]",
    "name": "Acme Inc.",
    "external_identifier": "3781876",
    "lifetime_in_seconds": 5,
    "single_use": true
  }
}
FieldDescription
emailThe email address of the customer.
nameThe name or company name of the customer for whom you are generating a session
external_identifierThe unique ID of the customer in your system. This ID will be used when reconciling shipping label purchases.
lifetime_in_secondsInteger

Length of time in seconds that the session token will stay active. The default is 900 seconds (15 minutes). Must be a value between 5 and 1800 seconds.
single_useBoolean

Default is false. When set to true the session token is expired immediately after its first use.

Signing requests

All ShippingEasy Partner API requests must be signed using a public API key and private API secret. Read more here: http://shippingeasy.readme.io/docs/authentication-signing-requests.

Language