v1.041

Adds a new endpoint that lists embroidery hits with the stitch and color counts of their design files, so you can report embroidery volume per product, order or period.

🚀 New Endpoints

Retrieve List of Embroidery Hits

• Retrieve List of Embroidery Hits (GET /v1/integrations/embroidery-hits-list): Returns the embroidery hits stitched on your orders, oldest first. One embroidery hit is one design stitched once at one position on one unit, so an order line with a quantity of 2 and two embroidery positions has 4 hits. Hits of cancelled orders are not listed.

  • Query parameters:
    • page (integer, default 1) - 1-based page number
    • pageSize (integer, 1-100, default 100) - number of hits per page
    • completedFrom (date-time) - only hits completed at or after this timestamp
    • completedTo (date-time) - only hits completed before this timestamp
    • orderNumber (string) - only hits of the order with this order number
    • sku (string) - only hits stitched on the product with this SKU
  • Each hit contains:
    • embroidery_hit_uuid (string) - identifier of the hit
    • order_number (string) and order_key (string) - the order the hit belongs to
    • sku (string) and product_name (string) - the product the hit is stitched on
    • position (string) - position on the product, as sent in the order
    • type (string) - kind of the embroidery instruction: text, image_file, text_with_image_file or design_identifier
    • design_identifier (string|null) - identifier of the embroidery design the hit was stitched from
    • stitch_count (integer|null) - stitch count of the digitized design file
    • color_count (integer|null) - number of thread colors of the digitized design file
    • started_at (date-time|null) and completed_at (date-time|null) - when stitching started and finished

  stitch_count and color_count come from the digitized design file, not from the embroidery machine, so every hit of the same design version has the same value. They are null for hits without a design file, for example text with an image file or hits stitched before design files were tracked. To get the stitch count per product, filter by completedFrom / completedTo and add up stitch_count grouped by sku.

📦 New Support Schemas

• PublicApiPaginatedEmbroideryHitsOutput - response of the new endpoint with embroidery_hits and paginator
• PublicApiEmbroideryHitOutput - one embroidery hit
• PublicApiEmbroideryHitType - enum of the embroidery instruction kinds

No endpoints or fields were removed or changed.