API References

Update Account

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

Update shipping account details.
Note: All required fields must be populated in the request, regardless if they need updating or not.

Path Params
string
required

Shipping Account Identifier
SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).

Body Params

Shipping Account Details

Evri Update Shipping Account Request

string
required
length between 1 and 10

Carrier Account Number
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
required
length between 1 and 32

Account Name
The name on this Account.
The Client Name allocated by Evri.

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.

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.

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.

Responses
200

The shipping account was updated successfully.

401

Unauthorized

403

Forbidden

404

The shipping account was not found.

500

Internal Server Error

Updated 22 days ago

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

Updated 22 days ago