API Reference

Pre Allocate Tracking Number

post
https://api.proshipping.net/v4/shipments/preallocateTrackingNumber/rm

This service can be used to 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 from this service.
This service can only be used for services that are assigned a tracking number.
This service must be used in conjunction with CreateShipment service populating the TrackingNumber in the CarrierSpecifics /PreAllocatedBarcode section with the pre-allocated TrackingNumber returned in this service response.

Body Params

The request.

string | null

Shipping Location the shipment is being shipped from. This can be populated with either the Shipping Location ID assigned by PRO SHIPPING or the Shipping Location Alias set when the Shipping Location was created. Both can be viewed in the Shipping Location GUI.
Mandatory if there is more than one Shipping Location available for the Shipping Account

string
required
length between 1 and 36

Shipping Account the shipment is being created for. This can be populated with either the Shipping Account ID assigned by PRO SHIPPING Shipping Account ID or the Shipping Account Alias set when the Shipping Account was created.Both can be viewed in the Shipping Account GUI.

string
required
length between 3 and 4

The code of the shipping service used to deliver the shipment.

string | null

The Royal Mail service level of the service specified in the ServiceCode field.
Valid values are 01-99.
Defaults to lowest service level available for the specified service if not provided.

string
enum

Enhancement code of the service enhancement. Valid value is:
Signed - a signature is required on delivery of the shipment. Can be used with 24, 48, 1st Class and 2nd Class services.

Allowed:
Destination
object

Destination Details

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated about 1 year ago

Language
Credentials
OAuth2
Response 
 Choose an example:
application/json
Updated about 1 year ago