Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Get Account

Retrieves details of a specific Royal Mail shipping account created on your customer account. With this endpoint, you can access relevant details of that shipping account. This is useful for managing individual shipping accounts or verifying specific account attributes.

get/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.

Response

Returns the shipping account.

ShippingAccountIdstring uuid required

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

CarrierCodestring required

A unique identifier for the carrier associated with the shipping account. This code is typically alphanumeric and helps in identifying the specific carrier linked to the shipping account.

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.

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.

AccountAliasstring required

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

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.

AccountStatusstring required

The current status of the shipping account, which could denote whether it is enabled, disabled, or confirmed, helping users understand the account's usability.

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.

LastUpdatedBystring required

The identifier (such as a username or system account) of the individual or system that last modified the shipping account information, ensuring accountability.

LastUpdatedDateUtcstring date-time required

A timestamp indicating the last time the shipping account details were updated, formatted in Coordinated Universal Time (UTC).

Example response

{
  "CarrierCode": "RM",
  "AccountNumber": "0123456789",
  "AccountName": "AB VideoGames",
  "AccountRegisteredEmail": "my.email@example.com",
  "AccountAlias": "JSL",
  "RegisteredBillingPostcode": "TW20 0HJ",
  "AccountStatus": "Enabled",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789",
  "LastUpdatedBy": "User A"
}