For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
      • Getting Started
          • Overview
            • Global Email Object
            • Abandoned Cart
            • Abandoned Cart (Deprecated)
            • Account Details Changed
            • Account Reset Password
            • Combined Order Status
            • Create Account
            • Create Guest Account
            • Gift Certificate
            • Invoice
            • Order Message Notification
            • Order Ready for Pickup
            • Passwordless Login
            • Product Review
            • Return Confirmation
            • Return Status Change
          • Examples
    • Archive
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • Object properties
DocsAdminStore ConfigurationEmailsEmail object reference

Order Ready for Pick-up Email Template

Was this page helpful?
Previous

Order Notification Email Template

Next

Sign in Link Request Email Template

Built with

Order ready for pick-up email triggers when a customer or store admin creates a pick-up order.

Object properties

order
object
order properties
id
integer
account_order_status_url
string
products
array[object]
products items
id
integer
quantity
integer
name
string
sku
string
thumbnail
string
options
array
attribute_lines
array
A list of strings that represents product variant options.
configurable_fields
array
Object array with properties name and value.
pickup
array[object]
pickup items
id
integer
email
string
phone
string
instructions
string
name
string
location
array[object]
location items
name
string
address_lines
array
city
string
state
string
country
string
zip
string
operating_hours
array[object]
operating_hours items
sunday
object
sunday properties
is_open
boolean
opening_time
object
closing_time
object
monday
object
monday properties
is_open
boolean
opening_time
object
closing_time
object
tuesday
object
tuesday properties
is_open
boolean
opening_time
object
closing_time
object
wednesday
object
wednesday properties
is_open
boolean
opening_time
object
closing_time
object
thursday
object
thursday properties
is_open
boolean
opening_time
object
closing_time
object
friday
object
friday properties
is_open
boolean
opening_time
object
closing_time
object
saturday
object
saturday properties
is_open
boolean
opening_time
object
closing_time
object
store
object
store properties
name
string
domain_name
string
logo
object
logo properties
title
string
name
string
url
string
ssl_path
string
cdn_path
string
image_directory
string
img_path
string
path_normal
string
Path to the store (i.e., domain + protocol)
path
string
address
string
language
object
language properties
code
string
direction
string
Left to right or right to left, depending on the language
customer
object
customer properties
first_name
string
full_name
string
email
string
group
array[object]
group items
name
string
misc
object
misc properties
year
integer
translations
object
translations properties
en
object
en properties
prodname
string
prodsku
string
fr
object
fr properties
store
string