Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Update Account

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

put/v4/shippingAccounts/evri/{shippingAccountId}

Path parameters

shippingAccountIdstring required

Shipping Account Identifier <br />SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).

Request body

AccountNumberstring required

Carrier Account Number <br />The Client ID allocated by Evri.

AccountType'Sandbox' | 'Production' 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.

AccountNamestring required

Account Name <br />The name on this Account. <br />The Client Name allocated by Evri.

AccountAliasstring required

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

ContactNamestring required

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

ContactNumberstring tel required

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

Usernamestring required

The username used for the Evri API.

Passwordstring required

The password used for the Evri API.

SmsAlertGroupCodestring nullable

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

Example request

{
  "AccountNumber": "9912347707",
  "AccountName": "AB VideoGames",
  "AccountAlias": "RM-99112347707",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789",
  "Username": "username",
  "Password": "password",
  "SmsAlertGroupCode": "1234"
}

Response

The shipping account was updated successfully.