v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Shipping Accounts

Update Account

Update the details of an existing shipping account. With this endpoint, you can modify various attributes of the shipping account, such as contact information, service options, and others. This helps maintain current and accurate information for effective shipping operations.

put/v4/shippingAccounts/rm/{shippingAccountId}

Path parameters

shippingAccountIdstring required

A unique identifier for the shipping account assigned by the system (ShippingAccountId) or by you (AccountAlias), allowing for efficient reference and management of individual accounts within the system.

Request body

AccountRegisteredEmailstring email required

The email address that was used to register the shipping account with Royal Mail when the account was created. This email serves as the primary contact point for communications related to the shipping account, including notifications, updates, and service alerts from Royal Mail.

RegisteredBillingPostcodestring nullable

The postcode associated with the billing address for the shipping account. This postcode is used by Royal Mail for sending invoices and other relevant billing communications related to the account.<br><br>Note: This field is mandatory only if the AccountType field is set to Production.

AccountNumberstring required

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

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.

Example request

{
  "AccountRegisteredEmail": "my.email@example.com",
  "RegisteredBillingPostcode": "TW20 0HJ",
  "AccountNumber": "9912347707",
  "AccountName": "AB VideoGames",
  "AccountAlias": "RM-99112347707",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789"
}

Response

The shipping account was updated successfully.