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/yodel/{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 account number given by the carrier.

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

The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts. <br /> <br />Note: By default, this value is set to the customer name if not provided in the request.

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.

ContractNumberstring required

The Yodel contract number.

ScheduleNumberstring required

The Yodel contracted schedule number.

Example request

{
  "AccountNumber": "9912347707",
  "AccountName": "AB VideoGames",
  "AccountAlias": "RM-99112347707",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789",
  "ContractNumber": "1511116",
  "ScheduleNumber": "0001"
}

Response

The shipping account was updated successfully.