Queries

channel

Type: Channel

Retrieves a single Channel instance

Arguments

Name	Description
id Int!	ID for the Channel instance

channels

Type: [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

commissionOverride

Type: CommissionOverride

Retrieves a single Commission override instance

Arguments

Name	Description
id Int!	ID for the Commission override instance

commissionOverrides

Type: [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

consignment

Type: Consignment

Retrieves a single Consignment instance

Arguments

Name	Description
id Int!	ID for the Consignment instance

consignmentItem

Type: ConsignmentItem

Retrieves a single Consignment item instance

Arguments

Name	Description
id Int!	ID for the Consignment item instance

consignmentItems

Type: [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

consignmentItemSurcharge

Type: ConsignmentItemSurcharge

Retrieves a single Consignment item surcharge instance

Arguments

Name	Description
id Int!	ID for the Consignment item surcharge instance

consignmentItemSurcharges

Type: [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

consignments

Type: [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

fulfillment

Type: Fulfillment

Retrieves a single Fulfillment instance

Arguments

Name	Description
id Int!	ID for the Fulfillment instance

fulfillmentItem

Type: FulfillmentItem

Retrieves a single Fulfillment item instance

Arguments

Name	Description
id Int!	ID for the Fulfillment item instance

fulfillmentItems

Type: [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

fulfillments

Type: [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

manualItem

Type: ManualItem

Retrieves a single Manual item instance

Arguments

Name	Description
id Int!	ID for the Manual item instance

manualItems

Type: [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

order

Type: Order

Retrieves a single Order instance

Arguments

Name	Description
id Int!	ID for the Order instance

orderItem

Type: OrderItem

Retrieves a single Order item instance

Arguments

Name	Description
id Int!	ID for the Order item instance

orderItems

Type: [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

orders

Type: [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

payment

Type: Payment

Retrieves a single Payment instance

Arguments

Name	Description
id Int!	ID for the Payment instance

payments

Type: [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

product

Type: Product

Retrieves a single Product instance

Arguments

Name	Description
id Int!	ID for the Product instance

products

Type: [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

seller

Type: Seller

Retrieves a single Seller instance

Arguments

Name	Description
id Int!	ID for the Seller instance

sellers

Type: [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

sellerVariant

Type: SellerVariant

Retrieves a single Seller variant instance

Arguments

Name	Description
id Int!	ID for the Seller variant instance

sellerVariants

Type: [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

surcharge

Type: Surcharge

Retrieves a single Surcharge instance

Arguments

Name	Description
id Int!	ID for the Surcharge instance

surcharges

Type: [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

taxRate

Type: TaxRate

Retrieves a single Tax rate instance

Arguments

Name	Description
id Int!	ID for the Tax rate instance

taxRates

Type: [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

tenant

Type: Tenant

Retrieves a single Tenant instance

Arguments

Name	Description
id Int!	ID for the Tenant instance

totalDue

Type: TotalDue

Arguments

Name	Description
id Int!

totalPaid

Type: TotalPaid

Arguments

Name	Description
id Int!

user

Type: User

Retrieves a single User instance

Arguments

Name	Description
id Int!	ID for the User instance

users

Type: [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

variant

Type: Variant

Retrieves a single Variant instance

Arguments

Name	Description
id Int!	ID for the Variant instance

variants

Type: [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