Get Barcode Range

post

https://api.intersoftsapient.net/v4/offlineBarcodeNumberRange/rm

Request a specific range of barcodes for use in your shipping processes.

You can use this endpoint to create your own number ranges and use them for generating the tracking numbers provided for offline barcoding shipments. This means that you do not need to integrate with the Royal Mail system to generate the barcode ranges.

Note: Offline Barcoding is only available if it has been activated on your customer account in the GUI.

Body Params

The request.

Royal Mail Get Offline Barcoding Request

ShippingLocationId

string | null

A unique identifier assigned by the system (shippingLocationId) or by you (alias) to the shipping location for which the shipment is being created.

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 shipment is being created.

ServiceCode

string

required

length between 3 and 4

A valid unique code identifying the service for which the number range is being requested.

ServiceLevel

string

required

length between 2 and 2

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

This field indicates the Royal Mail service level associated with the service specified in the ServiceCode field. Valid values range from 01 to 99. This parameter helps define the expected delivery speed and service quality for the shipment.

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

ServiceEnhancementCode

string

enum

This object specifies the particular enhancement code for the number range, 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:

ChannelId

string | null

The identifier agreed upon with Royal Mail for the use of offline barcodes. If a value is not included in the request, the ChannelId assigned in the SAPIENT system will be used. This ID helps designate the specific channel through which the barcodes are issued, ensuring proper tracking and compliance with Royal Mail's guidelines.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Returns the offline barcode ranges successfully.