@myparcel/sdk/lib/endpoints/private/track-traces/TrackTraces.types.d.ts

JavaScript SDK to connect to the MyParcel API via Node.js or browser

import { CarrierId } from '@myparcel/constants';
import { ShipmentOptions } from '../shipments';
import { Address, AddressWithContactDetails } from '../../../types';
import { PickupLocation } from '../../public';

export interface PartnerTrackTraceLink {
    barcode: string;
    uri: string;
}
export type ShipmentStatus = 'registered' | 'handed_to_carrier' | 'sorting' | 'distribution' | 'delivered';
export interface TrackAndTraceStatus {
    main: ShipmentStatus;
    final: boolean;
    current: number;
}
export interface TrackAndTraceLocation {
    name: string;
    countryCode: string;
    city: string;
    postalCode: string;
    street: string;
    number: string;
    numberSuffix: string;
    longitude: number;
    latitude: number;
}
export interface TrackTraceHistory {
    code: string;
    description: string;
    time: string;
    delayed: boolean;
    location: TrackAndTraceLocation;
}
export interface TrackAndTrace {
    shipment_id: number;
    carrier_id: CarrierId;
    code: string;
    description: string;
    time: string;
    link_consumer_portal: string;
    link_tracktrace: string;
    partner_tracktraces: PartnerTrackTraceLink[];
    recipient: AddressWithContactDetails;
    sender: Address;
    options: ShipmentOptions;
    pickup: PickupLocation | null;
    delayed: boolean;
    location: TrackAndTraceLocation | null;
    status: TrackAndTraceStatus;
    history: TrackTraceHistory[];
}