When using embroidery, the caller will need to specify additional
embroideryMetadata for the artwork. This metadata will convey the specifics of the embroidery design as well as the thread colors to be used. The
embroideryMetadata requires the following elements:
dstTFileUrl- Required. The caller needs to specify the URL of a DST file describing the artwork to be embroidered. Note that the DST file itself defines the physical size of the embroidery, so
physicalSizeshould not be specified directly on the API call.
threadColors- Required. The caller needs to specify an array of thread colors to be used. The DST file defines a number of thread sequences used to create the design, but does not indicate the colors to be used for those sequences. The
threadColorsarray should match the sequences in the DST, providing the specific thread color to be used for each sequence. Thread colors should include:
brand- The brand of the desired thread color, from the catalog of supported thread colors.
code- The code of the desired thread color, from the catalog of supported thread colors.