API References

Get Barcode Range

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

Get barcode ranges for offline barcoding.
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

string | null

This can be populated with either the Shipping Location ID assigned by SAPIENT or the Shipping Location Alias set when the Shipping Location was created. Optional if the shipping account only has one Shipping Location assigned. If the Shipping Account has multiple Shipping Locations, then this field must be populated.

string
required
length between 1 and 36

Shipping Account the number range is being requested for. This can be populated with either the Shipping Account ID assigned by SAPIENT or the Shipping Account Alias set when the Shipping Account was created.

string
required
length between 3 and 4

Service Code

string
required
length between 2 and 2

The Royal Mail service level of the service specified in the ServiceCode field.
Valid values are 01-99.

string
enum

The only valid values are Signed or null.
Signed - a signature is required on delivery of the shipment. Can be used with 24, 48, 1st Class and 2nd Class services.

Allowed:
string | null

The Channel ID agreed with Royal Mail for the offline barcodes. If no value is sent in the request then the Channel ID assigned in SAPIENT will be used.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 2 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 days ago