Create Label

post

https://rps-sandbox.speedx.io/rps-api/label/create-label

Environments

Environment	URL
Sandbox	https://rps-sandbox.speedx.io/rps-api/label/create-label
Production	https://rps.speedx.io/rps-api/label/create-label

Notes

Fields marked as Required are essential for certain services. Ensure the correct fields are included by checking the "Required" column in each section.
Many field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.

Response Code

Code	Category	Description
200	SUCCESS	Success
401	ERROR	Unauthorized
404	ERROR	Not found
500	ERROR	Operation error
600	ERROR	JSON error
601	ERROR	Parameter error
602	ERROR	Address error
603	ERROR	Account disabled
604	ERROR	Account config error
605	ERROR	System config errorWeight error
606	ERROR	Weight error
607	ERROR	Dimension error
608	ERROR	Account balance error
609	ERROR	No access
610	ERROR	Label status error
611	ERROR	Label not found

Body Params

pickUpAccountNum

string

required

The designated pickup account for each injection point. Contact Account Manager for account details.

courierCode

string

required

Product code assigned by Account Manager.

portOfEntry

string

required

The IATA airport code.
AUTO -> System automatically select the port of entry by the account

weight

double

required

The weight of the package.
Min: 0.001
Max: 99999.999

weightUom

string

enum

required

The weight unit.

Allowed:

length

string

required

The length of the package.
Min: 0.01
Max: 999.99

width

string

required

The width of the package.
Min: 0.01
Max: 999.99

height

string

required

The height of the package.
Min: 0.01
Max: 999.99

dimensionUom

string

enum

required

The dimensional unit of measurement.

Allowed:

validateAddress

boolean

Specify whether validate the recipient address

customerRefId

string

If the provided customer reference ID is already associated with a label, the system will return the existing label instead of generating a new one. To create a new label with a previously used customer reference ID, you must first cancel the original label. Do not use a fixed value for the customer reference ID, as this will always result in the same label being returned.
Max length: 50

recipient

object

required

Specify the recipient address.
Accepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
All other characters are replaced with spaces.

returnAddress

object

Specify the return address. If the return needs to be sent back to a specified location, this field is required.
Accepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
All other characters are replaced with spaces.

fromAddress

object

Ship from address

customizedInfoForm

object

Provide customized information

commodityForms

object

Provide Commodity Information.

parcelType

string

Package type

itemType

string

Valid Values:
01 - Wine
02 - Beer
03 - Spirits
04 - Vape
05 - Smoke & Cigarettes
06 - Cannabis
07 - LIBA
08 - Food Products
10 - LIBA PI 970
11 - LIBA PI 967

This may introduce (Adult) signature confirmation service and ID confirmation service.

totalDeclareValue

double

required

The total value of the parcel
Decimal(5,2)

totalDeclareCurrency

string

required

The currency of the total value.
Example: USD

signature

boolean

Enable the Signature Confirmation Value Added Service

adultSignature

boolean

Enable the Adult Signature Confirmation Value Added Service

trackingNumber

string

The customer can generate and provide an SPX-compliant tracking number, which should correspond to the barcode value on the label.

features

object

Special features such as Value Added Services

labelSettingForm

object

Label Format Settings

recipientLocationId

string

The ID of the destination PUDO point for last-mile delivery. If a valid and active PUDO ID is provided, the parcel will be delivered to the specified PUDO point. If omitted, the parcel will be delivered to the recipient’s address.

Headers

api-key

string

required

API key

Response

Environments

Notes

Response Code

200