Interface PartiallySupportedTrackingSubscriptionOptions

Additional options that may be ignored depending on which carrier the request is sent to.

interface PartiallySupportedTrackingSubscriptionOptions {
    from_name?: null | string;
    locale?: null | Locale;
    memo?: null | string;
    relation_to_shipment?: null | RelationToShipment;
    reply_to_address?: null | string;
    subject?: null | string;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

  • JsonObject
    • PartiallySupportedTrackingSubscriptionOptions

Indexable

Properties

from_name? locale? memo? relation_to_shipment? reply_to_address? subject?

Properties

Optionalfrom_name

from_name?: null | string

The name to show as the sender of notification emails.

Optionallocale

locale?: null | Locale

The language and dialect to send the email in

Optionalmemo

memo?: null | string

Text to add to email notification bodies

Optionalrelation_to_shipment

relation_to_shipment?: null | RelationToShipment

The subscriber's relation to the shipping of the package

Optionalreply_to_address

reply_to_address?: null | string

The email address to show as the sender of notification emails.

Warning

This may require special DNS settings to prevent the emails being marked as spoofed.

Only set this field if you know what you are doing.

Optionalsubject

subject?: null | string

The subject line to use on the notification emails

Settings

Member Visibility

On This Page

Properties