Type Alias ApprovalSheet

ApprovalSheet: {
    _links: {
        approval_sheets?: HateoasLink;
        order: HateoasLink;
        order_item: HateoasLink;
    };
    advanced_embroidery_details?: {
        additional_design_urls?: string[];
        digitiser_comment?: string;
        is_unlimited_color?: boolean;
    } | null;
    approval_sheet: string;
    confirm_hash: string;
    created_at?: string;
    group_hash: string;
    issues?: {
        code?: number;
        description?: string;
        topic?: string;
    }[];
    item_options?: Record<string, string[]>;
    order_id: number;
    order_item_id: number;
    original_artwork_url?: string;
    pdf_download_url?: string;
    placement?: string;
    placement_label?: string;
    product_image_url?: string;
    product_name?: string;
    recommended_design: string;
    recommended_design_rotation?: string;
    recommended_options?: Record<string, any>;
    related_pending_approval_sheet_count?: number;
    status: ApprovalSheetStatuses;
    submitted_design: string;
    thread_colors?: Record<string, string[]>[];
    updated_at?: string;
    variant_color?: string;
    variant_color_code?: string;
}

Approval sheet

Type declaration

  • _links: {
        approval_sheets?: HateoasLink;
        order: HateoasLink;
        order_item: HateoasLink;
    }

    HATEOAS links

  • Optionaladvanced_embroidery_details?: {
        additional_design_urls?: string[];
        digitiser_comment?: string;
        is_unlimited_color?: boolean;
    } | null

    Additional details for advanced embroidery placements. Null if not applicable.

  • approval_sheet: string

    URL to Approval sheet.

  • confirm_hash: string

    Confirmation hash value.

  • Optionalcreated_at?: string

    Time when the approval sheet was created.

  • group_hash: string

    Common identifier used to group all approval sheets that relate to the same design.

  • Optionalissues?: {
        code?: number;
        description?: string;
        topic?: string;
    }[]

    List of issues detected with the submitted design.

  • Optionalitem_options?: Record<string, string[]>

    Options selected for the order item, such as thread colors used for embroidery. Additional placement-specific thread color options (e.g. "thread_colors_", "text_thread_colors_") may be present depending on the product's placements.

  • order_id: number

    Order ID.

  • order_item_id: number

    Item ID.

  • Optionaloriginal_artwork_url?: string

    URL to the original artwork submitted by the customer.

  • Optionalpdf_download_url?: string

    Link to the PDF version of approval sheet that can be programmatically downloaded.

  • Optionalplacement?: string

    Placement of the design on the product.

  • Optionalplacement_label?: string

    Human readable label of the placement.

  • Optionalproduct_image_url?: string

    URL to an image of the product.

  • Optionalproduct_name?: string

    Name of the product the design is placed on, including the variant.

  • recommended_design: string

    URL to recommended design.

  • Optionalrecommended_design_rotation?: string

    Recommended rotation, in degrees, to apply to the design.

  • Optionalrecommended_options?: Record<string, any>

    Recommended option changes for the item. May be returned as null when there are no recommended changes.

  • Optionalrelated_pending_approval_sheet_count?: number

    Number of other approval sheets for the same design that are still waiting for action.

  • status: ApprovalSheetStatuses
  • submitted_design: string

    URL to submitted design.

  • Optionalthread_colors?: Record<string, string[]>[]

    Thread colors recommended for the design, grouped by placement-specific thread color option.

  • Optionalupdated_at?: string

    Time when the approval sheet was last updated.

  • Optionalvariant_color?: string

    Name of the product variant's color.

  • Optionalvariant_color_code?: string

    Hex code of the product variant's color.

Settings

Member Visibility