Skip to content

Enum reference ​

Source: app/v1/enum/. Where a schema uses Object.keys(...) you must send the key; where it uses Object.values(...) you send the value. Both columns are listed.

22.1 customer_source_types ​

Send the key (key == value here): organic, scan, referral, promotion, shopify_plugin, other.

22.2 customer_medium_types ​

Send the key: ios, android, website, plugin, other.

22.3 customer_device_types ​

Send the key: mobile, desktop, ipad, tablet, other, laptop.

22.4 Other enums ​

EnumUsed bySendAccepted
newsletterTypes§17.2 categorykeyNEWS, NEW_RELEASES, PRODUCT_UPDATE, COMPANY_ANNOUNCEMENT
blogTypes§16.2 categorykeyUPCOMING, NEWS, NEW_RELEASES, PRODUCT_UPDATE, COMPANY_ANNOUNCEMENT (the handler maps key → value before validating)
receipt_source_types§15.1 sourcevalueself, meadow, retail
receiptStatusTypes§15.2 statuskeyPENDING, APPROVED, REJECTED
devicePlatformTypes§19.1 platformkeyIOS, ANDROID, WEB
tradeTypes§9.1, §9.6 typekeyopen_trade, direct_trade, open_gift, direct_gift
orderSourceType§12.7/§12.8 posIdkeyweedmaps, phone, email, website, kiosk
orderMethod§12.7/§12.8 methodkeycurbside, doorstep, pos, instore, shipment
addressTypes§4.1 typevaluebilling, shipping
formType§16.9 typekeyscan_verify, scan_survey, product_review
event_types§16.5 typevaluestandard, drop
tradeStatusnever sent — the server's own trade state, returned on trades and trade logs—open, inprogress, completed, expired, rejected, cancelled
trade-log participant§9.4 — requiredvaluesender, receiver, both
trade-log type§9.4 — required; each maps to a set of tradeStatus valuesvalueactive, completed, history
orderTypesfrom the token, not the client—delivery, pos, rapid, pickup, shipment
country_iso_codesaddress countryvalueISO country codes, see app/v1/helpers/isocodes.ts

Batch platform, Shopify app and API documentation