INintersoftsapient
Offline Barcoding

Get Barcode Range

Request a specific range of barcodes for use in your shipping processes. <br /> <br />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. <br /> <br />Note: Offline Barcoding is only available if it has been activated on your customer account in the GUI.

post/v4/offlineBarcodeNumberRange/rm

Request

  • Base URL
    https://api.intersoftsapient.net
  • URL
    https://api.intersoftsapient.net/v4/offlineBarcodeNumberRange/rm
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authentication.intersoftsapient.net/connect/token

Request body

ShippingLocationIdstring nullable

A unique identifier assigned by the system (shippingLocationId) or by you (alias) to the shipping location for which the shipment is being created. <br /> <br />Note: This field is mandatory if more than one shipping location is available for the shipping account.

ShippingAccountIdstring required

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

ServiceCodestring required

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

ServiceLevelstring required

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. <br /> <br />Note: If not provided, then by default, this field is set to the lowest service level for the specified service.

ServiceEnhancementCode'SIGNED'

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. <br /> <br />The valid value is: <br /> <br />Signed: A signature is required upon delivery, applicable to 24, 48, 1st Class, and 2nd Class services.

ChannelIdstring nullable

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.

Example request

{
  "ShippingLocationId": "Manchester Hub",
  "ShippingAccountId": "1234567890",
  "ServiceCode": "CRL1",
  "ServiceLevel": "01",
  "ChannelId": "1B"
}

Response

Returns the offline barcode ranges successfully.

Prefixstring nullable

The beginning segment of the barcode number. This prefix is assigned by Royal Mail and is essential for identifying the origin or type of the barcode.

BarcodeRangeStartstring nullable

The starting part of the requested range of barcode numbers. This value indicates the lowest barcode number that can be used in conjunction with the assigned Prefix and Suffix when generating barcodes for shipments.

BarcodeRangeEndstring nullable

The ending part of the requested barcode number range. This value specifies the highest barcode number that can be used in conjunction with the assigned Prefix, providing a clear limit for barcode generation.

Suffixstring nullable

A fixed value that is always 'GB'. This part of the barcode denotes the country code for UK, standardising the barcode format for efficiency and compliance within the shipping process.

ChannelIdstring nullable

The Channel ID that was sent in the request. If none was provided, this field will be populated with the default Channel ID assigned to the customer account in the system. This assures customers that the barcode range is associated with the correct channel for effective tracking and management.

Example response

[
  {
    "Prefix": "TT",
    "BarcodeRangeStart": "200001",
    "BarcodeRangeEnd": "209009",
    "Suffix": "GB",
    "ChannelId": "1B"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.