shipstation-client/dist/models/label-package.d.ts

ShipStation V2 SDK

/**
 * ShipStation API v2
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 2.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Dimensions } from './dimensions';
import type { LabelDownload } from './label-download';
import type { LabelMessages } from './label-messages';
import type { MonetaryValue } from './monetary-value';
import type { OptionalLink } from './optional-link';
import type { PaperlessDownload } from './paperless-download';
import type { Weight } from './weight';
/**
 * A package returned in the response from creating a [shipping label]
 * @export
 * @interface LabelPackage
 */
export interface LabelPackage {
    /**
     * The shipment package id
     * @type {number}
     * @memberof LabelPackage
     */
    'package_id'?: number;
    /**
     * The [package type], such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc.  The code `package` indicates a custom or unknown package type.
     * @type {string}
     * @memberof LabelPackage
     */
    'package_code'?: string;
    /**
     * The package weight
     * @type {Weight}
     * @memberof LabelPackage
     */
    'weight': Weight;
    /**
     * The package dimensions
     * @type {Dimensions}
     * @memberof LabelPackage
     */
    'dimensions'?: Dimensions;
    /**
     * The insured value of the package.  Requires the `insurance_provider` field of the shipment to be set.
     * @type {MonetaryValue}
     * @memberof LabelPackage
     */
    'insured_value'?: MonetaryValue;
    /**
     * The tracking number for the package.  The format depends on the carrier.
     * @type {string}
     * @memberof LabelPackage
     */
    'tracking_number'?: string;
    /**
     * The label download for the package
     * @type {LabelDownload}
     * @memberof LabelPackage
     */
    'label_download'?: LabelDownload;
    /**
     * The form download for any customs that are needed
     * @type {OptionalLink}
     * @memberof LabelPackage
     */
    'form_download'?: OptionalLink;
    /**
     * The QR code download for the package
     * @type {OptionalLink}
     * @memberof LabelPackage
     */
    'qr_code_download'?: OptionalLink;
    /**
     * The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.
     * @type {PaperlessDownload}
     * @memberof LabelPackage
     */
    'paperless_download'?: PaperlessDownload;
    /**
     *
     * @type {LabelMessages}
     * @memberof LabelPackage
     */
    'label_messages'?: LabelMessages;
    /**
     * An external package id.
     * @type {string}
     * @memberof LabelPackage
     */
    'external_package_id'?: string;
    /**
     * A short description of the package content. Required for shipments moving to, from, and through Mexico.
     * @type {string}
     * @memberof LabelPackage
     */
    'content_description'?: string | null;
    /**
     * Package sequence
     * @type {number}
     * @memberof LabelPackage
     */
    'sequence'?: number;
    /**
     * Whether the package has label documents available for download
     * @type {boolean}
     * @memberof LabelPackage
     */
    'has_label_documents'?: boolean;
    /**
     * Whether the package has form documents available for download
     * @type {boolean}
     * @memberof LabelPackage
     */
    'has_form_documents'?: boolean;
    /**
     * Whether the package has QR code documents available for download
     * @type {boolean}
     * @memberof LabelPackage
     */
    'has_qr_code_documents'?: boolean;
    /**
     * Whether the package has paperless documents available for download
     * @type {boolean}
     * @memberof LabelPackage
     */
    'has_paperless_label_documents'?: boolean;
}