Interface FulfillmentOutboundApiModelPackageTrackingDetails

Tracking details of package

PackageTrackingDetails

interface FulfillmentOutboundApiModelPackageTrackingDetails {
    additionalLocationInfo?:
        | "AS_INSTRUCTED"
        | "CARPORT"
        | "CUSTOMER_PICKUP"
        | "DECK"
        | "DOOR_PERSON"
        | "FRONT_DESK"
        | "FRONT_DOOR"
        | "GARAGE"
        | "GUARD"
        | "MAIL_ROOM"
        | "MAIL_SLOT"
        | "MAILBOX"
        | "MC_BOY"
        | "MC_GIRL"
        | "MC_MAN"
        | "MC_WOMAN"
        | "NEIGHBOR"
        | "OFFICE"
        | "OUTBUILDING"
        | "PATIO"
        | "PORCH"
        | "REAR_DOOR"
        | "RECEPTIONIST"
        | "RECEIVER"
        | "SECURE_LOCATION"
        | "SIDE_DOOR"
        | FulfillmentOutboundApiModelAdditionalLocationInfo;
    carrierCode?: string;
    carrierPhoneNumber?: string;
    carrierURL?: string;
    currentStatus?: | "IN_TRANSIT"
    | "DELIVERED"
    | "UNKNOWN"
    | "RETURNING"
    | "RETURNED"
    | "UNDELIVERABLE"
    | "DELAYED"
    | "AVAILABLE_FOR_PICKUP"
    | "CUSTOMER_ACTION"
    | "OUT_FOR_DELIVERY"
    | "DELIVERY_ATTEMPTED"
    | "PICKUP_SUCCESSFUL"
    | "PICKUP_CANCELLED"
    | "PICKUP_ATTEMPTED"
    | "PICKUP_SCHEDULED"
    | "RETURN_REQUEST_ACCEPTED"
    | "REFUND_ISSUED"
    | "RETURN_RECEIVED_IN_FC"
    | FulfillmentOutboundApiModelCurrentStatus;
    currentStatusDescription?: string;
    customerTrackingLink?: string;
    estimatedArrivalDate?: string;
    packageNumber: number;
    shipDate?: string;
    shipToAddress?: FulfillmentOutboundApiModelTrackingAddress;
    signedForBy?: string;
    trackingEvents?: FulfillmentOutboundApiModelTrackingEvent[];
    trackingNumber?: string;
}

Properties

additionalLocationInfo?:
    | "AS_INSTRUCTED"
    | "CARPORT"
    | "CUSTOMER_PICKUP"
    | "DECK"
    | "DOOR_PERSON"
    | "FRONT_DESK"
    | "FRONT_DOOR"
    | "GARAGE"
    | "GUARD"
    | "MAIL_ROOM"
    | "MAIL_SLOT"
    | "MAILBOX"
    | "MC_BOY"
    | "MC_GIRL"
    | "MC_MAN"
    | "MC_WOMAN"
    | "NEIGHBOR"
    | "OFFICE"
    | "OUTBUILDING"
    | "PATIO"
    | "PORCH"
    | "REAR_DOOR"
    | "RECEPTIONIST"
    | "RECEIVER"
    | "SECURE_LOCATION"
    | "SIDE_DOOR"
    | FulfillmentOutboundApiModelAdditionalLocationInfo

PackageTrackingDetails

carrierCode?: string

The name of the carrier.

PackageTrackingDetails

carrierPhoneNumber?: string

The phone number of the carrier.

PackageTrackingDetails

carrierURL?: string

The URL of the carrier's website.

PackageTrackingDetails

currentStatus?:
    | "IN_TRANSIT"
    | "DELIVERED"
    | "UNKNOWN"
    | "RETURNING"
    | "RETURNED"
    | "UNDELIVERABLE"
    | "DELAYED"
    | "AVAILABLE_FOR_PICKUP"
    | "CUSTOMER_ACTION"
    | "OUT_FOR_DELIVERY"
    | "DELIVERY_ATTEMPTED"
    | "PICKUP_SUCCESSFUL"
    | "PICKUP_CANCELLED"
    | "PICKUP_ATTEMPTED"
    | "PICKUP_SCHEDULED"
    | "RETURN_REQUEST_ACCEPTED"
    | "REFUND_ISSUED"
    | "RETURN_RECEIVED_IN_FC"
    | FulfillmentOutboundApiModelCurrentStatus

PackageTrackingDetails

currentStatusDescription?: string

Description corresponding to the CurrentStatus value.

PackageTrackingDetails

customerTrackingLink?: string

Link on swiship.com that allows customers to track the package.

PackageTrackingDetails

estimatedArrivalDate?: string

Date timestamp

PackageTrackingDetails

packageNumber: number

The package identifier.

PackageTrackingDetails

shipDate?: string

Date timestamp

PackageTrackingDetails

PackageTrackingDetails

signedForBy?: string

The name of the person who signed for the package.

PackageTrackingDetails

An array of tracking event information.

PackageTrackingDetails

trackingNumber?: string

The tracking number for the package.

PackageTrackingDetails

MMNEPVFCICPMFPCPTTAAATR