Type alias ProofOfDeliveryQueryParams

ProofOfDeliveryQueryParams: {
    delivery_date: string;
    pofs_id?: string;
    shipper?: string;
    tracking_no?: string;
    trxn_id?: string;
}

Represents proof of delivery record list query parameters.

Type declaration

  • delivery_date: string

    The actual or expected delivery date associated with the Proof of Delivery / Tracking. Format is YYYY-MM-DD. Query multiple delivery dates in a string separated by a comma.

  • Optional pofs_id?: string

    The Proof of Delivery / Tracking unique identifier. Begins with pofs-

  • Optional shipper?: string

    Filter Proof of Delivery / Tracking by shipper. Values are 1 = USPS, 2 = FedEx, 3 = UPS, 4 = DHL, 5 = Other

  • Optional tracking_no?: string

    The shipper tracking number for the Proof of Delivery / Tracking

  • Optional trxn_id?: string

    Filter by unique transaction identifier associated with the Proof of Delivery / Tracking. Query multiple trxn_id's in a string separated by a comma.

Settings

Member Visibility

Theme

Generated using TypeDoc