vivid_search

Search the Vivid Ads catalogue by product name, category, or intended use (e.g. 'corflute', 'pull up banner', 'expo', 'shopfront'). Returns matching products grounded in Vivid's own Shopify collections, so it also surfaces same-range, same-purpose alternatives — products flagged `sameRange:true` come from the top match's curated collection (returned as `collection`). ALWAYS mention these to the customer (e.g. 'we have two Pull Up Banner options, and Fabric Banner Stands do the same job'). Treat a from-price as INDICATIVE only — use vivid_product for options then vivid_price for the exact configuration.

Parameters1

query

string

required

what the customer is looking for (a product name, a category, or a use-case like 'expo' or 'shopfront')

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "what the customer is looking for (a product name, a category, or a use-case like 'expo' or 'shopfront')"
    }
  },
  "required": [
    "query"
  ]
}

vivid_recommend

Recommend Vivid Ads signage for a goal + business type (real Australian signage: pull-up banners, A-frames, corflute, fabric banners, flags, media walls). Call with goal and business; omit either to get the next question to ask the customer.

Parameters2

goal	string	optional	e.g. foot-traffic, promote-sale, stand-out-expo, advertise-outside, opening-store, brand-presence
business	string	optional	e.g. cafe-hospitality, retail, real-estate, events-expo, corporate, school, gym-fitness

Raw schema

{
  "type": "object",
  "properties": {
    "goal": {
      "type": "string",
      "description": "e.g. foot-traffic, promote-sale, stand-out-expo, advertise-outside, opening-store, brand-presence"
    },
    "business": {
      "type": "string",
      "description": "e.g. cafe-hospitality, retail, real-estate, events-expo, corporate, school, gym-fitness"
    }
  }
}

vivid_cross_sell

Suggest relevant, NON-pushy add-on products to round out a customer's order — 1–2 genuinely useful companions with a reason. PREFERS real frequently-bought-together data from Vivid Ads' order history (pass `product` = the product handle the customer chose); falls back to curated use-case bundles (pass `use_case`). Omit both to get guidance. Pass already_have to avoid re-suggesting what they've chosen. Never pressure — helpful suggestions only.

Parameters3

product	string	optional	the product handle the customer chose, e.g. 'pull-up-banners' — returns items frequently bought with it from real order history
use_case	string	optional	curated fallback: 'trade-show', 'school-open-day', 'construction-fence', 'retail-promotion', 'real-estate', or 'corporate-conference'
already_have	array	optional	product keys/handles the customer already chose (optional) — excluded from suggestions

Raw schema

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string",
      "description": "the product handle the customer chose, e.g. 'pull-up-banners' — returns items frequently bought with it from real order history"
    },
    "use_case": {
      "type": "string",
      "description": "curated fallback: 'trade-show', 'school-open-day', 'construction-fence', 'retail-promotion', 'real-estate', or 'corporate-conference'"
    },
    "already_have": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "product keys/handles the customer already chose (optional) — excluded from suggestions"
    }
  }
}

vivid_support_answer

Answer a customer's support / FAQ question in Vivid Ads' voice, grounded in the team's real support history + verified policy. Covers turnaround & production time, digital proofs & approval, artwork specs & file setup, products & options, quotes & pricing, delivery & pickup, changing/cancelling orders, reorders, and the print guarantee. Returns the best-matching answer(s) and topic; if nothing matches it returns escalate:true so you can hand off to the team. Use for questions like 'how long does it take?', 'what file format do you need?', 'can I change my order?', 'where do I pick up?'.

Parameters1

question

string

required

the customer's support question, in their own words

Raw schema

{
  "type": "object",
  "properties": {
    "question": {
      "type": "string",
      "description": "the customer's support question, in their own words"
    }
  },
  "required": [
    "question"
  ]
}

vivid_product

Get a product's FULL real option schema (all dimensions, not just size) so you can configure it correctly before pricing/ordering. Returns each option's key, label, allowed values, default, whether it's required, whether it affects price, and display order — plus `turnaround` (the live production/lead time from the product page, e.g. 24 hours if artwork is approved by 3 pm AEST on a business day). Flags have Size/Printed Sides/Flag Base; corflute has Size (or custom W×H)/Eyelets/Cutting; table throws have Style/Size/Backside.

Parameters1

product

string

required

product name, e.g. 'feather flag', 'corflute', 'table throw'

Raw schema

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string",
      "description": "product name, e.g. 'feather flag', 'corflute', 'table throw'"
    }
  },
  "required": [
    "product"
  ]
}

vivid_price

Calculate the current price for an EXACT product configuration. Pass `options` with the full selected configuration (use vivid_product first), or just `size` for simple products. Some products take several seconds or need manual confirmation. Before calling, briefly tell the customer you're checking the live price. Never estimate or reuse another configuration's price. When presenting, repeat the exact product title, quantity, dimensions, and price-affecting options.

Parameters4

product	string	required	product name, e.g. 'pull up banner', 'corflute', 'a-frame', 'feather flag'
size	string	optional	(simple products) size, e.g. '850x2000', or a named size like 'medium'
options	object	optional	FULL selected options keyed by the schema keys from vivid_product, e.g. { size:'Medium', sides:'Double-sided', base:'Heavy Duty Metal Plate (5kg)' } or { size:'Custom', widthMm:700, heightMm:1000, eyelets:'4 x eyelets (all corners)', cutting:'Square or Rectangle' }
quantity	number	optional	how many

Raw schema

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string",
      "description": "product name, e.g. 'pull up banner', 'corflute', 'a-frame', 'feather flag'"
    },
    "size": {
      "type": "string",
      "description": "(simple products) size, e.g. '850x2000', or a named size like 'medium'"
    },
    "options": {
      "type": "object",
      "description": "FULL selected options keyed by the schema keys from vivid_product, e.g. { size:'Medium', sides:'Double-sided', base:'Heavy Duty Metal Plate (5kg)' } or { size:'Custom', widthMm:700, heightMm:1000, eyelets:'4 x eyelets (all corners)', cutting:'Square or Rectangle' }"
    },
    "quantity": {
      "type": "number",
      "description": "how many"
    }
  },
  "required": [
    "product"
  ]
}

vivid_delivery_quote

EXACT delivery/freight cost to an Australian postcode for a product configuration — the SAME live rates the vividads.com.au checkout shows (carrier + shipping-rules apps; incl. GST). Use whenever the customer asks what shipping/delivery costs. Resolve the product + size/options + quantity first (vivid_product / vivid_price), then call with the postcode (suburb improves accuracy). Never estimate freight yourself. Always also mention free pickup from Derrimut VIC 3026.

Parameters7

product	string	required	product name, e.g. 'pull up banner'
size	string	optional	(simple products) size, e.g. '850x2050'
options	object	optional	FULL selected options for option-rich/custom products (same shape as vivid_price.options)
quantity	number	optional
postcode	string	required	4-digit Australian postcode
suburb	string	optional
state	string	optional	VIC/NSW/QLD/SA/WA/TAS/NT/ACT (derived from postcode if omitted)

Raw schema

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string",
      "description": "product name, e.g. 'pull up banner'"
    },
    "size": {
      "type": "string",
      "description": "(simple products) size, e.g. '850x2050'"
    },
    "options": {
      "type": "object",
      "description": "FULL selected options for option-rich/custom products (same shape as vivid_price.options)"
    },
    "quantity": {
      "type": "number"
    },
    "postcode": {
      "type": "string",
      "description": "4-digit Australian postcode"
    },
    "suburb": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "description": "VIC/NSW/QLD/SA/WA/TAS/NT/ACT (derived from postcode if omitted)"
    }
  },
  "required": [
    "product",
    "postcode"
  ]
}

vivid_request_quote

Email the customer a formal QUOTATION. If the exact configuration can be priced and an email is given, this INSTANTLY emails a branded PDF-style quotation (line items, GST, total, quote number, 14-day validity, accept-online link) — status 'quoted'. For custom/unpriceable products it logs the request for the team to prepare and send (status 'received'). Never takes payment. Confirm product, quantity, size/options, name, and email before submitting.

Parameters12

product	string	optional
size	string	optional
quantity	number	optional
options	object	optional	FULL selected options (same shape as vivid_price.options) so the quotation is priced exactly — include size + any dropdowns/add-ons.
name	string	optional
email	string	required
company	string	optional
phone	string	optional	customer phone (optional)
message	string	optional	the customer's full request in their own words (multi-item OK)
discountCode	string	optional	any reseller/trade or discount code the customer mentioned (recorded, NOT applied here)
artworkUrl	string	optional	link to the customer's uploaded artwork (e.g. the fileUrl returned by vivid_upload_artwork), if any
design	string	optional	design preference: 'ai_design' \| 'upload_own' \| 'design_later'

Raw schema

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string"
    },
    "size": {
      "type": "string"
    },
    "quantity": {
      "type": "number"
    },
    "options": {
      "type": "object",
      "description": "FULL selected options (same shape as vivid_price.options) so the quotation is priced exactly — include size + any dropdowns/add-ons."
    },
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "phone": {
      "type": "string",
      "description": "customer phone (optional)"
    },
    "message": {
      "type": "string",
      "description": "the customer's full request in their own words (multi-item OK)"
    },
    "discountCode": {
      "type": "string",
      "description": "any reseller/trade or discount code the customer mentioned (recorded, NOT applied here)"
    },
    "artworkUrl": {
      "type": "string",
      "description": "link to the customer's uploaded artwork (e.g. the fileUrl returned by vivid_upload_artwork), if any"
    },
    "design": {
      "type": "string",
      "description": "design preference: 'ai_design' | 'upload_own' | 'design_later'"
    }
  },
  "required": [
    "email"
  ]
}

vivid_place_order

Create a Shopify DRAFT order for Vivid Ads team review — NOT a final/placed order, and NEVER charges a card. Before calling, summarise the exact product, quantity, configuration, verified price (if available), customer details, and delivery/pickup, then get the customer's explicit confirmation. Call WITHOUT confirm to get a Review summary; confirm:true only AFTER they confirm. Do NOT auto-retry after a timeout without first checking whether a draft was already created. Payment is a secure invoice/pay-link from the team; production waits on proof approval.

Parameters14

product	string	optional
size	string	optional
quantity	number	optional
options	object	optional	FULL selected options (same shape as vivid_price.options). Use vivid_product to see them. Prefer this over `size` for option-rich products.
items	array	optional	For a MULTI-LINE order (e.g. two banners with DIFFERENT designs): one entry per line, each { product, size?, options?, quantity?, artwork? }. Different designs must be SEPARATE entries (quantity 1 each) with their OWN artwork. If provided, this replaces the single top-level product; contact/delivery/PO stay at the top level.
name	string	optional
email	string	required
company	string	optional
phone	string	optional
customerType	string	optional	retail\|corporate\|school\|government\|account — sets payment terms
delivery	object	optional	pickup or delivery details. PICKUP: { method:'pickup', name, email, phone, pickupLocation?, notes? }. DELIVERY: { method:'delivery', name, email, phone, company?, address1, address2?, suburb, state, postcode, country, notes? }. Contact (name/email/phone) can live here or at the top level. Omit entirely to keep the old behaviour.
artwork	object	optional	{ mode:'ai_design'\|'upload_file'\|'design_brief', designId?, imageUrl?, printPdfUrl?, fileUrl?, brief? }
poNumber	string	optional
confirm	boolean	optional	set true ONLY after the customer reviews and confirms

Raw schema

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string"
    },
    "size": {
      "type": "string"
    },
    "quantity": {
      "type": "number"
    },
    "options": {
      "type": "object",
      "description": "FULL selected options (same shape as vivid_price.options). Use vivid_product to see them. Prefer this over `size` for option-rich products."
    },
    "items": {
      "type": "array",
      "description": "For a MULTI-LINE order (e.g. two banners with DIFFERENT designs): one entry per line, each { product, size?, options?, quantity?, artwork? }. Different designs must be SEPARATE entries (quantity 1 each) with their OWN artwork. If provided, this replaces the single top-level product; contact/delivery/PO stay at the top level.",
      "items": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string"
          },
          "size": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "options": {
            "type": "object"
          },
          "artwork": {
            "type": "object",
            "description": "THIS line's artwork { mode:'ai_design'|'upload_file'|'design_brief', ... } (same shape as top-level artwork)."
          }
        }
      }
    },
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "customerType": {
      "type": "string",
      "description": "retail|corporate|school|government|account — sets payment terms"
    },
    "delivery": {
      "type": "object",
      "description": "pickup or delivery details. PICKUP: { method:'pickup', name, email, phone, pickupLocation?, notes? }. DELIVERY: { method:'delivery', name, email, phone, company?, address1, address2?, suburb, state, postcode, country, notes? }. Contact (name/email/phone) can live here or at the top level. Omit entirely to keep the old behaviour."
    },
    "artwork": {
      "type": "object",
      "description": "{ mode:'ai_design'|'upload_file'|'design_brief', designId?, imageUrl?, printPdfUrl?, fileUrl?, brief? }"
    },
    "poNumber": {
      "type": "string"
    },
    "confirm": {
      "type": "boolean",
      "description": "set true ONLY after the customer reviews and confirms"
    }
  },
  "required": [
    "email"
  ]
}

vivid_artwork

Attach a customer-provided artwork file or link to a signage order (a successful attach does NOT mean it is print-ready — the team still checks it). EASIEST: pass a shareable link to the file (sourceUrl) — Google Drive, Dropbox, WeTransfer, etc. — and use the returned fileUrl in vivid_place_order's artwork {mode:'upload_file', fileUrl}. For a large file with no link yet, set requestUpload:true to get a direct-upload URL (the file uploads straight to storage — handles 50–200MB+), then call again with the returned fileId to get the share link.

Parameters5

sourceUrl	string	optional	a shareable https link to the print-ready artwork (PDF/PNG/JPG/AI/EPS) — the easiest path
requestUpload	boolean	optional	set true to get a direct-upload URL for a large file (client uploads straight to storage)
filename	string	optional	filename (required with requestUpload), e.g. 'flyer.pdf'
contentType	string	optional
fileId	string	optional	after a direct upload completes, pass the returned file id here to finalise and get the share link

Raw schema

{
  "type": "object",
  "properties": {
    "sourceUrl": {
      "type": "string",
      "description": "a shareable https link to the print-ready artwork (PDF/PNG/JPG/AI/EPS) — the easiest path"
    },
    "requestUpload": {
      "type": "boolean",
      "description": "set true to get a direct-upload URL for a large file (client uploads straight to storage)"
    },
    "filename": {
      "type": "string",
      "description": "filename (required with requestUpload), e.g. 'flyer.pdf'"
    },
    "contentType": {
      "type": "string"
    },
    "fileId": {
      "type": "string",
      "description": "after a direct upload completes, pass the returned file id here to finalise and get the share link"
    }
  }
}

vivid_order_status

Check the LIVE status of an order — real production stage (from the Enfocus Switch print workflow), ready-for-pickup, or shipped with carrier + tracking (from StarShipit, authoritative). Look up a real order by number (e.g. #119581) or a quote/draft by number (e.g. #D776755). Requires the customer's email, which must match the order. Use for 'where is my order', 'track order 12345', 'is my order ready'. Shipped/delivered from StarShipit is final; otherwise the live Switch stage is returned.

Parameters2

reference	string	optional	order # or quote/draft # (e.g. '#119581' or '#D776755')
email	string	optional	alternatively, the customer's email to list recent orders (requires verified identity)

Raw schema

{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "description": "order # or quote/draft # (e.g. '#119581' or '#D776755')"
    },
    "email": {
      "type": "string",
      "description": "alternatively, the customer's email to list recent orders (requires verified identity)"
    }
  }
}

vivid_delivery_estimate

Estimate WHEN an order would arrive at an Australian postcode — the question behind 'can I get it by Friday?'. Works the timeline through honestly: production starts only after the customer approves their digital proof (3pm AEST cutoff), then production time for that product, then transit for their postcode (metro/regional/remote bands). Returns an arrival WINDOW plus the assumptions it made. This is an ESTIMATE, never a guarantee — always relay the caveat, and for a hard deadline tell them to call 1300 721 614. Free pickup from Derrimut VIC is usually the fastest option.

Parameters3

product	string	optional	product name — used to read its real production time
postcode	string	required	4-digit Australian delivery postcode
artwork_ready	boolean	optional	true if artwork is print-ready and the proof will be approved immediately

Raw schema

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string",
      "description": "product name — used to read its real production time"
    },
    "postcode": {
      "type": "string",
      "description": "4-digit Australian delivery postcode"
    },
    "artwork_ready": {
      "type": "boolean",
      "description": "true if artwork is print-ready and the proof will be approved immediately"
    }
  },
  "required": [
    "postcode"
  ]
}

vivid_check_artwork

Check whether a customer's artwork PDF is print-ready BEFORE they order — powered by Vivid's own production preflight engine. Reports size vs the ordered size, bleed, RGB-vs-CMYK colour, font embedding and effective resolution, each with a plain-English fix. ADVISORY ONLY: it never blocks anything. If the customer is happy to proceed with the file as-is, that is always accepted — say so explicitly. Every order also gets a free digital proof before printing.

Parameters3

file_url	string	required	downloadable URL of the artwork PDF (e.g. the fileUrl from vivid_upload_artwork)
width_mm	number	optional	ordered width in mm, if known — enables the size check
height_mm	number	optional	ordered height in mm, if known

Raw schema

{
  "type": "object",
  "properties": {
    "file_url": {
      "type": "string",
      "description": "downloadable URL of the artwork PDF (e.g. the fileUrl from vivid_upload_artwork)"
    },
    "width_mm": {
      "type": "number",
      "description": "ordered width in mm, if known — enables the size check"
    },
    "height_mm": {
      "type": "number",
      "description": "ordered height in mm, if known"
    }
  },
  "required": [
    "file_url"
  ]
}

vivid_proof_status

Check a customer's DIGITAL PROOF status: has the proof been emailed, is it awaiting their approval, being revised after rejection, or already approved (production underway). Use for 'where's my proof', 'did you send my proof', 'when do I approve'. Requires the order number AND the email on the order (identity — details only return when they match). Relay the returned agent_hint concisely; production starts only after the customer approves the emailed proof.

Parameters2

order_number	string	required	order number, e.g. '#121978'
email	string	required	the email address the order was placed under (required)

Raw schema

{
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "order number, e.g. '#121978'"
    },
    "email": {
      "type": "string",
      "description": "the email address the order was placed under (required)"
    }
  },
  "required": [
    "order_number",
    "email"
  ]
}

vivid_reorder

Reorder a customer's previous signage job — fast. Requires identity verification (emailed one-time code), not just an order number. action:'list' shows their past orders; action:'reorder' repeats one. ARTWORK: it reuses only the customer's previously APPROVED artwork (the print file), never a pre-approval upload; if it can't be confirmed automatically the team confirms it. A fresh proof is ALWAYS re-issued to confirm the artwork before printing. The customer may also supply new artwork or change the quantity. Re-prices with CURRENT pricing (never the old price). Creates a proof-gated draft order; never charges a card.

Parameters9

email	string	required	the email the customer ordered under (required to find past orders)
action	string	optional	'list' (show past orders) or 'reorder' (repeat one)
order	string	optional	order name to reorder from, e.g. '#D12345' (optional)
product	string	optional	which product to reorder, e.g. 'corflute' (optional; default = most recent eligible)
quantity	number	optional	override quantity (optional; default = same as last time)
artwork	string	optional	new print-ready artwork file URL (optional; default = reuse previous)
name	string	optional
token	string	optional	the identity token from vivid_identity_verify (required — proves the customer owns this email)
confirm	boolean	optional	set true to place the reorder (draft, proof-gated, never charges)

Raw schema

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "the email the customer ordered under (required to find past orders)"
    },
    "action": {
      "type": "string",
      "description": "'list' (show past orders) or 'reorder' (repeat one)"
    },
    "order": {
      "type": "string",
      "description": "order name to reorder from, e.g. '#D12345' (optional)"
    },
    "product": {
      "type": "string",
      "description": "which product to reorder, e.g. 'corflute' (optional; default = most recent eligible)"
    },
    "quantity": {
      "type": "number",
      "description": "override quantity (optional; default = same as last time)"
    },
    "artwork": {
      "type": "string",
      "description": "new print-ready artwork file URL (optional; default = reuse previous)"
    },
    "name": {
      "type": "string"
    },
    "token": {
      "type": "string",
      "description": "the identity token from vivid_identity_verify (required — proves the customer owns this email)"
    },
    "confirm": {
      "type": "boolean",
      "description": "set true to place the reorder (draft, proof-gated, never charges)"
    }
  },
  "required": [
    "email"
  ]
}

vivid_identity_start

Start email verification before showing a customer's private data (past orders, reorder, saved address, email order-status). Sends a 6-digit code to the email. Returns a verificationId. Then ask the customer for the code and call vivid_identity_verify. Use this whenever a customer asks to see 'my orders', 'reorder', or 'status by email' and you don't already have a valid identity token.

Parameters2

email	string	required	the customer's email to verify
purpose	string	optional	reorder \| order_status \| saved_details (optional)

Raw schema

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "the customer's email to verify"
    },
    "purpose": {
      "type": "string",
      "description": "reorder | order_status | saved_details (optional)"
    }
  },
  "required": [
    "email"
  ]
}

vivid_identity_verify

Complete email verification: pass the verificationId from vivid_identity_start and the 6-digit code the customer received. On success returns a short-lived identity token — pass that token to vivid_reorder / vivid_order_status to unlock the customer's private data. Codes expire in 10 minutes; attempts are limited.

Parameters2

verificationId	string	required	from vivid_identity_start
code	string	required	the 6-digit code the customer received by email

Raw schema

{
  "type": "object",
  "properties": {
    "verificationId": {
      "type": "string",
      "description": "from vivid_identity_start"
    },
    "code": {
      "type": "string",
      "description": "the 6-digit code the customer received by email"
    }
  },
  "required": [
    "verificationId",
    "code"
  ]
}

vivid_order_artwork

Show a VERIFIED customer the PRINT-READY artwork files produced for one of their past orders (the actual files that went to print), so they can confirm them before reordering. Requires the order number and a valid identity token bound to the customer's email; only returns artwork for orders that belong to that customer. Returns view links to each print layout. Use when a customer asks 'what artwork did I print', 'show me my last print file', or before confirming a reorder.

Parameters3

order	string	required	the order number to show artwork for, e.g. '117478'
email	string	required	the customer's email (must match the identity token)
token	string	optional	the identity token from vivid_identity_verify (required — proves the customer owns this email/order)

Raw schema

{
  "type": "object",
  "properties": {
    "order": {
      "type": "string",
      "description": "the order number to show artwork for, e.g. '117478'"
    },
    "email": {
      "type": "string",
      "description": "the customer's email (must match the identity token)"
    },
    "token": {
      "type": "string",
      "description": "the identity token from vivid_identity_verify (required — proves the customer owns this email/order)"
    }
  },
  "required": [
    "order",
    "email"
  ]
}

vivid_upload_artwork

Upload a customer's artwork FILE through the agent (no website file picker needed). Accepts the file as base64, stores it in Vivid's Google Drive, and returns a stable shareable link plus metadata. Optionally attaches the link to a quote, order, or design session. Accepts PDF / AI / EPS / JPG / PNG. Does NOT verify print-readiness — the team checks that. Use when a customer wants to send their print file via chat.

Parameters7

filename	string	required	original filename incl. extension, e.g. 'banner-artwork.pdf'
mimeType	string	optional	MIME type, e.g. 'application/pdf'
contentBase64	string	required	the file contents, base64-encoded (data URI prefix OK). Small files only; for very large files share a download link instead.
email	string	optional	customer email to associate with the upload (optional but recommended)
quoteId	string	optional	associate with a quote request (optional)
orderId	string	optional	associate with an order/draft (optional)
sessionId	string	optional	associate with a design session (optional)

Raw schema

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "description": "original filename incl. extension, e.g. 'banner-artwork.pdf'"
    },
    "mimeType": {
      "type": "string",
      "description": "MIME type, e.g. 'application/pdf'"
    },
    "contentBase64": {
      "type": "string",
      "description": "the file contents, base64-encoded (data URI prefix OK). Small files only; for very large files share a download link instead."
    },
    "email": {
      "type": "string",
      "description": "customer email to associate with the upload (optional but recommended)"
    },
    "quoteId": {
      "type": "string",
      "description": "associate with a quote request (optional)"
    },
    "orderId": {
      "type": "string",
      "description": "associate with an order/draft (optional)"
    },
    "sessionId": {
      "type": "string",
      "description": "associate with a design session (optional)"
    }
  },
  "required": [
    "filename",
    "contentBase64"
  ]
}

vivid_fulfilment_order_status

Authoritative order state with a per-line-item breakdown and an order-level rollup. States: received, in_production, partially_ready, ready_for_pickup, dispatched, in_transit, out_for_delivery, delivered, completed, on_hold, cancelled. Includes the StarShipit shipping summary where available.

Parameters4

customer_email	string	required	The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers.
order_id	string	optional	Shopify order GID, e.g. gid://shopify/Order/123.
order_name	string	optional	Human order name, e.g. "#12345" (alias for order_id).
line_item_id	string	optional	Optional Shopify line item GID to scope to one item.

Raw schema

{
  "type": "object",
  "properties": {
    "customer_email": {
      "type": "string",
      "description": "The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers."
    },
    "order_id": {
      "type": "string",
      "description": "Shopify order GID, e.g. gid://shopify/Order/123."
    },
    "order_name": {
      "type": "string",
      "description": "Human order name, e.g. \"#12345\" (alias for order_id)."
    },
    "line_item_id": {
      "type": "string",
      "description": "Optional Shopify line item GID to scope to one item."
    }
  },
  "required": [
    "customer_email"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "order_id"
      ]
    },
    {
      "required": [
        "order_name"
      ]
    }
  ]
}

vivid_fulfilment_production_stage

Where each line item is in production, per item plus a rollup. Stages (in order): received, in preflight, awaiting proof, proof approved, imposing, queued for print, sent to Caldera, printing, printed, at Zund cutter, cut, dispatched. Needs-action states: missing file, preflight failed, with design team, on hold (unpaid), proof rejected, duplicate. Each item also returns the press and the print timestamp.

Parameters4

customer_email	string	required	The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers.
order_id	string	optional	Shopify order GID, e.g. gid://shopify/Order/123.
order_name	string	optional	Human order name, e.g. "#12345" (alias for order_id).
line_item_id	string	optional	Optional Shopify line item GID to scope to one item.

Raw schema

{
  "type": "object",
  "properties": {
    "customer_email": {
      "type": "string",
      "description": "The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers."
    },
    "order_id": {
      "type": "string",
      "description": "Shopify order GID, e.g. gid://shopify/Order/123."
    },
    "order_name": {
      "type": "string",
      "description": "Human order name, e.g. \"#12345\" (alias for order_id)."
    },
    "line_item_id": {
      "type": "string",
      "description": "Optional Shopify line item GID to scope to one item."
    }
  },
  "required": [
    "customer_email"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "order_id"
      ]
    },
    {
      "required": [
        "order_name"
      ]
    }
  ]
}

vivid_fulfilment_shipping

StarShipit shipping: carrier, tracking number, tracking URL, ETA and delivered flag. shipping_state: not_dispatched, shipped, in_transit, out_for_delivery, delivered, exception.

Parameters4

customer_email	string	required	The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers.
order_id	string	optional	Shopify order GID, e.g. gid://shopify/Order/123.
order_name	string	optional	Human order name, e.g. "#12345" (alias for order_id).
line_item_id	string	optional	Optional Shopify line item GID to scope to one item.

Raw schema

{
  "type": "object",
  "properties": {
    "customer_email": {
      "type": "string",
      "description": "The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers."
    },
    "order_id": {
      "type": "string",
      "description": "Shopify order GID, e.g. gid://shopify/Order/123."
    },
    "order_name": {
      "type": "string",
      "description": "Human order name, e.g. \"#12345\" (alias for order_id)."
    },
    "line_item_id": {
      "type": "string",
      "description": "Optional Shopify line item GID to scope to one item."
    }
  },
  "required": [
    "customer_email"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "order_id"
      ]
    },
    {
      "required": [
        "order_name"
      ]
    }
  ]
}

vivid_fulfilment_pickup_status

Whether an order (or specific line items) is ready for pickup at Derrimut VIC — ready once printed and cut, before dispatch.

Parameters4

customer_email	string	required	The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers.
order_id	string	optional	Shopify order GID, e.g. gid://shopify/Order/123.
order_name	string	optional	Human order name, e.g. "#12345" (alias for order_id).
line_item_id	string	optional	Optional Shopify line item GID to scope to one item.

Raw schema

{
  "type": "object",
  "properties": {
    "customer_email": {
      "type": "string",
      "description": "The email address on the order. REQUIRED for identity — order details are only returned when this email matches the order. The customer must give their email AND one of their order numbers."
    },
    "order_id": {
      "type": "string",
      "description": "Shopify order GID, e.g. gid://shopify/Order/123."
    },
    "order_name": {
      "type": "string",
      "description": "Human order name, e.g. \"#12345\" (alias for order_id)."
    },
    "line_item_id": {
      "type": "string",
      "description": "Optional Shopify line item GID to scope to one item."
    }
  },
  "required": [
    "customer_email"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "order_id"
      ]
    },
    {
      "required": [
        "order_name"
      ]
    }
  ]
}

au.com.vividads/vivid-ads-commerce