Mutations

channel

Type: Channel

Creates a new Channel instance

Arguments

Name	Description
name String
storeUrl String
fullStoreUrl String
enabled Boolean
accessToken String
setupStatus ChannelsetupStatusEnumType
processTags [String]

commissionOverride

Type: CommissionOverride

Creates a new Commission override instance

Arguments

Name	Description
commissionType CommissionOverridecommissionTypeEnumType
name String
commission Int
tags [String]
productTypes [String]

consignment

Type: Consignment

Creates a new Consignment instance

Arguments

Name	Description
sellerId Int
orderId Int

consignmentItem

Type: ConsignmentItem

Creates a new Consignment item instance

Arguments

Name	Description
consignmentId Int
orderItemId Int
paymentId Int
quantity Int
due String
dueBase String
exchangeRate String
taxBase String
tax String
taxRate String
isPaid String

consignmentItemSurcharge

Type: ConsignmentItemSurcharge

Creates a new Consignment item surcharge instance

Arguments

Name	Description
surchargeId Int
consignmentItemId Int
paymentId Int
value String

destroyChannel

Type: Channel

Deletes a Channel

Arguments

Name	Description
id Int!	ID for the Channel instance

destroyCommissionOverride

Type: CommissionOverride

Deletes a Commission override

Arguments

Name	Description
id Int!	ID for the Commission override instance

destroyConsignment

Type: Consignment

Deletes a Consignment

Arguments

Name	Description
id Int!	ID for the Consignment instance

destroyConsignmentItem

Type: ConsignmentItem

Deletes a Consignment item

Arguments

Name	Description
id Int!	ID for the Consignment item instance

destroyConsignmentItemSurcharge

Type: ConsignmentItemSurcharge

Deletes a Consignment item surcharge

Arguments

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

destroyFulfillment

Type: Fulfillment

Deletes a Fulfillment

Arguments

Name	Description
id Int!	ID for the Fulfillment instance

destroyFulfillmentItem

Type: FulfillmentItem

Deletes a Fulfillment item

Arguments

Name	Description
id Int!	ID for the Fulfillment item instance

destroyManualItem

Type: ManualItem

Deletes a Manual item

Arguments

Name	Description
id Int!	ID for the Manual item instance

destroyOrder

Type: Order

Deletes a Order

Arguments

Name	Description
id Int!	ID for the Order instance

destroyOrderItem

Type: OrderItem

Deletes a Order item

Arguments

Name	Description
id Int!	ID for the Order item instance

destroyPayment

Type: Payment

Deletes a Payment

Arguments

Name	Description
id Int!	ID for the Payment instance

destroyProduct

Type: Product

Deletes a Product

Arguments

Name	Description
id Int!	ID for the Product instance

destroySeller

Type: Seller

Deletes a Seller

Arguments

Name	Description
id Int!	ID for the Seller instance

destroySellerVariant

Type: SellerVariant

Deletes a Seller variant

Arguments

Name	Description
id Int!	ID for the Seller variant instance

destroySurcharge

Type: Surcharge

Deletes a Surcharge

Arguments

Name	Description
id Int!	ID for the Surcharge instance

destroyTaxRate

Type: TaxRate

Deletes a Tax rate

Arguments

Name	Description
id Int!	ID for the Tax rate instance

destroyUser

Type: User

Deletes a User

Arguments

Name	Description
id Int!	ID for the User instance

destroyVariant

Type: Variant

Deletes a Variant

Arguments

Name	Description
id Int!	ID for the Variant instance

forgotPassword

Type: Success

Arguments

Name	Description
email String

fulfillment

Type: Fulfillment

Creates a new Fulfillment instance

Arguments

Name	Description
orderId Int
externalId String

fulfillmentItem

Type: FulfillmentItem

Creates a new Fulfillment item instance

Arguments

Name	Description
fulfillmentId Int
orderItemId Int
externalId String

login

Type: User

Arguments

Name	Description
email String
password String

manualItem

Type: ManualItem

Creates a new Manual item instance

Arguments

Name	Description
sellerId Int
consignmentId Int
paymentId Int
name String
value String
valueBase String

order

Type: Order

Creates a new Order instance

Arguments

Name	Description
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

orderItem

Type: OrderItem

Creates a new Order item instance

Arguments

Name	Description
variantId Int
orderId Int
externalId String
externalVariantId String
quantity Int
price Int
totalDiscount Int
subtotal Int
title String
name String

payment

Type: Payment

Creates a new Payment instance

Arguments

Name	Description
sellerId Int
name String
notes String
amount String
additional String
tax String

product

Type: Product

Creates a new Product instance

Arguments

Name	Description
externalId String
handle String
title String
vendor String
productType String
tags [String]
images JSON
status ProductstatusEnumType

resetPassword

Type: User

Arguments

Name	Description
password String
resetToken String

seller

Type: Seller

Creates a new Seller instance

Arguments

Name	Description
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
iso String
manualExchangeRate Boolean
exchangeRate String

sellerVariant

Type: SellerVariant

Creates a new Seller variant instance

Arguments

Name	Description
variantId Int
sellerId Int
sku String

surcharge

Type: Surcharge

Creates a new Surcharge instance

Arguments

Name	Description
applyTo SurchargeapplyToEnumType
name String
value String
tags [String]
productTypes [String]

taxRate

Type: TaxRate

Creates a new Tax rate instance

Arguments

Name	Description
name String
isDefault Boolean
multiple Boolean
stateTaxName String
stateTaxValue String
districtTaxName String
countyTaxName String

updateChannel

Type: Channel

Updates an existing Channel instance

Arguments

Name	Description
id Int!	ID for the Channel instance
name String
storeUrl String
fullStoreUrl String
enabled Boolean
accessToken String
setupStatus ChannelsetupStatusEnumType
processTags [String]

updateCommissionOverride

Type: CommissionOverride

Updates an existing Commission override instance

Arguments

Name	Description
id Int!	ID for the Commission override instance
commissionType CommissionOverridecommissionTypeEnumType
name String
commission Int
tags [String]
productTypes [String]

updateConsignment

Type: Consignment

Updates an existing Consignment instance

Arguments

Name	Description
id Int!	ID for the Consignment instance
sellerId Int
orderId Int

updateConsignmentItem

Type: ConsignmentItem

Updates an existing Consignment item instance

Arguments

Name	Description
id Int!	ID for the Consignment item instance
consignmentId Int
orderItemId Int
paymentId Int
quantity Int
due String
dueBase String
exchangeRate String
taxBase String
tax String
taxRate String
isPaid String

updateConsignmentItemSurcharge

Type: ConsignmentItemSurcharge

Updates an existing Consignment item surcharge instance

Arguments

Name	Description
id Int!	ID for the Consignment item surcharge instance
surchargeId Int
consignmentItemId Int
paymentId Int
value String

updateFulfillment

Type: Fulfillment

Updates an existing Fulfillment instance

Arguments

Name	Description
id Int!	ID for the Fulfillment instance
orderId Int
externalId String

updateFulfillmentItem

Type: FulfillmentItem

Updates an existing Fulfillment item instance

Arguments

Name	Description
id Int!	ID for the Fulfillment item instance
fulfillmentId Int
orderItemId Int
externalId String

updateManualItem

Type: ManualItem

Updates an existing Manual item instance

Arguments

Name	Description
id Int!	ID for the Manual item instance
sellerId Int
consignmentId Int
paymentId Int
name String
value String
valueBase String

updateOrder

Type: Order

Updates an existing Order instance

Arguments

Name	Description
id Int!	ID for the Order instance
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

updateOrderItem

Type: OrderItem

Updates an existing Order item instance

Arguments

Name	Description
id Int!	ID for the Order item instance
variantId Int
orderId Int
externalId String
externalVariantId String
quantity Int
price Int
totalDiscount Int
subtotal Int
title String
name String

updatePayment

Type: Payment

Updates an existing Payment instance

Arguments

Name	Description
id Int!	ID for the Payment instance
sellerId Int
name String
notes String
amount String
additional String
tax String

updateProduct

Type: Product

Updates an existing Product instance

Arguments

Name	Description
id Int!	ID for the Product instance
externalId String
handle String
title String
vendor String
productType String
tags [String]
images JSON
status ProductstatusEnumType

updateSeller

Type: Seller

Updates an existing Seller instance

Arguments

Name	Description
id Int!	ID for the Seller instance
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
iso String
manualExchangeRate Boolean
exchangeRate String

updateSellerVariant

Type: SellerVariant

Updates an existing Seller variant instance

Arguments

Name	Description
id Int!	ID for the Seller variant instance
variantId Int
sellerId Int
sku String

updateSurcharge

Type: Surcharge

Updates an existing Surcharge instance

Arguments

Name	Description
id Int!	ID for the Surcharge instance
applyTo SurchargeapplyToEnumType
name String
value String
tags [String]
productTypes [String]

updateTaxRate

Type: TaxRate

Updates an existing Tax rate instance

Arguments

Name	Description
id Int!	ID for the Tax rate instance
name String
isDefault Boolean
multiple Boolean
stateTaxName String
stateTaxValue String
districtTaxName String
countyTaxName String

updateTenant

Type: Tenant

Updates an existing Tenant instance

Arguments

Name	Description
id Int!	ID for the Tenant instance
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

updateUser

Type: User

Updates an existing User instance

Arguments

Name	Description
id Int!	ID for the User instance
sellerId Int
hash String
email String
password String
token String
resetToken String
active Boolean
orderNotifications Boolean
paymentNotifications Boolean
scope UserscopeEnumType
locale UserlocaleEnumType

updateVariant

Type: Variant

Updates an existing Variant instance

Arguments

Name	Description
id Int!	ID for the Variant instance
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

user

Type: User

Creates a new User instance

Arguments

Name	Description
sellerId Int
hash String
email String
password String
token String
resetToken String
active Boolean
orderNotifications Boolean
paymentNotifications Boolean
scope UserscopeEnumType
locale UserlocaleEnumType

variant

Type: Variant

Creates a new Variant instance

Arguments

Name	Description
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