API References

Add Account

post
https://api.intersoftsapient.net/v4/shippingAccounts/rm

Add a shipping account for Royal Mail and either link it with an existing shipping location or add a new shipping location that will be associated with the shipping account.


Note: Before adding a shipping account with Royal Mail, ensure to have the required carrier details, such as the Royal Mail account number, posting location, OBA access code, and receiving hub, so that you can seamlessly use the account for shipping with Royal Mail.

Body Params

Add Shipping Account Request

Royal Mail Add Shipping Account Request

string
required
length between 10 and 10

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

string
enum
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.

Allowed:
string | null

The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts.

Note: By default, this value is set to the customer name if not provided in the request.

string
required
length between 1 and 256

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

string
required
length between 1 and 30

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

string | null

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.

Note: This field is mandatory only if the AccountType field is set to Production.

string
required
length between 1 and 100

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

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact name, if provided.

string
required
length between 1 and 20

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

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact phone number, if provided. Characters like +, /, -, or space are supported.

ShippingLocations
array of objects
required

An object that allows the customer to specify the shipping location(s) that will be associated with the new shipping account. Within this object, the customer can either link the existing shipping location(s) or add a new one.

Note: While adding a shipping account, make sure to provide at least one shipping location.If you are providing a new shipping location, then only one location can be added.

ShippingLocations*
Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 12 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 12 days ago

Did this page help you?