Print Orders

Print orders let you bundle printable assets from an activation pack (QR stickers, posters, lookbooks) into an order that can be emailed directly to a print vendor. Admins may target another user’s orders by passing adminMode with userId.

Get or create print order

Returns the pack’s existing draft print order, or creates a new one seeded with items for every printable asset already generated on the pack.

string

required

Must be "print-orders"

string

required

Must be "get-or-create"

object

required

Show properties

string

required

UUID of the activation pack to build the order for.

boolean

default:"false"

Skip draft reuse and always insert a new order.

boolean

Admin only. Allow targeting another user’s orders.

string

Admin only. UUID of the user whose orders to operate on.

boolean

object

Show properties

object

The print order record.

Show properties

string

Print order UUID.

string

Order status (e.g. "draft", "sent").

object[]

Line items — each has id, label, url, quantity, notes, and assetType.

string | null

Printer’s email address.

string | null

Free-text instructions for the printer.

string | null

ISO 8601 timestamp when the order was sent.

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

const response = await ApiService.invoke({
  resource: "print-orders",
  action: "get-or-create",
  data: {
    activation_pack_id: "pack-uuid",
  },
});
const order = response?.printOrder;

curl -X POST https://api.helpgenie.ai/v1/print-orders \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "print-orders",
    "action": "get-or-create",
    "data": {
      "activation_pack_id": "pack-uuid"
    }
  }'

{
  "success": true,
  "data": {
    "printOrder": {
      "id": "order-uuid",
      "status": "draft",
      "items": [
        { "id": "item-1", "label": "QR Sticker", "url": "https://...", "quantity": 50, "assetType": "qr_sticker" }
      ],
      "vendor_email": null,
      "notes": null,
      "sent_at": null,
      "created_at": "2024-01-15T10:00:00.000Z",
      "updated_at": "2024-01-15T10:00:00.000Z"
    }
  }
}

Update print order

Updates a draft print order — its items array, vendor email, or notes.

Only draft orders can be updated. Sent orders are locked.

string

required

Must be "print-orders"

string

required

Must be "update"

string

required

The print order UUID.

object

required

Show properties

object[]

Updated order line items. Each item: { id, label, url, quantity, notes, assetType }.

string

Free-text instructions for the printer. Maximum 2,000 characters.

string

Printer’s email address.

string

required

The updated_at timestamp of the draft being edited. Stale writes are rejected.

string

Required when items is provided. Artwork-input revision used to render the selected files.

boolean

Admin only. Allow targeting another user’s orders.

string

Admin only. UUID of the user whose orders to operate on.

boolean

object

The updated print order object.

Send print order

Emails the print order to a vendor with each item’s asset attached, then marks the order sent.

string

required

Must be "print-orders"

string

required

Must be "send"

string

required

The print order UUID.

object

required

Show properties

string

required

Printer’s email address. Must be a valid address.

string

Instructions included in the email and saved on the order. Maximum 2,000 characters.

string

required

The updated_at timestamp of the draft being reviewed. Stale versions are rejected before delivery.

boolean

Admin only. Allow targeting another user’s orders.

string

Admin only. UUID of the user whose orders to operate on.

boolean

object

The sent print order with updated sent_at timestamp.

Fails validation if the order has no items. Only http(s) item URLs are attached to the email.

const response = await ApiService.invoke({
  resource: "print-orders",
  action: "send",
  id: "order-uuid",
  data: {
    vendorEmail: "printer@example.com",
    notes: "Please use matte finish for all stickers.",
    expectedUpdatedAt: "2024-01-15T10:00:00.000Z",
  },
});

curl -X POST https://api.helpgenie.ai/v1/print-orders \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "print-orders",
    "action": "send",
    "id": "order-uuid",
    "data": {
      "vendorEmail": "printer@example.com",
      "notes": "Please use matte finish for all stickers.",
      "expectedUpdatedAt": "2024-01-15T10:00:00.000Z"
    }
  }'

Error codes

Code	Meaning
`VALIDATION_ERROR`	Missing required parameter or order has no items
`NOT_FOUND`	Print order or activation pack not found
`FORBIDDEN`	Non-admin user attempted to target another user
`INTERNAL_ERROR`	Unexpected server error

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Get or create print order

Update print order

Send print order

Error codes

​Get or create print order

​Update print order

​Send print order

​Error codes

Get or create print order

Update print order

Send print order

Error codes