@pfantato/printful-ts/lib/schemas/endpoints/orders/list-order-shipments.schema.d.ts

Typescript SDK to integrate with Printful

import { z } from 'zod';
export declare const ListOrderShipmentsSearchParams: z.ZodObject<z.objectUtil.extendShape<{
    limit: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
    offset: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
}, {
    store_id: z.ZodOptional<z.ZodNumber>;
}>, z.UnknownKeysParam, z.ZodTypeAny, {
    offset?: number;
    limit?: number;
    store_id?: number;
}, {
    offset?: number;
    limit?: number;
    store_id?: number;
}>;
export type ListOrderShipmentsSearchParams = z.infer<typeof ListOrderShipmentsSearchParams>;
export declare const ListOrderShipmentsResponse: z.ZodObject<{
    data: z.ZodArray<z.ZodObject<{
        id: z.ZodNumber;
        order_id: z.ZodNumber;
        carrier: z.ZodNullable<z.ZodString>;
        shipment_status: z.ZodEnum<["pending", "onhold", "canceled", "packaged", "shipped", "returned", "outstock"]>;
        shipped_at: z.ZodNullable<z.ZodString>;
        delivery_status: z.ZodEnum<["unknown", "delivered", "pre_transit", "in_transit", "out_for_delivery", "available_for_pickup", "return_to_sender", "failure", "canceled"]>;
        delivery_at: z.ZodNullable<z.ZodString>;
        departure_addess: z.ZodObject<{
            country_name: z.ZodString;
            country_code: z.ZodString;
            state_code: z.ZodNullable<z.ZodString>;
        }, "strip", z.ZodTypeAny, {
            state_code?: string;
            country_code?: string;
            country_name?: string;
        }, {
            state_code?: string;
            country_code?: string;
            country_name?: string;
        }>;
        is_reshipment: z.ZodBoolean;
        tracking_url: z.ZodNullable<z.ZodString>;
        tracking_events: z.ZodArray<z.ZodObject<{
            triggered_at: z.ZodString;
            description: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            description?: string;
            triggered_at?: string;
        }, {
            description?: string;
            triggered_at?: string;
        }>, "many">;
        shipment_items: z.ZodArray<z.ZodObject<{
            id: z.ZodNumber;
            order_item_id: z.ZodNumber;
            order_item_external_id: z.ZodNullable<z.ZodString>;
            order_item_name: z.ZodNullable<z.ZodString>;
            quantity: z.ZodNumber;
            _links: z.ZodObject<{
                order_item: z.ZodObject<{
                    href: z.ZodString;
                }, "strip", z.ZodTypeAny, {
                    href?: string;
                }, {
                    href?: string;
                }>;
            }, "strip", z.ZodTypeAny, {
                order_item?: {
                    href?: string;
                };
            }, {
                order_item?: {
                    href?: string;
                };
            }>;
        }, "strip", z.ZodTypeAny, {
            id?: number;
            _links?: {
                order_item?: {
                    href?: string;
                };
            };
            quantity?: number;
            order_item_id?: number;
            order_item_external_id?: string;
            order_item_name?: string;
        }, {
            id?: number;
            _links?: {
                order_item?: {
                    href?: string;
                };
            };
            quantity?: number;
            order_item_id?: number;
            order_item_external_id?: string;
            order_item_name?: string;
        }>, "many">;
        _links: z.ZodObject<{
            self: z.ZodObject<{
                href: z.ZodString;
            }, "strip", z.ZodTypeAny, {
                href?: string;
            }, {
                href?: string;
            }>;
            order: z.ZodObject<{
                href: z.ZodString;
            }, "strip", z.ZodTypeAny, {
                href?: string;
            }, {
                href?: string;
            }>;
        }, "strip", z.ZodTypeAny, {
            self?: {
                href?: string;
            };
            order?: {
                href?: string;
            };
        }, {
            self?: {
                href?: string;
            };
            order?: {
                href?: string;
            };
        }>;
    }, "strip", z.ZodTypeAny, {
        id?: number;
        _links?: {
            self?: {
                href?: string;
            };
            order?: {
                href?: string;
            };
        };
        order_id?: number;
        carrier?: string;
        shipment_status?: "pending" | "canceled" | "onhold" | "packaged" | "shipped" | "returned" | "outstock";
        shipped_at?: string;
        delivery_status?: "unknown" | "canceled" | "delivered" | "pre_transit" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "return_to_sender" | "failure";
        delivery_at?: string;
        departure_addess?: {
            state_code?: string;
            country_code?: string;
            country_name?: string;
        };
        is_reshipment?: boolean;
        tracking_url?: string;
        tracking_events?: {
            description?: string;
            triggered_at?: string;
        }[];
        shipment_items?: {
            id?: number;
            _links?: {
                order_item?: {
                    href?: string;
                };
            };
            quantity?: number;
            order_item_id?: number;
            order_item_external_id?: string;
            order_item_name?: string;
        }[];
    }, {
        id?: number;
        _links?: {
            self?: {
                href?: string;
            };
            order?: {
                href?: string;
            };
        };
        order_id?: number;
        carrier?: string;
        shipment_status?: "pending" | "canceled" | "onhold" | "packaged" | "shipped" | "returned" | "outstock";
        shipped_at?: string;
        delivery_status?: "unknown" | "canceled" | "delivered" | "pre_transit" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "return_to_sender" | "failure";
        delivery_at?: string;
        departure_addess?: {
            state_code?: string;
            country_code?: string;
            country_name?: string;
        };
        is_reshipment?: boolean;
        tracking_url?: string;
        tracking_events?: {
            description?: string;
            triggered_at?: string;
        }[];
        shipment_items?: {
            id?: number;
            _links?: {
                order_item?: {
                    href?: string;
                };
            };
            quantity?: number;
            order_item_id?: number;
            order_item_external_id?: string;
            order_item_name?: string;
        }[];
    }>, "many">;
    paging: z.ZodObject<{
        total: z.ZodNumber;
        offset: z.ZodDefault<z.ZodNumber>;
        limit: z.ZodDefault<z.ZodNumber>;
    }, "strip", z.ZodTypeAny, {
        total?: number;
        offset?: number;
        limit?: number;
    }, {
        total?: number;
        offset?: number;
        limit?: number;
    }>;
    _links: z.ZodObject<{
        self: z.ZodObject<{
            href: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            href?: string;
        }, {
            href?: string;
        }>;
        first: z.ZodObject<{
            href: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            href?: string;
        }, {
            href?: string;
        }>;
        last: z.ZodObject<{
            href: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            href?: string;
        }, {
            href?: string;
        }>;
        next: z.ZodOptional<z.ZodObject<{
            href: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            href?: string;
        }, {
            href?: string;
        }>>;
        previous: z.ZodOptional<z.ZodObject<{
            href: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            href?: string;
        }, {
            href?: string;
        }>>;
    }, "strip", z.ZodTypeAny, {
        self?: {
            href?: string;
        };
        first?: {
            href?: string;
        };
        last?: {
            href?: string;
        };
        next?: {
            href?: string;
        };
        previous?: {
            href?: string;
        };
    }, {
        self?: {
            href?: string;
        };
        first?: {
            href?: string;
        };
        last?: {
            href?: string;
        };
        next?: {
            href?: string;
        };
        previous?: {
            href?: string;
        };
    }>;
}, "strip", z.ZodTypeAny, {
    _links?: {
        self?: {
            href?: string;
        };
        first?: {
            href?: string;
        };
        last?: {
            href?: string;
        };
        next?: {
            href?: string;
        };
        previous?: {
            href?: string;
        };
    };
    data?: {
        id?: number;
        _links?: {
            self?: {
                href?: string;
            };
            order?: {
                href?: string;
            };
        };
        order_id?: number;
        carrier?: string;
        shipment_status?: "pending" | "canceled" | "onhold" | "packaged" | "shipped" | "returned" | "outstock";
        shipped_at?: string;
        delivery_status?: "unknown" | "canceled" | "delivered" | "pre_transit" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "return_to_sender" | "failure";
        delivery_at?: string;
        departure_addess?: {
            state_code?: string;
            country_code?: string;
            country_name?: string;
        };
        is_reshipment?: boolean;
        tracking_url?: string;
        tracking_events?: {
            description?: string;
            triggered_at?: string;
        }[];
        shipment_items?: {
            id?: number;
            _links?: {
                order_item?: {
                    href?: string;
                };
            };
            quantity?: number;
            order_item_id?: number;
            order_item_external_id?: string;
            order_item_name?: string;
        }[];
    }[];
    paging?: {
        total?: number;
        offset?: number;
        limit?: number;
    };
}, {
    _links?: {
        self?: {
            href?: string;
        };
        first?: {
            href?: string;
        };
        last?: {
            href?: string;
        };
        next?: {
            href?: string;
        };
        previous?: {
            href?: string;
        };
    };
    data?: {
        id?: number;
        _links?: {
            self?: {
                href?: string;
            };
            order?: {
                href?: string;
            };
        };
        order_id?: number;
        carrier?: string;
        shipment_status?: "pending" | "canceled" | "onhold" | "packaged" | "shipped" | "returned" | "outstock";
        shipped_at?: string;
        delivery_status?: "unknown" | "canceled" | "delivered" | "pre_transit" | "in_transit" | "out_for_delivery" | "available_for_pickup" | "return_to_sender" | "failure";
        delivery_at?: string;
        departure_addess?: {
            state_code?: string;
            country_code?: string;
            country_name?: string;
        };
        is_reshipment?: boolean;
        tracking_url?: string;
        tracking_events?: {
            description?: string;
            triggered_at?: string;
        }[];
        shipment_items?: {
            id?: number;
            _links?: {
                order_item?: {
                    href?: string;
                };
            };
            quantity?: number;
            order_item_id?: number;
            order_item_external_id?: string;
            order_item_name?: string;
        }[];
    }[];
    paging?: {
        total?: number;
        offset?: number;
        limit?: number;
    };
}>;
export type ListOrderShipmentsResponse = z.infer<typeof ListOrderShipmentsResponse>;