Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Get Accounts

Retrieves a list of Royal Mail shipping accounts created on your customer account. With this endpoint, you can view and manage multiple shipping accounts by using various query parameters for filtering, pagination, and sorting the list of accounts, making it easier for users to find specific accounts.

get/v4/shippingAccounts/rm

Query parameters

searchTermstring

A string representing the term or keywords used to filter shipping accounts. This can be an account name or identifier that you are interested in to narrow down the list based on the input.

pageSizeinteger

An integer that defines the number of account entries (records) returned per page in the response. For instance, if pageSize is set to 20, the API will return up to 20 accounts in each response. <br /> <br />Note: By default, this value is set to 100.

pageNumberinteger

An integer indicating the specific page of results to retrieve, allowing for pagination of larger datasets. For example, if pageNumber is set to 3, the API will return the results corresponding to the third page of accounts based on the specified pageSize. <br /> <br />Note: By default, this value is set to 1.

sortBy'Name' | 'Alias' | 'LastModified' | 'CarrierAccountNumber'

Sort By

A string specifying the field by which to organise the search results. For instance, "Name" could be used to sort accounts alphabetically, arranging the results in a more user-friendly order. <br /> <br />Note: By default, this value is set to Name.

sortDir'Ascending' | 'Descending'

Order Direction

A string indicating the direction in which to sort the results, typically set to "ascending" or "descending." For example, setting sortDir to "Ascending" while using "Name" as sortBy would arrange the locations from A to Z. <br /> <br />Note: By default, this value is set to Ascending.

Response

Returns a paged list of shipping accounts for the given carrier.

TotalCountinteger required

An integer representing the total number of shipping accounts that match the query parameters sent in the request, giving users a quick overview of how many accounts are linked to their operations.

Example response

{
  "ShippingAccounts": [
    {
      "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"
    }
  ],
  "TotalCount": 303
}