Objects

Channel

Represents a sales or distribution channel through which consignment items are sold or promoted, like an online marketplace or a physical store.

Fields

Name	Description
id Int!
tenantId Int
name String
storeUrl String
fullStoreUrl String
enabled Boolean
accessToken String
setupStatus ChannelsetupStatusEnumType
processTags [String]
createdAt Date!
updatedAt Date!
tenant Tenant

CommissionOverride

Allows for customizing the base commission rate for sellers. This model can define rules for automated adjustments to the standard commission based on specific criteria.

Fields

Name	Description
id Int!
tenantId Int
commissionType CommissionOverridecommissionTypeEnumType
name String
commission Int
tags [String]
productTypes [String]
createdAt Date!
updatedAt Date!
tenant Tenant

Consignment

Represents a consignment agreement or batch, which includes a collection of items provided by a seller to be sold on their behalf.

Fields

Name	Description
id Int!
tenantId Int
sellerId Int
orderId Int
createdAt Date!
updatedAt Date!
tenant Tenant
seller Seller
order Order
consignmentItems [ConsignmentItem]
manualItems [ManualItem]

ConsignmentItem

A specific item within a consignment. This model tracks individual products included in a consignment agreement, along with their details and status.

Fields

Name	Description
id Int!
tenantId Int
consignmentId Int
orderItemId Int
paymentId Int
quantity Int
due String
dueBase String
exchangeRate String
taxBase String
tax String
taxRate String
isPaid String
createdAt Date!
updatedAt Date!
tenant Tenant
consignment Consignment
orderItem OrderItem
payment Payment
consignmentItemSurcharges [ConsignmentItemSurcharge]

ConsignmentItemSurcharge

Defines an automated fee (either an additional charge or a discount) applied to a consignment item. This could be based on various factors like item category, value, or condition.

Fields

Name	Description
id Int!
tenantId Int
surchargeId Int
consignmentItemId Int
paymentId Int
value String
createdAt Date!
updatedAt Date!
tenant Tenant
surcharge Surcharge
consignmentItem ConsignmentItem
payment Payment

Fulfillment

Manages the process of fulfilling orders, from picking and packing to shipping. This model tracks the status and logistics of order fulfillment.

Fields

Name	Description
id Int!
tenantId Int
orderId Int
externalId String
createdAt Date!
updatedAt Date!
tenant Tenant
order Order

FulfillmentItem

Represents an individual item within a fulfillment process. This includes tracking each product as it moves through the stages of order fulfillment.

Fields

Name	Description
id Int!
tenantId Int
fulfillmentId Int
orderItemId Int
externalId String
createdAt Date!
updatedAt Date!
tenant Tenant
fulfillment Fulfillment
orderItem OrderItem

ManualItem

Represents items that are manually added to the system and not linked to an existing product variant, like gift cards or custom merchandise.

Fields

Name	Description
id Int!
tenantId Int
sellerId Int
consignmentId Int
paymentId Int
name String
value String
valueBase String
createdAt Date!
updatedAt Date!
tenant Tenant
seller Seller
consignment Consignment
payment Payment

Order

Represents a customer's order, encompassing various items purchased, payment information, and shipping details. This is central to the sales process.

Fields

Name	Description
id Int!
tenantId Int
channelId Int
externalId String
reference String
orderedAt Date
cancelledAt Date
closedAt Date
currency String
email String
phone String
financialStatus OrderfinancialStatusEnumType
fulfillmentStatus OrderfulfillmentStatusEnumType
taxesIncluded Boolean
shippingAddressCompany String
shippingAddressFirstName String
shippingAddressLastName String
shippingAddressAddressOne String
shippingAddressAddressTwo String
shippingAddressPhone String
shippingAddressCity String
shippingAddressState String
shippingAddressZip String
shippingAddressCountry String
billingAddressCompany String
billingAddressFirstName String
billingAddressLastName String
billingAddressAddressOne String
billingAddressAddressTwo String
billingAddressPhone String
billingAddressCity String
billingAddressState String
billingAddressZip String
billingAddressCountry String
createdAt Date!
updatedAt Date!
tenant Tenant
orderItems [OrderItem]
consignments [Consignment]
channel Channel

OrderItem

An individual item within an order. This model details the specific products or services purchased in each order.

Fields

Name	Description
id Int!
tenantId Int
variantId Int
orderId Int
externalId String
externalVariantId String
quantity Int
price Int
totalDiscount Int
subtotal Int
title String
name String
createdAt Date!
updatedAt Date!
tenant Tenant
consignmentItems [ConsignmentItem]
variant Variant
order Order

Payment

Manages payment transactions. This includes tracking payment methods, processing status, and linking payments to the relevant orders and customers.

Fields

Name	Description
id Int!
tenantId Int
sellerId Int
name String
notes String
amount String
additional String
tax String
createdAt Date!
updatedAt Date!
tenant Tenant
consignmentItems [ConsignmentItem]
consignmentItemSurcharges [ConsignmentItemSurcharge]
manualItems [ManualItem]
seller Seller

Product

Represents a product available for sale. Pricing, inventory levels, and availability typically sit on the variants associated with the product

Fields

Name	Description
id Int!
tenantId Int
externalId String
handle String
title String
vendor String
productType String
tags [String]
images JSON
status ProductstatusEnumType
createdAt Date!
updatedAt Date!
tenant Tenant
variants [Variant]

RootQueryType

Fields

Name	Description
channels [Channel]	Retrieves a collection of Channel instances Arguments Name Description limit Int order String offset Int id Int tenantId Int name String storeUrl String fullStoreUrl String enabled Boolean accessToken String setupStatus ChannelsetupStatusEnumType processTags [String] createdAt Date updatedAt Date
channel Channel	Retrieves a single Channel instance Arguments Name Description id Int! ID for the Channel instance
commissionOverrides [CommissionOverride]	Retrieves a collection of Commission override instances Arguments Name Description limit Int order String offset Int id Int tenantId Int commissionType CommissionOverridecommissionTypeEnumType name String commission Int tags [String] productTypes [String] createdAt Date updatedAt Date
commissionOverride CommissionOverride	Retrieves a single Commission override instance Arguments Name Description id Int! ID for the Commission override instance
consignmentItemSurcharges [ConsignmentItemSurcharge]	Retrieves a collection of Consignment item surcharge instances Arguments Name Description limit Int order String offset Int id Int tenantId Int surchargeId Int consignmentItemId Int paymentId Int value String createdAt Date updatedAt Date
consignmentItemSurcharge ConsignmentItemSurcharge	Retrieves a single Consignment item surcharge instance Arguments Name Description id Int! ID for the Consignment item surcharge instance
consignmentItems [ConsignmentItem]	Retrieves a collection of Consignment item instances Arguments Name Description limit Int order String offset Int id Int tenantId Int consignmentId Int orderItemId Int paymentId Int quantity Int due String dueBase String exchangeRate String taxBase String tax String taxRate String isPaid String createdAt Date updatedAt Date
consignmentItem ConsignmentItem	Retrieves a single Consignment item instance Arguments Name Description id Int! ID for the Consignment item instance
consignments [Consignment]	Retrieves a collection of Consignment instances Arguments Name Description limit Int order String offset Int id Int tenantId Int sellerId Int orderId Int createdAt Date updatedAt Date
consignment Consignment	Retrieves a single Consignment instance Arguments Name Description id Int! ID for the Consignment instance
fulfillmentItems [FulfillmentItem]	Retrieves a collection of Fulfillment item instances Arguments Name Description limit Int order String offset Int id Int tenantId Int fulfillmentId Int orderItemId Int externalId String createdAt Date updatedAt Date
fulfillmentItem FulfillmentItem	Retrieves a single Fulfillment item instance Arguments Name Description id Int! ID for the Fulfillment item instance
fulfillments [Fulfillment]	Retrieves a collection of Fulfillment instances Arguments Name Description limit Int order String offset Int id Int tenantId Int orderId Int externalId String createdAt Date updatedAt Date
fulfillment Fulfillment	Retrieves a single Fulfillment instance Arguments Name Description id Int! ID for the Fulfillment instance
manualItems [ManualItem]	Retrieves a collection of Manual item instances Arguments Name Description limit Int order String offset Int id Int tenantId Int sellerId Int consignmentId Int paymentId Int name String value String valueBase String createdAt Date updatedAt Date
manualItem ManualItem	Retrieves a single Manual item instance Arguments Name Description id Int! ID for the Manual item instance
orderItems [OrderItem]	Retrieves a collection of Order item instances Arguments Name Description limit Int order String offset Int id Int tenantId Int variantId Int orderId Int externalId String externalVariantId String quantity Int price Int totalDiscount Int subtotal Int title String name String createdAt Date updatedAt Date
orderItem OrderItem	Retrieves a single Order item instance Arguments Name Description id Int! ID for the Order item instance
orders [Order]	Retrieves a collection of Order instances Arguments Name Description limit Int order String offset Int id Int tenantId Int channelId Int externalId String reference String orderedAt Date cancelledAt Date closedAt Date currency String email String phone String financialStatus OrderfinancialStatusEnumType fulfillmentStatus OrderfulfillmentStatusEnumType taxesIncluded Boolean shippingAddressCompany String shippingAddressFirstName String shippingAddressLastName String shippingAddressAddressOne String shippingAddressAddressTwo String shippingAddressPhone String shippingAddressCity String shippingAddressState String shippingAddressZip String shippingAddressCountry String billingAddressCompany String billingAddressFirstName String billingAddressLastName String billingAddressAddressOne String billingAddressAddressTwo String billingAddressPhone String billingAddressCity String billingAddressState String billingAddressZip String billingAddressCountry String createdAt Date updatedAt Date
order Order	Retrieves a single Order instance Arguments Name Description id Int! ID for the Order instance
payments [Payment]	Retrieves a collection of Payment instances Arguments Name Description limit Int order String offset Int id Int tenantId Int sellerId Int name String notes String amount String additional String tax String createdAt Date updatedAt Date
payment Payment	Retrieves a single Payment instance Arguments Name Description id Int! ID for the Payment instance
products [Product]	Retrieves a collection of Product instances Arguments Name Description limit Int order String offset Int id Int tenantId Int externalId String handle String title String vendor String productType String tags [String] images JSON status ProductstatusEnumType createdAt Date updatedAt Date
product Product	Retrieves a single Product instance Arguments Name Description id Int! ID for the Product instance
sellerVariants [SellerVariant]	Retrieves a collection of Seller variant instances Arguments Name Description limit Int order String offset Int id Int tenantId Int variantId Int sellerId Int sku String createdAt Date updatedAt Date
sellerVariant SellerVariant	Retrieves a single Seller variant instance Arguments Name Description id Int! ID for the Seller variant instance
sellers [Seller]	Retrieves a collection of Seller instances Arguments Name Description limit Int order String offset Int id Int tenantId Int taxRateId Int name String firstName String lastName String addressOne String addressTwo String city String state String zip String country String phone String tags [String] vendors [String] productTypes [String] discountHandling SellerdiscountHandlingEnumType commissionType SellercommissionTypeEnumType commission Int notes String Internal notes for the seller iso String manualExchangeRate Boolean exchangeRate String createdAt Date updatedAt Date
seller Seller	Retrieves a single Seller instance Arguments Name Description id Int! ID for the Seller instance
totalDue TotalDue	Arguments Name Description id Int!
totalPaid TotalPaid	Arguments Name Description id Int!
surcharges [Surcharge]	Retrieves a collection of Surcharge instances Arguments Name Description limit Int order String offset Int id Int tenantId Int applyTo SurchargeapplyToEnumType name String value String tags [String] productTypes [String] createdAt Date updatedAt Date
surcharge Surcharge	Retrieves a single Surcharge instance Arguments Name Description id Int! ID for the Surcharge instance
taxRates [TaxRate]	Retrieves a collection of Tax rate instances Arguments Name Description limit Int order String offset Int id Int tenantId Int name String isDefault Boolean multiple Boolean stateTaxName String stateTaxValue String districtTaxName String countyTaxName String createdAt Date updatedAt Date
taxRate TaxRate	Retrieves a single Tax rate instance Arguments Name Description id Int! ID for the Tax rate instance
tenant Tenant	Retrieves a single Tenant instance Arguments Name Description id Int! ID for the Tenant instance
users [User]	Retrieves a collection of User instances Arguments Name Description limit Int order String offset Int id Int tenantId Int sellerId Int hash String email String password String token String resetToken String active Boolean orderNotifications Boolean paymentNotifications Boolean scope UserscopeEnumType locale UserlocaleEnumType createdAt Date updatedAt Date
user User	Retrieves a single User instance Arguments Name Description id Int! ID for the User instance
variants [Variant]	Retrieves a collection of Variant instances Arguments Name Description limit Int order String offset Int id Int tenantId Int productId Int sku String externalId String title String price Int compareAtPrice Int costPrice Int inventoryQuantity Int inventoryPolicy VariantinventoryPolicyEnumType inventoryManagement Boolean taxable Boolean barcode String image String options JSON createdAt Date updatedAt Date
variant Variant	Retrieves a single Variant instance Arguments Name Description id Int! ID for the Variant instance

Seller

Represents a consignor or supplier in the platform.

Fields

Name	Description
id Int!
tenantId Int
taxRateId Int
name String
firstName String
lastName String
addressOne String
addressTwo String
city String
state String
zip String
country String
phone String
tags [String]
vendors [String]
productTypes [String]
discountHandling SellerdiscountHandlingEnumType
commissionType SellercommissionTypeEnumType
commission Int
notes String	Internal notes for the seller
iso String
manualExchangeRate Boolean
exchangeRate String
createdAt Date!
updatedAt Date!
tenant Tenant
taxRate TaxRate
sellerVariants [SellerVariant]
payments [Payment]
manualItems [ManualItem]
consignments [Consignment]

SellerVariant

A variant of a product specifically tied to a seller. This model can track variations of a standard product offered by different sellers.

Fields

Name	Description
id Int!
tenantId Int
variantId Int
sellerId Int
sku String
createdAt Date!
updatedAt Date!
tenant Tenant
variant Variant
seller Seller

Success

Fields

Name	Description
status Boolean

Surcharge

Manages surcharges applied to products or orders. This model helps in calculating additional fees or discounts based on predefined rules or conditions.

Fields

Name	Description
id Int!
tenantId Int
applyTo SurchargeapplyToEnumType
name String
value String
tags [String]
productTypes [String]
createdAt Date!
updatedAt Date!
tenant Tenant
consignmentItemSurcharges [ConsignmentItemSurcharge]

TaxRate

Manages tax rates applicable to sellers, allowing tax to be dynamically added to consignments based on the location of the seller

Fields

Name	Description
id Int!
tenantId Int
name String
isDefault Boolean
multiple Boolean
stateTaxName String
stateTaxValue String
districtTaxName String
countyTaxName String
createdAt Date!
updatedAt Date!
tenant Tenant
sellers [Seller]

Tenant

Fields

Name	Description
id Int!
name String
logo String
plan String
subscriptionId String
subscriptionStatus TenantsubscriptionStatusEnumType
iso String
addressOne String
addressTwo String
city String
state String
zip String
country String
phone String
paymentNotes String
consignmentNotes String
trialDays Int
trialEnds String
trialDaysRemaining String
createdAt Date!
updatedAt Date!

TotalDue

Fields

Name	Description
manualItemsDue Float
due Float
surcharges Float

TotalPaid

Fields

Name	Description
amount Float
additional Float
tax Float
units Int

User

User will access to the platform. There are two types of users. First, admins, who would typically be the store owner. Secondly, sellers, who will have access to their consignment dashboard.

Fields

Name	Description
id Int!
tenantId Int
sellerId Int
hash String
email String
password String
token String
resetToken String
active Boolean
orderNotifications Boolean
paymentNotifications Boolean
scope UserscopeEnumType
locale UserlocaleEnumType
createdAt Date!
updatedAt Date!
tenant Tenant

Variant

Represents a specific version or variation of a product, such as different sizes, colors, or materials. This model helps in managing inventory at a granular level.

Fields

Name	Description
id Int!
tenantId Int
productId Int
sku String
externalId String
title String
price Int
compareAtPrice Int
costPrice Int
inventoryQuantity Int
inventoryPolicy VariantinventoryPolicyEnumType
inventoryManagement Boolean
taxable Boolean
barcode String
image String
options JSON
createdAt Date!
updatedAt Date!
tenant Tenant
sellerVariants [SellerVariant]
orderItems [OrderItem]
product Product