Type Alias MockupGeneratorTask

MockupGeneratorTask: {
    _links?: {
        self?: HateoasLink;
    };
    catalog_variant_mockups?: {
        catalog_variant_id?: number;
        mockups?: Mockup[];
    }[];
    failure_reasons?: Error[];
    id?: number;
    status?: status;
}

Result of mockup generator task

Type declaration

  • Optional Readonly_links?: {
        self?: HateoasLink;
    }

    HATEOAS links

    • Optionalself?: HateoasLink

      Link to the Generator Task details

  • Optionalcatalog_variant_mockups?: {
        catalog_variant_id?: number;
        mockups?: Mockup[];
    }[]

    A list of mockups grouped by variant. Note that the same list of mockups can appear under multiple variants, this happens in cases where the variants have the same mockups, for example if the only difference is the size of the variant.

  • Optionalfailure_reasons?: Error[]
  • Optionalid?: number

    Unique task identifier used to check status of the task and retrieve the results once the task is ready.

  • Optionalstatus?: status

    Task status:

    • completed – Mockup Generator task was successfully processed
    • pending – Mockup Generator task is still being processed
    • failed – Mockup Generator task failed

Settings

Member Visibility