Pre Allocate Tracking Number

post

https://api.intersoftsapient.net/v4/shipments/preallocateTrackingNumber/rm

Receive a Royal Mail Tracking Number that will be pre-allocated to the service and destination supplied in the request. No shipment or label will be produced using this endpoint.

This service can be used in conjunction with the Create Shipment endpoint by specifying the TrackingNumber in the CarrierSpecifics or OfflineBarcodes section with the pre-allocated TrackingNumber returned in this service response.

Note: This endpoint can only be used for services that are assigned a tracking number.

Body Params

The request.

Royal Mail Get Pre Allocated Tracking Number Request

ShippingLocationId

string | null

A unique identifier assigned by the system (shippingLocationId) or by you (alias) to the shipping location for which the tracking number is being pre-allocated.

Note: This field is mandatory if more than one shipping location is available for the shipping account.

ShippingAccountId

string

required

length between 1 and 36

A unique identifier assigned by the system (shippingAccountId) or by you (alias) to the shipping account for which the tracking number is being pre-allocated.

ServiceCode

string

required

length between 3 and 4

A valid unique code identifying the service selected for the shipment's delivery and collection, which determines pricing, delivery speed, and other service attributes.

ServiceLevel

string | null

^(?!00)[0-9]{2}$

The Royal Mail service level of the service specified in the ServiceCode field. Valid values range from 0-99.

Note: If the service level is not specified, then by default, this field is set to the lowest service level available for the specified service.

ServiceEnhancementCode

string

enum

This object specifies the particular enhancement code for the tracking number, allowing customers to add the enhancements that can modify the shipping experience according to their preferences.

The valid value is:

Signed: A signature is required upon delivery, applicable to 24, 48, 1st Class, and 2nd Class services.

Allowed:

Destination

object

The address of the receiver's location, containing country and post code details.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Returns the pre allocated tracking number successfully.