Schemas

Schemas

Source:

Reaction uses SimpleSchema to apply basic content and structure validation to Collections. See full documentation.

Members

(static) Accounts :SimpleSchema

Source:
Properties:
Name Type Description
userId String

required

sessions Array.<String>

optional, Array of strings

shopId String

required

name String

optional

username String

optional

emails Array.<Email>

optional, Array of strings

acceptsMarketing Boolean

optional

state String

optional

taxSettings TaxSettings

optional

note String

optional

profile Profile

optional

groups Array.<String>

optional, Array of groupIds of the groups the user belongs to

metafields Array.<Metafield>

optional

createdAt Date

required

updatedAt Date

optional

Type:
  • SimpleSchema

(static) Address :SimpleSchema

Source:
Properties:
Name Type Description
_id String
fullName String

required

address1 String

required

address2 String
city String

required

company String
phone String

required

region String

required, State/Province/Region

postal String

required

country String

required

isCommercial Boolean

required

isBillingDefault Boolean

required

isShippingDefault Boolean

required

failedValidation Boolean
metafields Array.<Metafield>
Type:
  • SimpleSchema

(static) Assets :SimpleSchema

Source:
Properties:
Name Type Description
type String

required

name String

optional

ns String

optional, namespace for i18n. Allows to load translation for custom plugins.

path String

optional

content String

optional

Type:
  • SimpleSchema

(static) BrandAsset :SimpleSchema

Source:
Properties:
Name Type Description
mediaId String

optional

type String

optional

Type:
  • SimpleSchema

(static) cardSchema :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Cart :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required for check of users' carts

shopId String

required, Cart ShopId

accountId String

Account ID for account carts, or null for anonymous

anonymousAccessToken String

Token for accessing anonymous carts, null for account carts

email String

optional

items Array.<CartItem>

Array of CartItem optional

shipping Array.<Shipment>

Array of Shipment optional, blackbox

billing Array.<Payment>

Array of Payment optional, blackbox

sessionId String

Optional and deprecated

tax Number

tax rate

discount Number

optional

workflow Workflow

optional

createdAt Date

required

updatedAt Date

optional

Type:
  • SimpleSchema

(static) CartItem :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

addedAt String

required

attributes Array.<CartItemAttribute>

Attributes of this item

createdAt String

required

metafields Array.<Metafield>
optionTitle String

optionTitle from the selected variant

parcel ShippingParcel

Currently, parcel is in simple product schema. Need to include it here as well.

priceWhenAdded Money

The price+currency at the moment this item was added to this cart

productId String

required

productSlug String

Product slug

productType String

Product type

productVendor String

Product vendor

quantity Number

required

shopId String

Cart Item shopId

taxData Object

optional blackbox

taxRate Number

optional The rate that was multiplied by the item subtotal to get the item tax

title String

Cart Item title

transaction Object

Transaction associated with this item

updatedAt String

required

variantId String

required

variantTitle String

Title from the selected variant

Type:
  • SimpleSchema

(static) CartItemAttribute :SimpleSchema

Source:
Properties:
Name Type Description
label String

optional

value String

optional

Type:
  • SimpleSchema

(static) CartItems :SimpleSchema

Used in check by inventory/addReserve method

Source:
Properties:
Name Type Description
items Array.<CartItem>

an Array of CartItem optional

Type:
  • SimpleSchema

(static) Catalog :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

product Object

required optional

createdAt Date

required

shopId String

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) CatalogPriceRange :SimpleSchema

Source:
Properties:
Name Type Description
max Number

required

min Number

required

range String

required

Type:
  • SimpleSchema

(static) CatalogProduct :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

barcode String

optional

createdAt Date

required

description String

optional

height Number

optional, default value: 0

isBackorder Boolean

required

isDeleted Boolean

required, default value: false

isLowQuantity Boolean

required

isSoldOut Boolean

required

isTaxable Boolean

required, default value: false

isVisible Boolean

required, default value: false

length Number

optional, default value: 0

lowInventoryWarningThreshold Number

optional, default value: 0

media Array.<ImageInfo>

optional

metafields Array.<Metafield>

optional

metaDescription String

optional

minOrderQuantity Number

required, default value: 1

originCountry String

optional

pageTitle String

optional

parcel ShippingParcel

optional

price CatalogPriceRange

optional

pricing Object

required

primaryImage ImageInfo

optional

productId String

required

productType String

optional

shopId String

required

sku String

optional

slug String

optional

socialMetadata Array.<SocialMetadata>

optional

supportedFulfillmentTypes Array.<String>

Types of fulfillment ("shipping", "pickup", etc) allowed for this product

tagIds Array

optional

taxCode String

optional, default value: "0000"

taxDescription String

optional

title String

optional

type String

required, default value: product-simple

updatedAt Date

required

variants Array.<CatalogProductVariant>

optional

vendor String

optional

weight Number

optional, default value: 0

width Number

optional, default value: 0

Type:
  • SimpleSchema

(static) CorePackageConfig :SimpleSchema

The Core Package Config is part of the Registry. The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
settings.mail Object

optional, Mail settings

Properties
Name Type Description
user String

Mail user

password String

Mail password

host String

Mail host

port String

Mail port

settings.openexchangerates.appId String

OpenExchangeRates Id

settings.openexchangerates.refreshPeriod String

default value: "every 1 hour"

settings.google.clientId String

default value: null

settings.google.apiKey String

default value: null

settings.public Object

optional Settings in public are published to the client.

Properties
Name Type Description
allowGuestCheckout Boolean

allows guest checkout

settings.cart.cleanupDurationDays String

default value: "older than 3 days"

Type:
  • SimpleSchema

(static) Currency :SimpleSchema

Source:
Properties:
Name Type Description
symbol String

default value: $

format String

default value: %s%v

scale Number

optional, default value: 2

decimal String

optional, default value: .

thousand String

optional, default value: ,

rate Number

optional

Type:
  • SimpleSchema

(static) CurrencyExchangeRate :SimpleSchema

Source:
Properties:
Name Type Description
userCurrency, String

default value: "USD"

exchangeRate Number

optional

Type:
  • SimpleSchema

(static) CustomEmailSettings :SimpleSchema

Source:
Properties:
Name Type Description
service String

optional

username String

optional

password String

optional

host String

optional

port Number

optional

Type:
  • SimpleSchema

(static) DiscountCodes :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) DiscountCodesPackageConfig :SimpleSchema

A schema that extends discount schema with properties for discount codes.

Source:
Type:
  • SimpleSchema

(static) Discounts :SimpleSchema

Discounts schema

Source:
Type:
  • SimpleSchema

(static) DiscountsPackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Document :SimpleSchema

Source:
Properties:
Name Type Description
docId String

required

docType String

optional

Type:
  • SimpleSchema

(static) Email :SimpleSchema

Source:
Properties:
Name Type Description
provides String

optional

address String

required

verified Boolean

optional

Type:
  • SimpleSchema

(static) Emails :SimpleSchema

Source:
Properties:
Name Type Description
to String

required

from String

required

subject String

required

text String

optional

html String

optional

userId String

optional

jobId String

required

type String

optional

status String

optional

createdAt Date

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) EmailTemplates :SimpleSchema

EmailTemplates schema

Source:
Type:
  • SimpleSchema

(static) EnabledPackagesByShopType :SimpleSchema

EnabledPackagesByShopType schema

Source:
Type:
  • SimpleSchema

(static) Event for EventLog :SimpleSchema

Source:
Properties:
Name Type Description
title String

Event title required

type String

Event type required

description String

Event description optional

userId String

User who triggered event optional

trigger String

Action that triggered event optional

createdAt Date

required

Type:
  • SimpleSchema

(static) ExamplePackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) ExamplePayment :SimpleSchema

ExamplePayment schema

Source:
Type:
  • SimpleSchema

(static) ExportHistory :SimpleSchema

Source:
Properties:
Name Type Description
status String

(required) Whether the export attempt succeeded or failed

dateAttempted Date

(required) Date the export was attempted

exportMethod String

(required) Name of the export method (e.g. CSV, Shopify)

destinationIdentifier String

The identifier for this order on the remote system

shopId String

(required) The shop ID

Type:
  • SimpleSchema

(static, constant) exports.Template :SimpleSchema

Source:
Properties:
Name Type Description
shopId String

Template ShopId

name String

required

title String

optional

priority Number

optional, default value: 1

enabled Boolean

default value: true

route String

optional

type String

default value: template

provides String

default value: template

block String

optional

defaultData Object

optional, blackbox

parser String

required

language String

optional, default value: en

source String

optional

template Array.<Object>

optional, blackbox

Type:
  • SimpleSchema

(static) Group :SimpleSchema

Source:
Properties:
Name Type Description
name String

required

description String

optional

slug String

required

permissions Array.<String>

optional

shopId String

required

createdBy String

optional

createdAt Date

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) History :SimpleSchema

Source:
Properties:
Name Type Description
event String

required

value String

required

userId String

required

updatedAt String

required

Type:
  • SimpleSchema

(static) ImageInfo :SimpleSchema

Source:
Properties:
Name Type Description
priority Number

required

productId String

required

toGrid Number

required

variantId String

optional

URLs ImageSizes

required

Type:
  • SimpleSchema

(static) ImageSizes :SimpleSchema

Source:
Properties:
Name Type Description
large String

optional

medium String

optional

original String

optional

small String

optional

thumbnail String

optional

Type:
  • SimpleSchema

(static) Inventory :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional, inserted by Mongo, we need it for schema validation

shopId String

required, Inventory shopId

productId String

required

variantId String

required

orderItemId String

optional

workflow Workflow

optional

sku String

optional

metafields Array.<Metafield>

optional

documents Array.<Document>

optional

notes Array.<Notes>

optional

createdAt Date

optional, but consider it temporary: schema validation failing in method with required

updatedAt Date

optional

Type:
  • SimpleSchema

(static) Invoice :SimpleSchema

Source:
Properties:
Name Type Description
discounts Number

optional

effectiveTaxRate Number

The effective tax rate, for display

shipping Number

optional

subtotal Number

required

taxes Number

optional

total Number

required

Type:
  • SimpleSchema

(static) Languages :SimpleSchema

Source:
Properties:
Name Type Description
label String

required

i18n String

required

enabled, Boolean

default value: true

Type:
  • SimpleSchema

(static) Layout :SimpleSchema

Layout are used by the Shops and Packages schemas. Read more about Layouts in documentation

Source:
Properties:
Name Type Description
layout String

optional

workflow String

optional

template String

optional

collection String

optional

theme String

optional

enabled Boolean

default value: true

status String

optional

label String

optional

container String

optional

audience Array.<String>

optional

structure LayoutStructure

optional

priority Number

optional default value: 999 - Layouts are prioritized with lower numbers first.

position Number

optional default value: 1

Type:
  • SimpleSchema

(static) LayoutStructure :SimpleSchema

Layout are used by the Shops and Packages schemas. Layouts are used to in two ways: 1) Define the template layout on the site 2) Define workflow components used in each layout block

Source:
Properties:
Name Type Description
template String

optional

layoutHeader String

optional

layoutFooter String

optional

notFound String

optional

dashboardHeader String

optional

dashboardControls String

optional

dashboardHeaderControls String

optional

adminControlsFooter String

optional

Read more about Layouts in documentation

Type:
  • SimpleSchema

(static) Locale :SimpleSchema

Source:
Properties:
Name Type Description
continents Object

blackbox

countries Object

blackbox

Type:
  • SimpleSchema

(static) MarketplacePackageConfig :SimpleSchema

MarketplacePackageConfig schema

Source:
Type:
  • SimpleSchema

(static) MerchantShop :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Shop label

slug String

Shop slug

name String

Shop name

Type:
  • SimpleSchema

(static) Metafield :SimpleSchema

Source:
Properties:
Name Type Description
key String

optional

namespace String

optional

scope String

optional

value String

optional

valueType String

optional

description String

optional

Type:
  • SimpleSchema

(static) Notes :SimpleSchema

Source:
Properties:
Name Type Description
content String

required

userId String

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) Notification :SimpleSchema

Notification sends messages corresponding to the type:

  • orderCanceled : "Your order was canceled."
  • forAdmin : "You have a new order."
  • newOrder : "You just made an order."
  • orderDelivered : "Your order has been delivered."
  • orderProcessing: "Your order is being processed."
  • orderShipped : "Your order has been shipped."

Source:
Properties:
Name Type Description
message String

required

type String

required, types: orderCanceled, forAdmin, newOrder, orderDelivered, orderProcessing, orderShipped

url String

required

to String

required

hasDetails Boolean

required

details String

required

status String

required, default: unread

timeSent Date

required

Type:
  • SimpleSchema

(static) Order Schema :SimpleSchema

Order has an array of History, Documents, Notes, Items and OrderTransactions.

Source:
Properties:
Name Type Description
_id String

required

accountId String

Account ID for account orders, or null for anonymous

anonymousAccessToken String

Token for accessing anonymous carts, null for account carts

cartId String

optional For tracking which cart created this order

createdAt Date

required

currencyCode String

required

documents Array.<Document>

optional

email String

optional

exportHistory Array.<Object>

optional

history Array.<History>

optional

notes Array.<Notes>

optional

shipping Array.<Shipment>

Array of fulfillment groups

shopId String

required The owner shop

taxes Array.<Object>

Array of objects optional

transactions Array.<OrderTransaction>

optional

updatedAt Date

optional

workflow Workflow

optional

Type:
  • SimpleSchema

(static) OrderDiscount :SimpleSchema

Source:
Properties:
Name Type Description
amount Number

Amount of discount applied to the order

discountId String

Discount ID

Type:
  • SimpleSchema

(static) OrderFulfillmentGroup Schema :SimpleSchema

One fulfillment group of an order

Source:
Properties:
Name Type Description
_id String

Group ID

address Object

Shipping address

customsLabelUrl String

URL for customs label

invoice Object

Invoice (same as the one on Payment)

items Array.<Object>

The order items in this group

itemIds Array.<String>

For convenience, the _id of all the items

payment Object

The payment info for this group

shipmentMethod Object

The fulfillment method that was chosen by the customer

shippingLabelUrl String

URL for shipping label

shopId String

The shop that fulfills this group

totalItemQuantity Number

The total item quantity, sum of all quantities

tracking String

Tracking reference ID

type String

Fulfillment type

workflow Object

Current status and past statuses for this fulfillment

Type:
  • SimpleSchema

(static) OrderItem :SimpleSchema

Defines one item in an order

Source:
Properties:
Name Type Description
_id String

Unique ID for the item

addedAt String

Date/time when this was first added to the cart/order

createdAt String

Date/time when this order item was created

documents Array.<Document>

optional

history Array.<History>

optional

isTaxable Boolean

Is this item taxable?

optionTitle String

optionTitle from the selected variant

parcel ShippingParcel

Currently, parcel is in simple product schema. Need to include it here as well.

price Money

The price+currency of variantId at the moment the related order was placed

productId String

required

productSlug String

Product slug

productType String

Product type

productVendor String

Product vendor

quantity Number

required

shopId String

The owner shop

subtotal Number

The item subtotal, quantity x price

tax Number

Total tax collected for the item. Will be 0 if isTaxable is false.

taxRate Number

Tax rate that was used to calculate item tax. Will be 0 if isTaxable is false.

title String

Title from the selected product

updatedAt String

required

variantId String

required

variantTitle String

Title from the selected variant

workflow Workflow

optional

Type:
  • SimpleSchema

(static) OrderTransaction Schema :SimpleSchema

Order transactions tie Shipping, Payment, and Inventory transactions

Source:
Properties:
Name Type Description
itemId String

optional

paymentId String

optional

shipmentId String

optional

inventoryId String

optional

createdAt Date

required

Type:
  • SimpleSchema

(static) PackageConfig :SimpleSchema

The PackageConfig is part of the configuration settings required for packages in the Registry. The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
shopId String

Autovalue removed here

name String

required

enabled Boolean

defalut value: true

icon String

optional

settings Object

optional

registry Array.<Registry>

optional

layout Array.<Layout>

optional

Type:
  • SimpleSchema

(static) Payment :SimpleSchema

Source:
Properties:
Name Type Attributes Description
_id String

Payment ID

address Address <optional>

Billing address

amount Number

The amount paid or authorized

cardBrand String <optional>

The brand of card, if the payment method was a credit card

currency CurrencyExchangeRate <optional>

The exchange rate, if the user's currency is different from shop's

data Object <optional>

Arbitrary data that the payment method needs

invoice Invoice

A summary of the totals that make up the full charge amount. Created when the payment is added to an order.

shopId String

The ID of the shop that is being paid. This might be a merchant shop in a marketplace setup.

Type:
  • SimpleSchema

(static) Payment :SimpleSchema

Source:
Properties:
Name Type Description
type String

required

amount Number

required

created Number

required

currency String

required

raw Object

optional, blackbox

Type:
  • SimpleSchema

(static) paymentDataSchema :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Permissions :SimpleSchema

The Permissions schema is part of the Registry. The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
permission String
label String
Type:
  • SimpleSchema

(static) PriceRange :SimpleSchema

Source:
Properties:
Name Type Description
range, String

default value: "0.00"

min Number

optional, default value: 0

max Number

optional, default value: 0

Type:
  • SimpleSchema

(static) Product :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Product ID

ancestors Array.<String>

default value: []

createdAt Date

required

currentProductHash String

optional

description String

optional

facebookMsg String

optional

googleplusMsg String

optional

handle String

optional, slug

hashtags Array.<String>

optional

isBackorder Boolean

denormalized, true if product not in stock, but customers anyway could order it

isDeleted, Boolean

default value: false

isLowQuantity Boolean

denormalized, true when at least 1 variant is below lowInventoryWarningThreshold

isSoldOut Boolean

denormalized, Indicates when all variants inventoryQuantity is zero

isVisible, Boolean

default value: false

metaDescription String

optional

metafields Array.<Metafield>

optional

originCountry String

optional

pageTitle String

optional

parcel ShippingParcel

optional

pinterestMsg String

optional

price PriceRange

denormalized, object with range string, min and max

productType String

optional

publishedAt Date

optional

publishedProductHash String

optional

shopId String

Product ShopID

shouldAppearInSitemap Boolean

optional, whether this product should appear in auto-generated sitemap.xml

supportedFulfillmentTypes Array.<String>

Types of fulfillment ("shipping", "pickup", etc) allowed for this product

template, String

default value: "productDetailSimple"

title String

Product Title

twitterMsg String

optional

type String

default value: "simple"

updatedAt Date

optional

vendor String

optional

workflow Workflow

optional

Type:
  • SimpleSchema

(static) ProductVariant :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required, Variant ID

ancestors, Array.<String>

default value: []

barcode String

optional

compareAtPrice Number

optional, Compare at price

createdAt Date

optional

eventLog Array.<Event>

optional, Variant Event Log

height Number

optional, default value: 0

index Number

optional, Variant position number in list. Keep array index for moving variants in a list.

inventoryManagement, Boolean

default value: true

inventoryPolicy, Boolean

default value: false, If disabled, item can be sold even if it not in stock.

inventoryQuantity, Number

default value: 0

isDeleted, Boolean

default value: false

isLowQuantity Boolean

optional, true when at least 1 variant is below lowInventoryWarningThreshold

isSoldOut Boolean

optional, denormalized field, indicates when all variants inventoryQuantity is 0

isVisible, Boolean

default value: false

length Number

optional, default value: 0

lowInventoryWarningThreshold, Number

default value: 0, Warn of low inventory at this number

metafields Array.<Metafield>

optional

minOrderQuantity Number

optional

optionTitle, String

Option internal name, default value: "Untitled option"

originCountry String

optional

price, Number

default value: 0.00

shopId String

required, Variant ShopId

sku String

optional

taxable, Boolean

default value: true

taxCode, String

default value: "0000"

taxDescription String

optional

title, String

Label for customers, default value: ""

type, String

default value: "variant"

updatedAt Date

optional

weight, Number

default value: 0

width Number

optional, default value: 0

workflow Workflow

optional

Type:
  • SimpleSchema

(static) Profile :SimpleSchema

Source:
Properties:
Name Type Description
addressBook Array.<Address>

optional, array of Addresses

invited Boolean

optional

name String

optional

picture String

optional

bio String

optional

username String

optional

currency String

User currency

Type:
  • SimpleSchema

(static) ReactLayout :SimpleSchema

Source:
Properties:
Name Type Description
shopId String

Template ShopId

name String

required

title String

optional

priority Number

optional, default value: 1

enabled Boolean

default value: true

route String

optional

type String

default value: template

provides String

default value: template

block String

optional

defaultData Object

optional, blackbox

parser String

required

language String

optional, default value: en

source String

optional

templateFor Array.<String>

optional

template Array.<Object>

optional, blackbox

Type:
  • SimpleSchema

(static) Registry :SimpleSchema

The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
provides Array.<String>

Legacy provides apps use a String rather than an array. These are transformed in loadPackages.

route String

optional

name String

optional, Registry name must be unique. Namespace your plugin (e.g. yourorg-plugin-name) to avoid conflicts.

template String

optional, Assign to a Blaze template

workflow String

optional, A layout for a template in the package

layout String

optional, Force the app to render a specific layout

triggersEnter Array.<String>

optional, Trigger on Enter

triggersExit Array.<String>

optional, Trigger on Exit

options Object

optional, Routing Options

description String

optional, deprecated

icon String

optional, A set of CSS classes, often Font Awesome classes, used to define the package in the sidebar.

label String

optional, Human-readable name for a Registry entry

container String

optional, Used to group plugins

priority Number

optional, Plugin load order. Lower values loaded first.

enabled Boolean

optional, Enable or not

permissions Array.<Permissions>

optional, Define a new user permission

audience Array.<String>

optional, Define what permissions are required to view a step in a workflow

meta Object

optional, Set dashboardSize for the actionView

showForShopTypes Array.<String>

optional, Shop Types this plugin should show for

hideForShopTypes Array.<String>

optional, Shop Types this plugin should not show for

Type:
  • SimpleSchema

(static) SearchPackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) SelectedFulfillmentOption :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Shipment method Id

carrier String

optional

currencyCode String

Currency code for interpreting rate and handling

group String

Group, allowed values: Ground, Priority, One Day, Free

handling Number

optional, default value: 0

label String

Public label

name String

Method name

rate Number

Rate

Type:
  • SimpleSchema

(static) SellerShop :SimpleSchema

SellerShop schema

Source:
Type:
  • SimpleSchema

(static) Shipment :SimpleSchema

Used for cart/order shipment tracking

Source:
Properties:
Name Type Description
_id String

Shipment ID

shopId String

required

paymentId String

Payment ID

address Address

optional

shipmentMethod ShippingMethod

optional

shipmentQuotes Array.<ShipmentQuote>

optional

shipmentQuotesQueryStatus ShipmentQuotesQueryStatus

optional

tracking String

optional

type String

The fulfillment type. Currently only "shipping" supported

parcel ShippingParcel

optional

workflow Workflow

optional

invoice Invoice

optional

itemIds Array.<String>

Required on an order but not on a cart, this is set to a denormalized list of item IDs when a cart is converted to an order

transactions Array.<Object>

optional

shippingLabelUrl String

For printable Shipping label

customsLabelUrl String

For customs printable label

shippo ShippoShipment

For Shippo specific properties

Type:
  • SimpleSchema

(static) ShipmentQuote :SimpleSchema

Source:
Properties:
Name Type Description
carrier String

Name of carrier

method ShippingMethod

ShippingMethod

rate Number

default value: 0.00

Type:
  • SimpleSchema

(static) ShipmentQuotesQueryStatusUsed :SimpleSchema

Status of a query/consumption of a shipping provider's API (e.g Shippo) for shipping quotations.

Source:
To Do:
  • Should requestStatus be required or not?
Properties:
Name Type Description
requestStatus String

optional, default value: noRequestsYet

shippingProvider String

optional

numOfShippingMethodsFound Number

optional

message String

optional

Shipping quotations are the costs from different shipping methods like FedEx, DHL etc of shipping one or more items to a particular place in a given amount of time.)

Type:
  • SimpleSchema

(static) Shipping :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

shopId String

required

name String

optional

provider ShippingProvider

optional

methods Array.<ShippingMethod>

optional

shipmentQuotes Array.<ShipmentQuote>

optional

Type:
  • SimpleSchema

(static) ShippingMethod :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Shipment method Id

name String

Method name

label String

Public label

group String

Group, allowed values: Ground, Priority, One Day, Free

cost Number

optional

handling Number

optional, default value: 0

rate Number

Rate

enabled Boolean

default value: false

validRanges Array

optional, Matching cart ranges

Properties
Name Type Description
$ Object

optional

begin Number

optional

end Number

optional

validLocales Array

optional

Properties
Name Type Description
$ Object

optional

Properties
Name Type Description
origination String

optional

destination String

optional

deliveryBegin Number

optional

deliveryEnd Number

optional

carrier String

optional

settings ShippoShippingMethod

optional

Type:
  • SimpleSchema

(static) ShippingPackageConfig :SimpleSchema

Source:
Properties:
Name Type Description
settings.name String

default value: Flat Rate Service

Type:
  • SimpleSchema

(static) ShippingParcel :SimpleSchema

Source:
Properties:
Name Type Description
containers String

optional

length Number

optional

width Number

optional

height Number

optional

weight Number

optional

Type:
  • SimpleSchema

(static) ShippingProvider :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

name String

optional

label String

optional

enabled Boolean

optional, default value: true

serviceAuth String

optional

serviceSecret String

optional

serviceUrl String

optional

shippoProvider ShippoShippingProvider

optional

Type:
  • SimpleSchema

(static) ShippoShipment :SimpleSchema

Specific properties of Shipment for use with Shippo. We don't use

Source:
Properties:
Name Type Description
transactionId String

optional

trackingStatusStatus String

optional Tracking Status's status

trackingStatusDate String

optional

Type:
  • SimpleSchema

(static) ShippoShippingMethod :SimpleSchema

This will only exist in ShippingMethods Inside Cart/Order. This does not exist in DB Shipping Collection as Shippo Methods are Dynamic.

Source:
To Do:
  • Move Shippo-related schema to Shippo module
Properties:
Name Type Description
serviceLevelToken String

optional

rateId String

optional

Type:
  • SimpleSchema

(static) ShippoShippingProvider Schema :SimpleSchema

Specific properties for use with Shippo.

Source:
Properties:
Name Type Description
carrierAccountId String

optional

We don't use ShippingProvider service* fields because Shippo is on level higher service than simple carrier's ,e.g FedEx api.

Type:
  • SimpleSchema

(static) Shop :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

slug String

optional, auto-generated

merchantShops Array.<MerchantShop>

optional

shopType String

required, default value: merchant, accepted values: primary, merchant, affiliate

active Boolean

required, default value: true

status String

default value: active

name String
description String

optional

keywords String

optional

addressBook Array.<Address>

optional

domains Array.<String>

default value: [localhost]

emails Array.<Email>

optional

defaultPaymentMethod String

required, default value: none

currency String

default value: USD

currencies Object

optional, blackbox, Currency schema

locales Locale

required

language String

default value: en

languages Array.<Languages>

optional

public String

optional

timezone String

default value: US/Pacific

baseUOL String

Base UOL (Unit of Length), default value: in, lowercased by default per style

unitsOfLength Array.<Object>

optional, default value: in

Properties
Name Type Description
$.uol String

default value: in

$.label String

default value: Inches

$.default Boolean

default value: false

baseUOM String

Base UOM (Unit of Measure), default value: oz, lowercased by default per style

unitsOfMeasure Array.<Object>

optional

Properties
Name Type Description
$.uom String

default value: oz

$.label String

default value: Ounces

$.default Boolean

default value: false

metafields Array.<Metafield>

optional

defaultSellerRoles Array.<String>

default values: ["owner", "admin", "seller", "guest", "manage-users", "orders", "account/profile", "product", "createProduct", "tag", "index", "cart/checkout", "cart/completed"]

layout Array.<Layout>

optional

theme ShopTheme

optional

brandAssets Array.<BrandAsset>

optional

appVersion String

optional

createdAt Date

optional

updatedAt Date

optional

paymentMethods Array.<Object>

blackbox, default value: []

availablePaymentMethods Array.<String>

default value: []

workflow Workflow

optional

Type:
  • SimpleSchema

(static) ShopTheme :SimpleSchema

Source:
Properties:
Name Type Description
themeId String

required

styles String

optional

Type:
  • SimpleSchema

(static) ShopTypes :SimpleSchema

ShopTypes schema

Source:
Type:
  • SimpleSchema

(static) SitemapsSchema :SimpleSchema

Schema for Sitemaps collection

Source:
Type:
  • SimpleSchema

(static) SocialMetadata :SimpleSchema

Source:
Properties:
Name Type Description
message String

required

service String

required

Type:
  • SimpleSchema

(static) SocialPackageConfig :SimpleSchema

Source:
Properties:
Name Type Description
settings.public Object

optional

Properties
Name Type Description
apps Object

optional

Properties
Name Type Description
facebook SocialProvider

optional, Facebook

Properties
Name Type Description
appId String

optional, Facebook App ID

appSecret String

optional, Facebook App Secret

twitter SocialProvider

optional, Twitter

Properties
Name Type Description
username String

optional, Twitter username

pinterest SocialProvider

optional, Pinterest

googleplus SocialProvider

optional, Google+

Type:
  • SimpleSchema

(static) SocialProvider :SimpleSchema

Source:
Properties:
Name Type Description
profilePage String

optional, Profile Page

enabled Boolean

optional, default value: false

Type:
  • SimpleSchema

(static) StripeConnectAuthorizationCredentials :SimpleSchema

Source:
See:
Type:
  • SimpleSchema

(static) StripeConnectAuthorizationCredentials :SimpleSchema

Source:
See:
Type:
  • SimpleSchema

(static) StripeMarketplacePackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) StripePackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Tag :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

name String

required

slug String

required

type String

optional

metafields Array.<Metafield>

optional

position Number

optional

relatedTagIds Array.<String>

optional

isDeleted Boolean

default value: false

isTopLevel Boolean

required

isVisible Boolean

defalut value: true

groups Array.<String>

optional, default value: [], groupIds that this tag belongs to

shopId String

Tag shopId

createdAt Date

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) TaxCodes :SimpleSchema

TaxCodes schema

Source:
Type:
  • SimpleSchema

(static) Taxes :SimpleSchema

Taxes schema

Source:
Type:
  • SimpleSchema

(static) TaxPackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) TaxRates :SimpleSchema

TaxRates schema

Source:
Type:
  • SimpleSchema

(static) TaxSettings :SimpleSchema

Source:
Properties:
Name Type Description
exemptionNo String

optional

customerUsageType String

optional

Type:
  • SimpleSchema

(static) Transactions :SimpleSchema

Discounts Tranaction History Schema

Source:

The Discounts Schema validates using multiple schemas. Be sure to use { selector: { discountMethod: "code" } } to indicate which schema to apply in all updates

Type:
  • SimpleSchema

(static) Translation :SimpleSchema

Source:
To Do:
  • Mostly just a blackbox for now. Someday we'll validate the entire schema
Properties:
Name Type Description
shopId, String

Translation ShopId

language, String

language

i18n, String

translation

ns, String

namespace

translation, Object

blackbox

Type:
  • SimpleSchema

(static) VariantBaseSchema :SimpleSchema

Source:
Properties:
Name Type Description
options Array.<VariantBaseSchema>

optional

Type:
  • SimpleSchema

(static) VariantBaseSchema :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

barcode String

optional

createdAt Date

required

height Number

optional, default value: 0

index Number

required

inventoryManagement Boolean

required

inventoryPolicy Boolean

required

isLowQuantity Boolean

required

isSoldOut Boolean

required

isTaxable Boolean

required, default value: false

length Number

optional, default value: 0

lowInventoryWarningThreshold Number

optional, default value: 0

media Array.<ImageInfo>

optional

metafields Array.<Metafield>

optional

minOrderQuantity Number

optional, default value: 1

optionTitle String

optional

originCountry String

optional

price CatalogPriceRange

required

pricing Object

required

primaryImage ImageInfo

optional

shopId String

required

sku String

optional

taxCode String

optional, default value: "0000"

taxDescription String

optional

title String

optional

updatedAt Date

required

variantId String

required

weight Number

optional, default value: 0

width Number

optional, default value: 0

Type:
  • SimpleSchema

(static) VariantMedia :SimpleSchema

Source:
Properties:
Name Type Description
mediaId String

optional

priority Number

optional

metafields Array.<Metafield>

optional

updatedAt Date

optional

createdAt Date

required

Type:
  • SimpleSchema

(static) Workflow :SimpleSchema

Control view flow by attaching layout to a collection. Shop defaultWorkflow is defined in Shop.

Source:
Properties:
Name Type Description
status, String

default value: new

workflow Array.<String>

optional

Type:
  • SimpleSchema

Methods

(static) createdAtAutoValue() → {Date}

Helper method used for schema injection autoValue

Source:
Example
autoValue: createdAtAutoValue
Returns:

Date representing now if it's an insert

Type
Date

(static) schemaIdAutoValue() → {String}

Helper method used for schema injection autoValue

Source:
Example
autoValue: schemaIdAutoValue
Returns:

randomId

Type
String

(static) updatedAtAutoValue() → {Date}

Helper method used for schema injection autoValue

Source:
Example
autoValue: updatedAtAutoValue
Returns:

Date representing now

Type
Date

Schemas

Source:

Reaction uses SimpleSchema to apply basic content and structure validation to Collections. See full documentation.

Members

(static) Accounts :SimpleSchema

Source:
Properties:
Name Type Description
userId String

required

sessions Array.<String>

optional, Array of strings

shopId String

required

name String

optional

username String

optional

emails Array.<Email>

optional, Array of strings

acceptsMarketing Boolean

optional

state String

optional

taxSettings TaxSettings

optional

note String

optional

profile Profile

optional

groups Array.<String>

optional, Array of groupIds of the groups the user belongs to

metafields Array.<Metafield>

optional

createdAt Date

required

updatedAt Date

optional

Type:
  • SimpleSchema

(static) Address :SimpleSchema

Source:
Properties:
Name Type Description
_id String
fullName String

required

address1 String

required

address2 String
city String

required

company String
phone String

required

region String

required, State/Province/Region

postal String

required

country String

required

isCommercial Boolean

required

isBillingDefault Boolean

required

isShippingDefault Boolean

required

failedValidation Boolean
metafields Array.<Metafield>
Type:
  • SimpleSchema

(static) Assets :SimpleSchema

Source:
Properties:
Name Type Description
type String

required

name String

optional

ns String

optional, namespace for i18n. Allows to load translation for custom plugins.

path String

optional

content String

optional

Type:
  • SimpleSchema

(static) BrandAsset :SimpleSchema

Source:
Properties:
Name Type Description
mediaId String

optional

type String

optional

Type:
  • SimpleSchema

(static) cardSchema :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Cart :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required for check of users' carts

shopId String

required, Cart ShopId

accountId String

Account ID for account carts, or null for anonymous

anonymousAccessToken String

Token for accessing anonymous carts, null for account carts

email String

optional

items Array.<CartItem>

Array of CartItem optional

shipping Array.<Shipment>

Array of Shipment optional, blackbox

billing Array.<Payment>

Array of Payment optional, blackbox

sessionId String

Optional and deprecated

tax Number

tax rate

discount Number

optional

workflow Workflow

optional

createdAt Date

required

updatedAt Date

optional

Type:
  • SimpleSchema

(static) CartItem :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

addedAt String

required

attributes Array.<CartItemAttribute>

Attributes of this item

createdAt String

required

metafields Array.<Metafield>
optionTitle String

optionTitle from the selected variant

parcel ShippingParcel

Currently, parcel is in simple product schema. Need to include it here as well.

priceWhenAdded Money

The price+currency at the moment this item was added to this cart

productId String

required

productSlug String

Product slug

productType String

Product type

productVendor String

Product vendor

quantity Number

required

shopId String

Cart Item shopId

taxData Object

optional blackbox

taxRate Number

optional The rate that was multiplied by the item subtotal to get the item tax

title String

Cart Item title

transaction Object

Transaction associated with this item

updatedAt String

required

variantId String

required

variantTitle String

Title from the selected variant

Type:
  • SimpleSchema

(static) CartItemAttribute :SimpleSchema

Source:
Properties:
Name Type Description
label String

optional

value String

optional

Type:
  • SimpleSchema

(static) CartItems :SimpleSchema

Used in check by inventory/addReserve method

Source:
Properties:
Name Type Description
items Array.<CartItem>

an Array of CartItem optional

Type:
  • SimpleSchema

(static) Catalog :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

product Object

required optional

createdAt Date

required

shopId String

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) CatalogPriceRange :SimpleSchema

Source:
Properties:
Name Type Description
max Number

required

min Number

required

range String

required

Type:
  • SimpleSchema

(static) CatalogProduct :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

barcode String

optional

createdAt Date

required

description String

optional

height Number

optional, default value: 0

isBackorder Boolean

required

isDeleted Boolean

required, default value: false

isLowQuantity Boolean

required

isSoldOut Boolean

required

isTaxable Boolean

required, default value: false

isVisible Boolean

required, default value: false

length Number

optional, default value: 0

lowInventoryWarningThreshold Number

optional, default value: 0

media Array.<ImageInfo>

optional

metafields Array.<Metafield>

optional

metaDescription String

optional

minOrderQuantity Number

required, default value: 1

originCountry String

optional

pageTitle String

optional

parcel ShippingParcel

optional

price CatalogPriceRange

optional

pricing Object

required

primaryImage ImageInfo

optional

productId String

required

productType String

optional

shopId String

required

sku String

optional

slug String

optional

socialMetadata Array.<SocialMetadata>

optional

supportedFulfillmentTypes Array.<String>

Types of fulfillment ("shipping", "pickup", etc) allowed for this product

tagIds Array

optional

taxCode String

optional, default value: "0000"

taxDescription String

optional

title String

optional

type String

required, default value: product-simple

updatedAt Date

required

variants Array.<CatalogProductVariant>

optional

vendor String

optional

weight Number

optional, default value: 0

width Number

optional, default value: 0

Type:
  • SimpleSchema

(static) CorePackageConfig :SimpleSchema

The Core Package Config is part of the Registry. The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
settings.mail Object

optional, Mail settings

Properties
Name Type Description
user String

Mail user

password String

Mail password

host String

Mail host

port String

Mail port

settings.openexchangerates.appId String

OpenExchangeRates Id

settings.openexchangerates.refreshPeriod String

default value: "every 1 hour"

settings.google.clientId String

default value: null

settings.google.apiKey String

default value: null

settings.public Object

optional Settings in public are published to the client.

Properties
Name Type Description
allowGuestCheckout Boolean

allows guest checkout

settings.cart.cleanupDurationDays String

default value: "older than 3 days"

Type:
  • SimpleSchema

(static) Currency :SimpleSchema

Source:
Properties:
Name Type Description
symbol String

default value: $

format String

default value: %s%v

scale Number

optional, default value: 2

decimal String

optional, default value: .

thousand String

optional, default value: ,

rate Number

optional

Type:
  • SimpleSchema

(static) CurrencyExchangeRate :SimpleSchema

Source:
Properties:
Name Type Description
userCurrency, String

default value: "USD"

exchangeRate Number

optional

Type:
  • SimpleSchema

(static) CustomEmailSettings :SimpleSchema

Source:
Properties:
Name Type Description
service String

optional

username String

optional

password String

optional

host String

optional

port Number

optional

Type:
  • SimpleSchema

(static) DiscountCodes :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) DiscountCodesPackageConfig :SimpleSchema

A schema that extends discount schema with properties for discount codes.

Source:
Type:
  • SimpleSchema

(static) Discounts :SimpleSchema

Discounts schema

Source:
Type:
  • SimpleSchema

(static) DiscountsPackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Document :SimpleSchema

Source:
Properties:
Name Type Description
docId String

required

docType String

optional

Type:
  • SimpleSchema

(static) Email :SimpleSchema

Source:
Properties:
Name Type Description
provides String

optional

address String

required

verified Boolean

optional

Type:
  • SimpleSchema

(static) Emails :SimpleSchema

Source:
Properties:
Name Type Description
to String

required

from String

required

subject String

required

text String

optional

html String

optional

userId String

optional

jobId String

required

type String

optional

status String

optional

createdAt Date

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) EmailTemplates :SimpleSchema

EmailTemplates schema

Source:
Type:
  • SimpleSchema

(static) EnabledPackagesByShopType :SimpleSchema

EnabledPackagesByShopType schema

Source:
Type:
  • SimpleSchema

(static) Event for EventLog :SimpleSchema

Source:
Properties:
Name Type Description
title String

Event title required

type String

Event type required

description String

Event description optional

userId String

User who triggered event optional

trigger String

Action that triggered event optional

createdAt Date

required

Type:
  • SimpleSchema

(static) ExamplePackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) ExamplePayment :SimpleSchema

ExamplePayment schema

Source:
Type:
  • SimpleSchema

(static) ExportHistory :SimpleSchema

Source:
Properties:
Name Type Description
status String

(required) Whether the export attempt succeeded or failed

dateAttempted Date

(required) Date the export was attempted

exportMethod String

(required) Name of the export method (e.g. CSV, Shopify)

destinationIdentifier String

The identifier for this order on the remote system

shopId String

(required) The shop ID

Type:
  • SimpleSchema

(static, constant) exports.Template :SimpleSchema

Source:
Properties:
Name Type Description
shopId String

Template ShopId

name String

required

title String

optional

priority Number

optional, default value: 1

enabled Boolean

default value: true

route String

optional

type String

default value: template

provides String

default value: template

block String

optional

defaultData Object

optional, blackbox

parser String

required

language String

optional, default value: en

source String

optional

template Array.<Object>

optional, blackbox

Type:
  • SimpleSchema

(static) Group :SimpleSchema

Source:
Properties:
Name Type Description
name String

required

description String

optional

slug String

required

permissions Array.<String>

optional

shopId String

required

createdBy String

optional

createdAt Date

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) History :SimpleSchema

Source:
Properties:
Name Type Description
event String

required

value String

required

userId String

required

updatedAt String

required

Type:
  • SimpleSchema

(static) ImageInfo :SimpleSchema

Source:
Properties:
Name Type Description
priority Number

required

productId String

required

toGrid Number

required

variantId String

optional

URLs ImageSizes

required

Type:
  • SimpleSchema

(static) ImageSizes :SimpleSchema

Source:
Properties:
Name Type Description
large String

optional

medium String

optional

original String

optional

small String

optional

thumbnail String

optional

Type:
  • SimpleSchema

(static) Inventory :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional, inserted by Mongo, we need it for schema validation

shopId String

required, Inventory shopId

productId String

required

variantId String

required

orderItemId String

optional

workflow Workflow

optional

sku String

optional

metafields Array.<Metafield>

optional

documents Array.<Document>

optional

notes Array.<Notes>

optional

createdAt Date

optional, but consider it temporary: schema validation failing in method with required

updatedAt Date

optional

Type:
  • SimpleSchema

(static) Invoice :SimpleSchema

Source:
Properties:
Name Type Description
discounts Number

optional

effectiveTaxRate Number

The effective tax rate, for display

shipping Number

optional

subtotal Number

required

taxes Number

optional

total Number

required

Type:
  • SimpleSchema

(static) Languages :SimpleSchema

Source:
Properties:
Name Type Description
label String

required

i18n String

required

enabled, Boolean

default value: true

Type:
  • SimpleSchema

(static) Layout :SimpleSchema

Layout are used by the Shops and Packages schemas. Read more about Layouts in documentation

Source:
Properties:
Name Type Description
layout String

optional

workflow String

optional

template String

optional

collection String

optional

theme String

optional

enabled Boolean

default value: true

status String

optional

label String

optional

container String

optional

audience Array.<String>

optional

structure LayoutStructure

optional

priority Number

optional default value: 999 - Layouts are prioritized with lower numbers first.

position Number

optional default value: 1

Type:
  • SimpleSchema

(static) LayoutStructure :SimpleSchema

Layout are used by the Shops and Packages schemas. Layouts are used to in two ways: 1) Define the template layout on the site 2) Define workflow components used in each layout block

Source:
Properties:
Name Type Description
template String

optional

layoutHeader String

optional

layoutFooter String

optional

notFound String

optional

dashboardHeader String

optional

dashboardControls String

optional

dashboardHeaderControls String

optional

adminControlsFooter String

optional

Read more about Layouts in documentation

Type:
  • SimpleSchema

(static) Locale :SimpleSchema

Source:
Properties:
Name Type Description
continents Object

blackbox

countries Object

blackbox

Type:
  • SimpleSchema

(static) MarketplacePackageConfig :SimpleSchema

MarketplacePackageConfig schema

Source:
Type:
  • SimpleSchema

(static) MerchantShop :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Shop label

slug String

Shop slug

name String

Shop name

Type:
  • SimpleSchema

(static) Metafield :SimpleSchema

Source:
Properties:
Name Type Description
key String

optional

namespace String

optional

scope String

optional

value String

optional

valueType String

optional

description String

optional

Type:
  • SimpleSchema

(static) Notes :SimpleSchema

Source:
Properties:
Name Type Description
content String

required

userId String

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) Notification :SimpleSchema

Notification sends messages corresponding to the type:

  • orderCanceled : "Your order was canceled."
  • forAdmin : "You have a new order."
  • newOrder : "You just made an order."
  • orderDelivered : "Your order has been delivered."
  • orderProcessing: "Your order is being processed."
  • orderShipped : "Your order has been shipped."

Source:
Properties:
Name Type Description
message String

required

type String

required, types: orderCanceled, forAdmin, newOrder, orderDelivered, orderProcessing, orderShipped

url String

required

to String

required

hasDetails Boolean

required

details String

required

status String

required, default: unread

timeSent Date

required

Type:
  • SimpleSchema

(static) Order Schema :SimpleSchema

Order has an array of History, Documents, Notes, Items and OrderTransactions.

Source:
Properties:
Name Type Description
_id String

required

accountId String

Account ID for account orders, or null for anonymous

anonymousAccessToken String

Token for accessing anonymous carts, null for account carts

cartId String

optional For tracking which cart created this order

createdAt Date

required

currencyCode String

required

documents Array.<Document>

optional

email String

optional

exportHistory Array.<Object>

optional

history Array.<History>

optional

notes Array.<Notes>

optional

shipping Array.<Shipment>

Array of fulfillment groups

shopId String

required The owner shop

taxes Array.<Object>

Array of objects optional

transactions Array.<OrderTransaction>

optional

updatedAt Date

optional

workflow Workflow

optional

Type:
  • SimpleSchema

(static) OrderDiscount :SimpleSchema

Source:
Properties:
Name Type Description
amount Number

Amount of discount applied to the order

discountId String

Discount ID

Type:
  • SimpleSchema

(static) OrderFulfillmentGroup Schema :SimpleSchema

One fulfillment group of an order

Source:
Properties:
Name Type Description
_id String

Group ID

address Object

Shipping address

customsLabelUrl String

URL for customs label

invoice Object

Invoice (same as the one on Payment)

items Array.<Object>

The order items in this group

itemIds Array.<String>

For convenience, the _id of all the items

payment Object

The payment info for this group

shipmentMethod Object

The fulfillment method that was chosen by the customer

shippingLabelUrl String

URL for shipping label

shopId String

The shop that fulfills this group

totalItemQuantity Number

The total item quantity, sum of all quantities

tracking String

Tracking reference ID

type String

Fulfillment type

workflow Object

Current status and past statuses for this fulfillment

Type:
  • SimpleSchema

(static) OrderItem :SimpleSchema

Defines one item in an order

Source:
Properties:
Name Type Description
_id String

Unique ID for the item

addedAt String

Date/time when this was first added to the cart/order

createdAt String

Date/time when this order item was created

documents Array.<Document>

optional

history Array.<History>

optional

isTaxable Boolean

Is this item taxable?

optionTitle String

optionTitle from the selected variant

parcel ShippingParcel

Currently, parcel is in simple product schema. Need to include it here as well.

price Money

The price+currency of variantId at the moment the related order was placed

productId String

required

productSlug String

Product slug

productType String

Product type

productVendor String

Product vendor

quantity Number

required

shopId String

The owner shop

subtotal Number

The item subtotal, quantity x price

tax Number

Total tax collected for the item. Will be 0 if isTaxable is false.

taxRate Number

Tax rate that was used to calculate item tax. Will be 0 if isTaxable is false.

title String

Title from the selected product

updatedAt String

required

variantId String

required

variantTitle String

Title from the selected variant

workflow Workflow

optional

Type:
  • SimpleSchema

(static) OrderTransaction Schema :SimpleSchema

Order transactions tie Shipping, Payment, and Inventory transactions

Source:
Properties:
Name Type Description
itemId String

optional

paymentId String

optional

shipmentId String

optional

inventoryId String

optional

createdAt Date

required

Type:
  • SimpleSchema

(static) PackageConfig :SimpleSchema

The PackageConfig is part of the configuration settings required for packages in the Registry. The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
shopId String

Autovalue removed here

name String

required

enabled Boolean

defalut value: true

icon String

optional

settings Object

optional

registry Array.<Registry>

optional

layout Array.<Layout>

optional

Type:
  • SimpleSchema

(static) Payment :SimpleSchema

Source:
Properties:
Name Type Attributes Description
_id String

Payment ID

address Address <optional>

Billing address

amount Number

The amount paid or authorized

cardBrand String <optional>

The brand of card, if the payment method was a credit card

currency CurrencyExchangeRate <optional>

The exchange rate, if the user's currency is different from shop's

data Object <optional>

Arbitrary data that the payment method needs

invoice Invoice

A summary of the totals that make up the full charge amount. Created when the payment is added to an order.

shopId String

The ID of the shop that is being paid. This might be a merchant shop in a marketplace setup.

Type:
  • SimpleSchema

(static) Payment :SimpleSchema

Source:
Properties:
Name Type Description
type String

required

amount Number

required

created Number

required

currency String

required

raw Object

optional, blackbox

Type:
  • SimpleSchema

(static) paymentDataSchema :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Permissions :SimpleSchema

The Permissions schema is part of the Registry. The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
permission String
label String
Type:
  • SimpleSchema

(static) PriceRange :SimpleSchema

Source:
Properties:
Name Type Description
range, String

default value: "0.00"

min Number

optional, default value: 0

max Number

optional, default value: 0

Type:
  • SimpleSchema

(static) Product :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Product ID

ancestors Array.<String>

default value: []

createdAt Date

required

currentProductHash String

optional

description String

optional

facebookMsg String

optional

googleplusMsg String

optional

handle String

optional, slug

hashtags Array.<String>

optional

isBackorder Boolean

denormalized, true if product not in stock, but customers anyway could order it

isDeleted, Boolean

default value: false

isLowQuantity Boolean

denormalized, true when at least 1 variant is below lowInventoryWarningThreshold

isSoldOut Boolean

denormalized, Indicates when all variants inventoryQuantity is zero

isVisible, Boolean

default value: false

metaDescription String

optional

metafields Array.<Metafield>

optional

originCountry String

optional

pageTitle String

optional

parcel ShippingParcel

optional

pinterestMsg String

optional

price PriceRange

denormalized, object with range string, min and max

productType String

optional

publishedAt Date

optional

publishedProductHash String

optional

shopId String

Product ShopID

shouldAppearInSitemap Boolean

optional, whether this product should appear in auto-generated sitemap.xml

supportedFulfillmentTypes Array.<String>

Types of fulfillment ("shipping", "pickup", etc) allowed for this product

template, String

default value: "productDetailSimple"

title String

Product Title

twitterMsg String

optional

type String

default value: "simple"

updatedAt Date

optional

vendor String

optional

workflow Workflow

optional

Type:
  • SimpleSchema

(static) ProductVariant :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required, Variant ID

ancestors, Array.<String>

default value: []

barcode String

optional

compareAtPrice Number

optional, Compare at price

createdAt Date

optional

eventLog Array.<Event>

optional, Variant Event Log

height Number

optional, default value: 0

index Number

optional, Variant position number in list. Keep array index for moving variants in a list.

inventoryManagement, Boolean

default value: true

inventoryPolicy, Boolean

default value: false, If disabled, item can be sold even if it not in stock.

inventoryQuantity, Number

default value: 0

isDeleted, Boolean

default value: false

isLowQuantity Boolean

optional, true when at least 1 variant is below lowInventoryWarningThreshold

isSoldOut Boolean

optional, denormalized field, indicates when all variants inventoryQuantity is 0

isVisible, Boolean

default value: false

length Number

optional, default value: 0

lowInventoryWarningThreshold, Number

default value: 0, Warn of low inventory at this number

metafields Array.<Metafield>

optional

minOrderQuantity Number

optional

optionTitle, String

Option internal name, default value: "Untitled option"

originCountry String

optional

price, Number

default value: 0.00

shopId String

required, Variant ShopId

sku String

optional

taxable, Boolean

default value: true

taxCode, String

default value: "0000"

taxDescription String

optional

title, String

Label for customers, default value: ""

type, String

default value: "variant"

updatedAt Date

optional

weight, Number

default value: 0

width Number

optional, default value: 0

workflow Workflow

optional

Type:
  • SimpleSchema

(static) Profile :SimpleSchema

Source:
Properties:
Name Type Description
addressBook Array.<Address>

optional, array of Addresses

invited Boolean

optional

name String

optional

picture String

optional

bio String

optional

username String

optional

currency String

User currency

Type:
  • SimpleSchema

(static) ReactLayout :SimpleSchema

Source:
Properties:
Name Type Description
shopId String

Template ShopId

name String

required

title String

optional

priority Number

optional, default value: 1

enabled Boolean

default value: true

route String

optional

type String

default value: template

provides String

default value: template

block String

optional

defaultData Object

optional, blackbox

parser String

required

language String

optional, default value: en

source String

optional

templateFor Array.<String>

optional

template Array.<Object>

optional, blackbox

Type:
  • SimpleSchema

(static) Registry :SimpleSchema

The Registry Schema allows package settings to be defined. For more, read the in-depth Intro to Architecture: The Registry.

Source:
Properties:
Name Type Description
provides Array.<String>

Legacy provides apps use a String rather than an array. These are transformed in loadPackages.

route String

optional

name String

optional, Registry name must be unique. Namespace your plugin (e.g. yourorg-plugin-name) to avoid conflicts.

template String

optional, Assign to a Blaze template

workflow String

optional, A layout for a template in the package

layout String

optional, Force the app to render a specific layout

triggersEnter Array.<String>

optional, Trigger on Enter

triggersExit Array.<String>

optional, Trigger on Exit

options Object

optional, Routing Options

description String

optional, deprecated

icon String

optional, A set of CSS classes, often Font Awesome classes, used to define the package in the sidebar.

label String

optional, Human-readable name for a Registry entry

container String

optional, Used to group plugins

priority Number

optional, Plugin load order. Lower values loaded first.

enabled Boolean

optional, Enable or not

permissions Array.<Permissions>

optional, Define a new user permission

audience Array.<String>

optional, Define what permissions are required to view a step in a workflow

meta Object

optional, Set dashboardSize for the actionView

showForShopTypes Array.<String>

optional, Shop Types this plugin should show for

hideForShopTypes Array.<String>

optional, Shop Types this plugin should not show for

Type:
  • SimpleSchema

(static) SearchPackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) SelectedFulfillmentOption :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Shipment method Id

carrier String

optional

currencyCode String

Currency code for interpreting rate and handling

group String

Group, allowed values: Ground, Priority, One Day, Free

handling Number

optional, default value: 0

label String

Public label

name String

Method name

rate Number

Rate

Type:
  • SimpleSchema

(static) SellerShop :SimpleSchema

SellerShop schema

Source:
Type:
  • SimpleSchema

(static) Shipment :SimpleSchema

Used for cart/order shipment tracking

Source:
Properties:
Name Type Description
_id String

Shipment ID

shopId String

required

paymentId String

Payment ID

address Address

optional

shipmentMethod ShippingMethod

optional

shipmentQuotes Array.<ShipmentQuote>

optional

shipmentQuotesQueryStatus ShipmentQuotesQueryStatus

optional

tracking String

optional

type String

The fulfillment type. Currently only "shipping" supported

parcel ShippingParcel

optional

workflow Workflow

optional

invoice Invoice

optional

itemIds Array.<String>

Required on an order but not on a cart, this is set to a denormalized list of item IDs when a cart is converted to an order

transactions Array.<Object>

optional

shippingLabelUrl String

For printable Shipping label

customsLabelUrl String

For customs printable label

shippo ShippoShipment

For Shippo specific properties

Type:
  • SimpleSchema

(static) ShipmentQuote :SimpleSchema

Source:
Properties:
Name Type Description
carrier String

Name of carrier

method ShippingMethod

ShippingMethod

rate Number

default value: 0.00

Type:
  • SimpleSchema

(static) ShipmentQuotesQueryStatusUsed :SimpleSchema

Status of a query/consumption of a shipping provider's API (e.g Shippo) for shipping quotations.

Source:
To Do:
  • Should requestStatus be required or not?
Properties:
Name Type Description
requestStatus String

optional, default value: noRequestsYet

shippingProvider String

optional

numOfShippingMethodsFound Number

optional

message String

optional

Shipping quotations are the costs from different shipping methods like FedEx, DHL etc of shipping one or more items to a particular place in a given amount of time.)

Type:
  • SimpleSchema

(static) Shipping :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

shopId String

required

name String

optional

provider ShippingProvider

optional

methods Array.<ShippingMethod>

optional

shipmentQuotes Array.<ShipmentQuote>

optional

Type:
  • SimpleSchema

(static) ShippingMethod :SimpleSchema

Source:
Properties:
Name Type Description
_id String

Shipment method Id

name String

Method name

label String

Public label

group String

Group, allowed values: Ground, Priority, One Day, Free

cost Number

optional

handling Number

optional, default value: 0

rate Number

Rate

enabled Boolean

default value: false

validRanges Array

optional, Matching cart ranges

Properties
Name Type Description
$ Object

optional

begin Number

optional

end Number

optional

validLocales Array

optional

Properties
Name Type Description
$ Object

optional

Properties
Name Type Description
origination String

optional

destination String

optional

deliveryBegin Number

optional

deliveryEnd Number

optional

carrier String

optional

settings ShippoShippingMethod

optional

Type:
  • SimpleSchema

(static) ShippingPackageConfig :SimpleSchema

Source:
Properties:
Name Type Description
settings.name String

default value: Flat Rate Service

Type:
  • SimpleSchema

(static) ShippingParcel :SimpleSchema

Source:
Properties:
Name Type Description
containers String

optional

length Number

optional

width Number

optional

height Number

optional

weight Number

optional

Type:
  • SimpleSchema

(static) ShippingProvider :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

name String

optional

label String

optional

enabled Boolean

optional, default value: true

serviceAuth String

optional

serviceSecret String

optional

serviceUrl String

optional

shippoProvider ShippoShippingProvider

optional

Type:
  • SimpleSchema

(static) ShippoShipment :SimpleSchema

Specific properties of Shipment for use with Shippo. We don't use

Source:
Properties:
Name Type Description
transactionId String

optional

trackingStatusStatus String

optional Tracking Status's status

trackingStatusDate String

optional

Type:
  • SimpleSchema

(static) ShippoShippingMethod :SimpleSchema

This will only exist in ShippingMethods Inside Cart/Order. This does not exist in DB Shipping Collection as Shippo Methods are Dynamic.

Source:
To Do:
  • Move Shippo-related schema to Shippo module
Properties:
Name Type Description
serviceLevelToken String

optional

rateId String

optional

Type:
  • SimpleSchema

(static) ShippoShippingProvider Schema :SimpleSchema

Specific properties for use with Shippo.

Source:
Properties:
Name Type Description
carrierAccountId String

optional

We don't use ShippingProvider service* fields because Shippo is on level higher service than simple carrier's ,e.g FedEx api.

Type:
  • SimpleSchema

(static) Shop :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

slug String

optional, auto-generated

merchantShops Array.<MerchantShop>

optional

shopType String

required, default value: merchant, accepted values: primary, merchant, affiliate

active Boolean

required, default value: true

status String

default value: active

name String
description String

optional

keywords String

optional

addressBook Array.<Address>

optional

domains Array.<String>

default value: [localhost]

emails Array.<Email>

optional

defaultPaymentMethod String

required, default value: none

currency String

default value: USD

currencies Object

optional, blackbox, Currency schema

locales Locale

required

language String

default value: en

languages Array.<Languages>

optional

public String

optional

timezone String

default value: US/Pacific

baseUOL String

Base UOL (Unit of Length), default value: in, lowercased by default per style

unitsOfLength Array.<Object>

optional, default value: in

Properties
Name Type Description
$.uol String

default value: in

$.label String

default value: Inches

$.default Boolean

default value: false

baseUOM String

Base UOM (Unit of Measure), default value: oz, lowercased by default per style

unitsOfMeasure Array.<Object>

optional

Properties
Name Type Description
$.uom String

default value: oz

$.label String

default value: Ounces

$.default Boolean

default value: false

metafields Array.<Metafield>

optional

defaultSellerRoles Array.<String>

default values: ["owner", "admin", "seller", "guest", "manage-users", "orders", "account/profile", "product", "createProduct", "tag", "index", "cart/checkout", "cart/completed"]

layout Array.<Layout>

optional

theme ShopTheme

optional

brandAssets Array.<BrandAsset>

optional

appVersion String

optional

createdAt Date

optional

updatedAt Date

optional

paymentMethods Array.<Object>

blackbox, default value: []

availablePaymentMethods Array.<String>

default value: []

workflow Workflow

optional

Type:
  • SimpleSchema

(static) ShopTheme :SimpleSchema

Source:
Properties:
Name Type Description
themeId String

required

styles String

optional

Type:
  • SimpleSchema

(static) ShopTypes :SimpleSchema

ShopTypes schema

Source:
Type:
  • SimpleSchema

(static) SitemapsSchema :SimpleSchema

Schema for Sitemaps collection

Source:
Type:
  • SimpleSchema

(static) SocialMetadata :SimpleSchema

Source:
Properties:
Name Type Description
message String

required

service String

required

Type:
  • SimpleSchema

(static) SocialPackageConfig :SimpleSchema

Source:
Properties:
Name Type Description
settings.public Object

optional

Properties
Name Type Description
apps Object

optional

Properties
Name Type Description
facebook SocialProvider

optional, Facebook

Properties
Name Type Description
appId String

optional, Facebook App ID

appSecret String

optional, Facebook App Secret

twitter SocialProvider

optional, Twitter

Properties
Name Type Description
username String

optional, Twitter username

pinterest SocialProvider

optional, Pinterest

googleplus SocialProvider

optional, Google+

Type:
  • SimpleSchema

(static) SocialProvider :SimpleSchema

Source:
Properties:
Name Type Description
profilePage String

optional, Profile Page

enabled Boolean

optional, default value: false

Type:
  • SimpleSchema

(static) StripeConnectAuthorizationCredentials :SimpleSchema

Source:
See:
Type:
  • SimpleSchema

(static) StripeConnectAuthorizationCredentials :SimpleSchema

Source:
See:
Type:
  • SimpleSchema

(static) StripeMarketplacePackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) StripePackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) Tag :SimpleSchema

Source:
Properties:
Name Type Description
_id String

optional

name String

required

slug String

required

type String

optional

metafields Array.<Metafield>

optional

position Number

optional

relatedTagIds Array.<String>

optional

isDeleted Boolean

default value: false

isTopLevel Boolean

required

isVisible Boolean

defalut value: true

groups Array.<String>

optional, default value: [], groupIds that this tag belongs to

shopId String

Tag shopId

createdAt Date

required

updatedAt Date

required

Type:
  • SimpleSchema

(static) TaxCodes :SimpleSchema

TaxCodes schema

Source:
Type:
  • SimpleSchema

(static) Taxes :SimpleSchema

Taxes schema

Source:
Type:
  • SimpleSchema

(static) TaxPackageConfig :SimpleSchema

Source:
Type:
  • SimpleSchema

(static) TaxRates :SimpleSchema

TaxRates schema

Source:
Type:
  • SimpleSchema

(static) TaxSettings :SimpleSchema

Source:
Properties:
Name Type Description
exemptionNo String

optional

customerUsageType String

optional

Type:
  • SimpleSchema

(static) Transactions :SimpleSchema

Discounts Tranaction History Schema

Source:

The Discounts Schema validates using multiple schemas. Be sure to use { selector: { discountMethod: "code" } } to indicate which schema to apply in all updates

Type:
  • SimpleSchema

(static) Translation :SimpleSchema

Source:
To Do:
  • Mostly just a blackbox for now. Someday we'll validate the entire schema
Properties:
Name Type Description
shopId, String

Translation ShopId

language, String

language

i18n, String

translation

ns, String

namespace

translation, Object

blackbox

Type:
  • SimpleSchema

(static) VariantBaseSchema :SimpleSchema

Source:
Properties:
Name Type Description
options Array.<VariantBaseSchema>

optional

Type:
  • SimpleSchema

(static) VariantBaseSchema :SimpleSchema

Source:
Properties:
Name Type Description
_id String

required

barcode String

optional

createdAt Date

required

height Number

optional, default value: 0

index Number

required

inventoryManagement Boolean

required

inventoryPolicy Boolean

required

isLowQuantity Boolean

required

isSoldOut Boolean

required

isTaxable Boolean

required, default value: false

length Number

optional, default value: 0

lowInventoryWarningThreshold Number

optional, default value: 0

media Array.<ImageInfo>

optional

metafields Array.<Metafield>

optional

minOrderQuantity Number

optional, default value: 1

optionTitle String

optional

originCountry String

optional

price CatalogPriceRange

required

pricing Object

required

primaryImage ImageInfo

optional

shopId String

required

sku String

optional

taxCode String

optional, default value: "0000"

taxDescription String

optional

title String

optional

updatedAt Date

required

variantId String

required

weight Number

optional, default value: 0

width Number

optional, default value: 0

Type:
  • SimpleSchema

(static) VariantMedia :SimpleSchema

Source:
Properties:
Name Type Description
mediaId String

optional

priority Number

optional

metafields Array.<Metafield>

optional

updatedAt Date

optional

createdAt Date

required

Type:
  • SimpleSchema

(static) Workflow :SimpleSchema

Control view flow by attaching layout to a collection. Shop defaultWorkflow is defined in Shop.

Source:
Properties:
Name Type Description
status, String

default value: new

workflow Array.<String>

optional

Type:
  • SimpleSchema

Methods

(static) createdAtAutoValue() → {Date}

Helper method used for schema injection autoValue

Source:
Example
autoValue: createdAtAutoValue
Returns:

Date representing now if it's an insert

Type
Date

(static) schemaIdAutoValue() → {String}

Helper method used for schema injection autoValue

Source:
Example
autoValue: schemaIdAutoValue
Returns:

randomId

Type
String

(static) updatedAtAutoValue() → {Date}

Helper method used for schema injection autoValue

Source:
Example
autoValue: updatedAtAutoValue
Returns:

Date representing now

Type
Date