API References

Add Account

post
https://api.intersoftsapient.net/v4/shippingAccounts/evri

Add a shipping account for Evri and link it with an existing shipping location.
Ensure to have required carrier details ready like Evri account number so that you can use the account for shipping with Evri.

Body Params

Add Shipping Account Request

string
required
length between 1 and 10

Carrier Account Number
The account number given by the carrier.
The Client ID allocated by Evri.

string
enum
required

Indicates whether the account is set up as a "sandbox" or "production" account. A Sandbox account is for testing and development, while a Production account is used for live shipments and transactions.

Allowed:
string | null

Account Name
The name on this Account.
Enter the Client Name allocated by Evri.
Defaults to your Customer name if not provided.

string
required
length between 1 and 30

A unique, user-defined name for the shipping account, providing a convenient way to reference the account in a more memorable manner.

string
required
length between 1 and 100

The name of the primary contact person for the shipping account, facilitating communication regarding shipping and account-related matters.

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact name, if provided.

string
required
length between 1 and 20

The phone number associated with the shipping account's primary contact person, facilitating communication regarding shipping inquiries, account management, and issue resolution.

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact phone number, if provided. Characters like +, /, -, or space are supported.

string
required
length between 1 and 256

The username used for the Evri API.

string
required
length between 1 and 256

The password used for the Evri API.

string | null

The alert group code that is allocated by Evri. Required if you use the SMS notification enhancement.

ShippingLocations
array of objects
required

An object that allows the customer to specify the shipping location(s) that will be associated with the new shipping account. Within this object, the customer can either link the existing shipping location(s) or add a new one.

Note: While adding a shipping account, make sure to provide at least one shipping location.If you are providing a new shipping location, then only one location can be added.

ShippingLocations*
Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated about 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago