shipstation-client
Version:
ShipStation V2 SDK
26 lines (18 loc) • 1.71 kB
Markdown
# LabelMessages
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier. |Carrier |Max lines |Max line length |-------------------|----------|-------------------- |USPS (Stamps.com) |3 |60 |FedEx |3 |35 for the first line. 30 for additional lines. |UPS |2 |35 |OnTrac |2 |25
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reference1** | **string** | The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. | [default to undefined]
**reference2** | **string** | The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. | [default to undefined]
**reference3** | **string** | The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. | [default to undefined]
## Example
```typescript
import { LabelMessages } from 'shipstation-client';
const instance: LabelMessages = {
reference1,
reference2,
reference3,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)