Hey! These docs are for version 1.1, which is no longer officially supported. Click here for the latest version, 1.2!

Partner sessions

Example Payload

{
  "session": {
    "email": "[email protected]",
    "name": "Acme Inc.",
    "first_name": "John",
    "last_name": "Doe",
    "external_identifier": "3781876",
    "lifetime_in_seconds": 5,
    "single_use": true
  }
}

Field

Description

email

The email address of the customer.

name

The company name of the customer for whom you are generating a session

external_identifier

The unique ID of the customer in your system. This ID will be used when reconciling shipping label purchases.

lifetime_in_seconds

Integer

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_use

Boolean

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

first_name

First name of the merchant or customer for whom you are generating a session.

This field is required if you want EasyShip to offer an option for insuring the shipment.

last_name

Last name of the merchant or customer for whom you are generating a session.

This field is required if you want EasyShip to offer an option for insuring the shipment.

webhook_url

optional

Typically your webhook URL is configured on your partner account and is static. However, if you have a need for dynamic webhook URL's that vary based on your customer, you may specify an override that will only be used for the shipment associated with this session token.

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