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

Evri Add Shipping Account Request

string
required
length between 1 and 10

The number assigned to the shipping account by the carrier, typically used for tracking shipments and billing purposes.

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

The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts.

Note: By default, this value is set to the customer name if not provided in the request.

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 linked to the customer account for Evri API. This is typically the login credential used by the customer to access their shipping account. The username is essential for authentication purposes, ensuring that only authorised users can manage shipments and account information.

string
required
length between 1 and 256

The password associated with your Evri API. It is essential for securing the account and ensuring that only authorised users have access to shipping details and operations.

string | null

A specific code associated with SMS notifications allocated by Evri. This code identifies the group or category of SMS alerts that the customer has opted to receive regarding their shipments. It allows them to receive timely updates about their shipments via SMS, improving communication and tracking efficiency for deliveries.

Note: This information is required if the SMS notification enhancement has been selected in the Create Shipment request.

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 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago

Did this page help you?