SDK entity fields

Generated from TypeScript SDK commit bc44313b702bcea4b5dae9516274404952e4d216. These are SDK property declarations, not a list of fields every user can read or write. Server models own validation, permissions and serialization. Optional properties can be absent until embedded or returned by an action. A nullable type does not guarantee that the server permits clearing that relationship.

Property names below use SDK camelCase. Raw form field names can differ; use the SDK serializer rather than translating names mechanically. Relationships need the relevant embed. Source links include custom workflow methods and property metadata. The API endpoint reference covers backend endpoints that may not yet have an SDK entity.

Address

Source and methods · Resource: addresses

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
lineOne?	string | null	Declaration
lineTwo?	string | null	Declaration
city?	string | null	Declaration
state?	string | null	Declaration
country?	string | null	Declaration
postcode?	string | null	Declaration
shipmentAsSenderAddress?	Shipment[]	Declaration
shipmentsAsReceiverAddress?	Shipment[]	Declaration
banks?	Bank[]	Declaration
users?	User[]	Declaration
inventories?	Inventory[]	Declaration
jobs?	Job[]	Declaration
productedJobs?	Job[]	Declaration
shippingTo?	Invoice[]	Declaration
companies?	Company[]	Declaration

AgentConversation

Source and methods · Resource: agent_conversations

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
conversationId?	string	Declaration
initialPrompt?	string	Declaration
creationDate?	Date | null	Declaration
entityType?	string | null	Declaration
entityId?	number | null	Declaration
serviceProvider?	number	Declaration
user?	User	Declaration
domain?	Domain	Declaration

AgentSkill

Source and methods · Resource: agent_skills

SDK property	Declared type	Source
id?	string	Declaration
slug?	string	Declaration
title?	string	Declaration
scope?	'global' | 'domain' | 'domain_category' | 'domain_product'	Declaration
domain?	Domain | null	Declaration
category?	Category | null	Declaration
product?	Product | null	Declaration
description?	string | null	Declaration
priority?	number	Declaration
createdAt?	Date | null	Declaration
disabledAt?	Date | null	Declaration
currentDraftVersionId?	string | null	Declaration
currentPublishedVersionId?	string | null	Declaration
versions?	AgentSkillVersion[]	Declaration

AgentSkillApproval

Source and methods · Resource: agent_skill_approvals

SDK property	Declared type	Source
id?	string	Declaration
skillVersionId?	string	Declaration
superUser?	User | null	Declaration
decision?	'approved' | 'rejected'	Declaration
comment?	string | null	Declaration
createdAt?	Date | null	Declaration

AgentSkillVersion

Source and methods · Resource: agent_skill_versions

SDK property	Declared type	Source
id?	string	Declaration
skillId?	string	Declaration
versionNumber?	number	Declaration
contentMd?	string	Declaration
contentHash?	string	Declaration
status?	string	Declaration
requestedAt?	Date | null	Declaration
publishedAt?	Date | null	Declaration
disabledAt?	Date | null	Declaration

AgentTokenUsage

Source and methods · Resource: agent_token_usage

SDK property	Declared type	Source
id?	number	Declaration
createdAt?	Date | null	Declaration
companyId?	number	Declaration
domainId?	number	Declaration
userId?	number	Declaration
company?	Company | null	Declaration
domain?	Domain | null	Declaration
user?	User | null	Declaration
agentConversation?	AgentConversation | null	Declaration
supportConversation?	SupportConversation | null	Declaration
agentConversationId?	number	Declaration
supportConversationId?	number	Declaration
sourceType?	string	Declaration
modelName?	string	Declaration
promptTokens?	number	Declaration
completionTokens?	number	Declaration
totalTokens?	number	Declaration

Assignment

Source and methods · Resource: assignments

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
managerAccepts?	Date | null	Declaration
supplierRefused?	Date | null	Declaration
needsDrafting?	boolean	Declaration
needsShipping?	boolean	Declaration
productionDeadline?	Date	Declaration
assignmentDeadline?	Date	Declaration
notes?	string | null	Declaration
job?	Job | null	Declaration
supplyJob?	Job | null	Declaration
supplier?	User | null	Declaration
quote?	Quote | null	Declaration
quoteTotalCost?	number	Declaration
comments?	ProductionComment[]	Declaration
shipment?	Shipment | null	Declaration
supplyDomain?	SupplyDomain | null	Declaration
notifications?	Notification[]	Declaration
reminders?	Reminder[]	Declaration
productionFiles?	MerchiFile[]	Declaration

AutomaticPaymentRelationship

Source and methods · Resource: automatic_payment_relationships

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
creationDate?	Date	Declaration
allowPostPayment?	boolean	Declaration
companyCustomer?	Company	Declaration
companySupplier?	Company	Declaration
stripeCustomerId?	string	Declaration

Bank

Source and methods · Resource: banks

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
default?	boolean	Declaration
bankName?	string	Declaration
accountNumber?	string	Declaration
accountName?	string	Declaration
bsb?	string | null	Declaration
swiftCode?	string | null	Declaration
iban?	string | null	Declaration
bankCode?	string | null	Declaration
bankAddress?	Address | null	Declaration
company?	Company	Declaration

Cart

Source and methods · Resource: carts

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
stripePaymentEngine?	string	Declaration
creationDate?	Date	Declaration
updated?	Date	Declaration
ip?	string | null	Declaration
token?	string | null	Declaration
receiverNotes?	string | null	Declaration
currency?	string	Declaration
cartItemsSubtotalCost?	number	Declaration
cartItemsTaxAmount?	number	Declaration
cartItemsTotalCost?	number	Declaration
shipmentTotalCost?	number	Declaration
subtotalCost?	number	Declaration
taxAmount?	number	Declaration
totalCost?	number	Declaration
sendWhatsapp?	boolean	Declaration
isTest?	boolean	Declaration
sourceChannel?	string | null	Declaration
utmSource?	string | null	Declaration
utmMedium?	string | null	Declaration
utmCampaign?	string | null	Declaration
utmContent?	string | null	Declaration
utmTerm?	string | null	Declaration
sourceClickId?	string | null	Declaration
sourceLanding?	string | null	Declaration
sourceReferrer?	string | null	Declaration
client?	User | null	Declaration
clientCompany?	Company | null	Declaration
domain?	Domain	Declaration
invoice?	Invoice | null	Declaration
receiverAddress?	Address | null	Declaration
discountItems?	Item[]	Declaration
cartItems?	CartItem[]	Declaration
shipmentGroups?	CartShipmentGroup[]	Declaration

CartItem

Source and methods · Resource: cart_items

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
quantity?	number	Declaration
notes?	string | null	Declaration
creationDate?	Date	Declaration
currency?	string	Declaration
subtotalCost?	number	Declaration
taxAmount?	number	Declaration
totalCost?	number	Declaration
product?	Product	Declaration
cart?	Cart	Declaration
taxType?	CountryTax	Declaration
variationsGroups?	VariationsGroup[]	Declaration
variations?	Variation[]	Declaration
tags?	DomainTag[]	Declaration
ownDrafts?	Draft[]	Declaration

CartShipmentGroup

Source and methods · Resource: cart_shipment_groups

SDK property	Declared type	Source
id?	number	Declaration
cartItems?	CartItem[]	Declaration
quotes?	CartShipmentQuote[]	Declaration
selectedQuote?	CartShipmentQuote	Declaration

CartShipmentQuote

Source and methods · Resource: cart_shipment_quotes

SDK property	Declared type	Source
id?	number	Declaration
name?	string	Declaration
subtotalCost?	number	Declaration
taxAmount?	number	Declaration
totalCost?	number	Declaration
shipmentService?	ShipmentService | null	Declaration
shipmentServiceQuote?	string	Declaration
shipmentMethod?	ShipmentMethod	Declaration

Category

Source and methods · Resource: categories

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
name?	string	Declaration
position?	number	Declaration
description?	string | null	Declaration
descriptionShort?	string | null	Declaration
showDashboard?	boolean	Declaration
showPublic?	boolean	Declaration
showPublicSupplierResell?	boolean	Declaration
descendant?	number	Declaration
domain?	Domain	Declaration
products?	Product[]	Declaration
users?	User[]	Declaration
subcategories?	Category[]	Declaration
parent?	Category	Declaration
image?	MerchiFile | null	Declaration

Company

Source and methods · Resource: companies

SDK property	Declared type	Source
archived?	Date | null	Declaration
created?	Date | null	Declaration
id?	number	Declaration
name?	string	Declaration
callToActions?	string	Declaration
callToActionDetails?	any[]	Declaration
website?	string | null	Declaration
ownershipUnconfirmed?	boolean	Declaration
taxNumber?	string | null	Declaration
taxNumberType?	string | null	Declaration
paypalAccount?	string | null	Declaration
paypalPassword?	string | null	Declaration
paypalSignature?	string | null	Declaration
isPaypalValid?	boolean	Declaration
isStripeAccountEnabled?	boolean	Declaration
stripeAccountId?	string	Declaration
stripeCustomerId?	string	Declaration
sendleActive?	boolean	Declaration
sendleApiKey?	string	Declaration
sendleId?	string	Declaration
unltdAiApiOrganizationId?	string	Declaration
unltdAiApiSecretKey?	string	Declaration
australiaPostApiKey?	string	Declaration
australiaPostPassword?	string	Declaration
startrackApiKey?	string	Declaration
startrackPassword?	string	Declaration
dhlApiKey?	string	Declaration
dhlApiSecret?	string	Declaration
dhlTrackingSandbox?	boolean	Declaration
dhlTrackingExpress?	boolean	Declaration
fedexApiKey?	string	Declaration
fedexApiSecret?	string	Declaration
upsClientId?	string	Declaration
upsClientSecret?	string	Declaration
uspsApiKey?	string	Declaration
tntApiKey?	string	Declaration
tntApiSecret?	string	Declaration
aramexAccountNumber?	string	Declaration
aramexApiKey?	string	Declaration
aramexApiSecret?	string	Declaration
nzPostApiKey?	string	Declaration
internalUseNotes?	string	Declaration
internalUseAiContext?	string	Declaration
aiContext?	string	Declaration
isNew?	boolean	Declaration
subscriptionOutstanding?	boolean	Declaration
trialEndDate?	Date | null	Declaration
trialEndDateUpdated?	Date | null	Declaration
trialEndDateSetBy?	User	Declaration
isBlocked?	boolean	Declaration
isTesting?	boolean	Declaration
squareAccessToken?	string | null	Declaration
squareRefreshToken?	string | null	Declaration
squareExpiresAt?	Date | null	Declaration
squareIsValid?	boolean	Declaration
squareMerchantId?	string | null	Declaration
squareWebLocationId?	string | null	Declaration
stripePublishableTestKey?	string | null	Declaration
stripeApiTestKey?	string | null	Declaration
stripePublishableKey?	string | null	Declaration
stripeApiKey?	string | null	Declaration
stripeConnectDisabled?	boolean	Declaration
isPayingCompany?	boolean	Declaration
isStripeValid?	boolean	Declaration
acceptSquare?	boolean	Declaration
acceptStripe?	boolean	Declaration
acceptPaypal?	boolean	Declaration
acceptUtrust?	boolean	Declaration
utrustApiKey?	string | null	Declaration
utrustWebhookKey?	string | null	Declaration
isUtrustValid?	boolean	Declaration
acceptBankTransfer?	boolean	Declaration
acceptPhonePayment?	boolean	Declaration
defaultCurrency?	string	Declaration
country?	string	Declaration
internalTags?	InternalTag[]	Declaration
logo?	MerchiFile | null	Declaration
defaultTaxType?	CountryTax | null	Declaration
automaticPaymentRelationships?	AutomaticPaymentRelationship[]	Declaration
taxTypes?	CountryTax[]	Declaration
paymentDevices?	PaymentDevice[]	Declaration
subscriptionPlan?	SubscriptionPlan | null	Declaration
_emailAddresses?	EmailAddress[]	Declaration
_paymentPhoneNumbers?	PhoneNumber[]	Declaration
_phoneNumbers?	PhoneNumber[]	Declaration
_addresses?	Address[]	Declaration
_users?	UserCompany[]	Declaration
shipmentsAsSender?	Shipment[]	Declaration
shipmentsAsReceiver?	Shipment[]	Declaration
savedProducts?	Product[]	Declaration
reminders?	Reminder[]	Declaration
banks?	Bank[]	Declaration
userCompanies?	UserCompany[]	Declaration
companyInvitations?	CompanyInvitation[]	Declaration
appliedJobs?	Job[]	Declaration
carts?	Cart[]	Declaration
domains?	Domain[]	Declaration
accessibleDomainsAsClientCompany?	Domain[]	Declaration
emailAddresses?	EmailAddress[]	Declaration
phoneNumbers?	PhoneNumber[]	Declaration
paymentPhoneNumbers?	PhoneNumber[]	Declaration
invoicesHas?	Invoice[]	Declaration
subscriptionInvoices?	Invoice[]	Declaration
addresses?	Address[]	Declaration
parentCompany?	Company | null	Declaration
childCompanies?	Company[]	Declaration

CompanyInvitation

Source and methods · Resource: company_invitations

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
userName?	string	Declaration
userEmail?	string	Declaration
inviteAsAdmin?	boolean	Declaration
token?	string	Declaration
company?	Company	Declaration
sender?	User	Declaration

CountryTax

Source and methods · Resource: country_taxes

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
country?	string | null	Declaration
taxName?	string	Declaration
taxPercent?	number | null	Declaration
shipments?	Shipment[]	Declaration
company?	Company	Declaration
jobs?	Job[]	Declaration
items?	Item[]	Declaration

Discount

Source and methods · Resource: discounts

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
lowerLimit?	number	Declaration
amount?	number	Declaration
usageLimit?	number	Declaration
isPercentage?	boolean	Declaration
code?	string	Declaration
assignedUsers?	User[]	Declaration
referrer?	User | null	Declaration
discountGroup?	DiscountGroup | null	Declaration

DiscountGroup

Source and methods · Resource: discount_groups

SDK property	Declared type	Source
archived?	Date | null	Declaration
created?	Date | null	Declaration
id?	number	Declaration
dateStart?	Date | null	Declaration
dateEnd?	Date | null	Declaration
discountType?	number	Declaration
discounts?	Discount[]	Declaration
name?	string	Declaration
groupRestricted?	boolean	Declaration
product?	Product | null	Declaration
domain?	Domain | null	Declaration

Domain

Source and methods · Resource: domains

SDK property	Declared type	Source
archived?	Date | null	Declaration
created?	Date | null	Declaration
id?	number	Declaration
domain?	string	Declaration
country?	string	Declaration
currency?	string	Declaration
callToActions?	string	Declaration
callToActionDetails?	any[]	Declaration
isMaster?	boolean	Declaration
deploymentOnline?	boolean	Declaration
deploymentInProgress?	boolean	Declaration
deploymentSucceeded?	boolean	Declaration
deploymentMessage?	string	Declaration
deploymentKey?	string	Declaration
internalUseNotes?	string	Declaration
internalUseAiContext?	string	Declaration
aiContext?	string	Declaration
domainType?	DomainType	Declaration
subDomain?	string	Declaration
emailDomain?	string	Declaration
smsName?	string	Declaration
whatsappPhoneNumberId?	string	Declaration
showDomainPublicly?	boolean	Declaration
publicAccessRestricted?	boolean	Declaration
showDomainToAccessibleEntitiesOnly?	boolean	Declaration
enableEmailNotifications?	boolean	Declaration
enableSmsNotifications?	boolean	Declaration
enableWhatsappNotifications?	boolean	Declaration
mailgunRecords?	any[]	Declaration
enableNotifications?	boolean	Declaration
assignToAgent?	boolean	Declaration
jobAgentPolicy?	{ toneInstructions?: string; outreach?: { clientMessaging?: 'auto' | 'team_draft_only'; sendEmail?: boolean; sendSms?: boolean; proactiveChase?: boolean; }; playbooks?: { deadlineAsk?: boolean; emailIntake?: boolean; drafting?: boolean; designerAssign?: boolean; productionTender?: boolean; shipment?: boolean; invoice?: boolean; }; } | null	Declaration
merchiAgentUser?	User | null	Declaration
trackingCodeGoogleConversion?	string | null	Declaration
trackingCodeGoogleGlobal?	string | null	Declaration
apiSecret?	string | null	Declaration
apiAllowedOrigins?	string[] | null	Declaration
webflowApiKey?	string | null	Declaration
telegramChatId?	string	Declaration
shopifyShopUrl?	string | null	Declaration
shopifyIsActive?	boolean	Declaration
qrShopQrCode?	string | null	Declaration
unltdAiApiOrganizationId?	string	Declaration
unltdAiApiSecretKey?	string	Declaration
scalablePressApiKey?	string	Declaration
googleMerchantApiKey?	string	Declaration
googleMerchantId?	string	Declaration
googleProductReviewsFeedEnabled?	boolean	Declaration
googleProductReviewsFeedToken?	string | null	Declaration
googleProductReviewsFeedUrl?	string | null	Declaration
socialBitchute?	string | null	Declaration
socialDiscord?	string | null	Declaration
socialFacebook?	string | null	Declaration
socialGoogle?	string | null	Declaration
socialInstagram?	string | null	Declaration
socialLinkedin?	string | null	Declaration
socialRumble?	string | null	Declaration
socialTelegram?	string | null	Declaration
socialTiktok?	string | null	Declaration
socialX?	string | null	Declaration
socialYoutube?	string | null	Declaration
ownedBy?	Company	Declaration
company?	Company	Declaration
logo?	MerchiFile | null	Declaration
favicon?	MerchiFile | null	Declaration
shipmentMethods?	ShipmentMethod[]	Declaration
activeTheme?	Theme	Declaration
internalTags?	InternalTag[]	Declaration
tags?	DomainTag[]	Declaration
canSupply?	Domain[]	Declaration
suppliedBy?	Domain[]	Declaration
accessibleClients?	User[]	Declaration
accessibleClientCompanies?	Company[]	Declaration
sessions?	Session[]	Declaration
categories?	Category[]	Declaration
notifications?	Notification[]	Declaration
reminders?	Reminder[]	Declaration
products?	Product[]	Declaration
supplyProducts?	SupplyDomain[]	Declaration
jobs?	Job[]	Declaration
jobsAssignees?	User[]	Declaration
carts?	Cart[]	Declaration
enrollments?	EnrolledDomain[]	Declaration
invoices?	Invoice[]	Declaration
domainInvitations?	DomainInvitation[]	Declaration
domainChatSettings?	DomainChatSettings | null	Declaration
themes?	Theme[]	Declaration

DomainChatSettings

Source and methods · Resource: domain_chat_settings

SDK property	Declared type	Source
id?	number	Declaration
domain?	Domain	Declaration
enabled?	boolean	Declaration
displayName?	string | null	Declaration
avatar?	MerchiFile | null	Declaration
welcomeMessage?	string | null	Declaration
privacyPolicyUrl?	string | null	Declaration
workingHours?	any | null	Declaration
awayMessage?	string | null	Declaration
notifyEmailNewConversation?	boolean	Declaration
notifyEmailNewMessage?	boolean	Declaration
telegramChatId?	string | null	Declaration
assignedUsers?	User[]	Declaration
requireGuestContact?	boolean	Declaration
embedTestMode?	boolean	Declaration
autoOpenDelay?	number | null	Declaration
autoOpenMessage?	string | null	Declaration
autoOpenMode?	string | null	Declaration
aiFallbackEnabled?	boolean	Declaration
aiFallbackScope?	'faq_only' | 'faq_and_status' | 'collect_and_escalate' | 'full_support_limited' | null	Declaration
aiDisclosureMode?	'on' | 'off' | null	Declaration
aiMaxRepliesPerConversation?	number | null	Declaration
aiCooldownSeconds?	number	Declaration
aiEscalationMessage?	string | null	Declaration

DomainInvitation

Source and methods · Resource: domain_invitations

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
userName?	string	Declaration
userEmail?	string	Declaration
role?	number	Declaration
token?	string	Declaration
domain?	Domain	Declaration
sender?	User	Declaration
user?	User | null	Declaration

DomainTag

Source and methods · Resource: domain_tags

SDK property	Declared type	Source
id?	number	Declaration
colour?	number	Declaration
name?	string	Declaration
description?	string	Declaration
showPublic?	boolean	Declaration
domain?	Domain	Declaration
jobs?	Job[]	Declaration
products?	Product[]	Declaration
invoices?	Invoice[]	Declaration
shipments?	Shipment[]	Declaration

Draft

Source and methods · Resource: drafts

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
date?	Date | null	Declaration
accepted?	Date | null	Declaration
resendDate?	Date | null	Declaration
viewed?	boolean	Declaration
sendSms?	boolean	Declaration
sendWhatsapp?	boolean	Declaration
sendEmail?	boolean	Declaration
comments?	DraftComment[]	Declaration
draftTemplates?	DraftTemplate[]	Declaration
commentsCount?	number	Declaration
changesRequested?	boolean	Declaration
designer?	User	Declaration
images?	MerchiFile[]	Declaration
notification?	Notification[]	Declaration
job?	Job	Declaration
sharedWithJobs?	Job[]	Declaration

DraftComment

Source and methods · Resource: draft_comments

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
date?	Date | null	Declaration
lastEditedTime?	Date | null	Declaration
urgency?	number	Declaration
text?	string	Declaration
changeRequest?	boolean	Declaration
sendSms?	boolean	Declaration
sendEmail?	boolean	Declaration
sendWhatsapp?	boolean	Declaration
user?	User	Declaration
lastEditedBy?	User	Declaration
files?	MerchiFile[]	Declaration
forwards?	User[]	Declaration
notifications?	Notification[]	Declaration
draft?	Draft | null	Declaration
job?	Job | null	Declaration

DraftPreview

Source and methods · Resource: draft_previews

SDK property	Declared type	Source
id?	number	Declaration
file?	MerchiFile	Declaration
product?	Product	Declaration
description?	string | null	Declaration
name?	string | null	Declaration
date?	Date | null	Declaration
height?	number	Declaration
width?	number	Declaration
draftPreviewLayers?	DraftPreviewLayer[]	Declaration

DraftPreviewLayer

Source and methods · Resource: draft_preview_layers

SDK property	Declared type	Source
id?	number	Declaration
layerName?	string	Declaration
draftPreview?	DraftPreview	Declaration
draftTemplate?	DraftTemplate	Declaration

DraftTemplate

Source and methods · Resource: draft_templates

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
date?	Date | null	Declaration
description?	string	Declaration
name?	string	Declaration
height?	number	Declaration
width?	number	Declaration
file?	MerchiFile	Declaration
design?	MerchiFile	Declaration
product?	Product | null	Declaration
job?	Job | null	Declaration
selectedByVariationFieldOptions?	VariationFieldsOption[]	Declaration
editedByVariationFields?	VariationField[]	Declaration
draftPreviewLayers?	DraftPreviewLayer[]	Declaration
customisationMap?	Record<string, unknown> | null	Declaration
customisationMapSource?	string | null	Declaration
customisationMapFileId?	string | null	Declaration

EmailAddress

Source and methods · Resource: email_addresses

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
emailAddress?	string	Declaration
users?	User[]	Declaration
companies?	Company[]	Declaration

EmailCounter

Source and methods · Resource: email_counters

SDK property	Declared type	Source
emailAddress?	string	Declaration
unsubscribed?	boolean	Declaration
silenced?	boolean	Declaration
tokens?	number	Declaration

EnrolledDomain

Source and methods · Resource: enrolled_domains

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
isJobsAssignee?	boolean	Declaration
role?	Role	Declaration
user?	User	Declaration
domain?	Domain	Declaration

ExchangeRate

Source and methods · Resource: exchange_rates

SDK property	Declared type	Source
id?	number	Declaration
fromCurrency?	string	Declaration
toCurrency?	string	Declaration
rate?	number	Declaration
lastUpdated?	Date	Declaration

MerchiFile

Source and methods · Resource: files

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
uploadId?	string	Declaration
name?	string | null	Declaration
mimetype?	string | null	Declaration
size?	number	Declaration
creationDate?	Date | null	Declaration
cachedViewUrl?	string | null	Declaration
viewUrlExpires?	Date | null	Declaration
cachedDownloadUrl?	string | null	Declaration
downloadUrlExpires?	Date | null	Declaration
uploader?	User | null	Declaration
viewUrl?	string	Declaration
downloadUrl?	string	Declaration
draftComments?	DraftComment[]	Declaration
variations?	Variation[]	Declaration
notification?	Notification[]	Declaration
companyLogos?	Company[]	Declaration
products?	Product[]	Declaration
featuredProducts?	Product[]	Declaration
drafts?	Draft[]	Declaration
options?	VariationFieldsOption[]	Declaration
jobComments?	JobComment[]	Declaration
jobNotes?	JobNote[]	Declaration
jobs?	Job[]	Declaration
clientJobs?	Job[]	Declaration
domainLogos?	Domain[]	Declaration
domainFavicons?	Domain[]	Declaration
userProfilePictures?	User[]	Declaration
invoices?	Invoice[]	Declaration
invoicesPaid?	Invoice[]	Declaration
themeMainCss?	Theme[]	Declaration
themeMainCssUsing?	Theme[]	Declaration
themeMainCssEditing?	Theme[]	Declaration
themeEmailCss?	Theme[]	Declaration
themeEmailCssUsing?	Theme[]	Declaration
themeEmailCssEditing?	Theme[]	Declaration
themes?	Theme[]	Declaration
themeFeatureImages?	Theme[]	Declaration
themeImages?	Theme[]	Declaration
productionComments?	ProductionComment[]	Declaration
quotes?	Quote[]	Declaration

InternalTag

Source and methods · Resource: internal_tags

SDK property	Declared type	Source
id?	number	Declaration
colour?	number	Declaration
name?	string	Declaration
description?	string	Declaration
companies?	Company[]	Declaration
domains?	Domain[]	Declaration
jobs?	Job[]	Declaration
products?	Product[]	Declaration
invoices?	Invoice[]	Declaration
shipments?	Shipment[]	Declaration
themes?	Theme[]	Declaration
users?	User[]	Declaration

Inventory

Source and methods · Resource: inventories

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
quantity?	number	Declaration
name?	string	Declaration
position?	number	Declaration
notes?	string	Declaration
isOrphan?	boolean	Declaration
products?	Product[]	Declaration
inventoryGroups?	InventoryGroup[]	Declaration
address?	Address | null	Declaration
variationsGroups?	VariationsGroup[]	Declaration
jobs?	Job[]	Declaration
inventoryUnitVariations?	InventoryUnitVariation[]	Declaration

InventoryGroup

Source and methods · Resource: inventory_groups

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
company?	Company	Declaration
inventories?	Inventory[]	Declaration
name?	string	Declaration
products?	Product[]	Declaration
jobs?	Job[]	Declaration
variationFields?	VariationField[]	Declaration

InventoryUnitVariation

Source and methods · Resource: inventory_unit_variations

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
inventory?	Inventory	Declaration
variationFieldsOption?	VariationFieldsOption	Declaration

Invoice

Source and methods · Resource: invoices

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
stripePaymentEngine?	string	Declaration
creationDate?	Date | null	Declaration
paymentDeadline?	Date | null	Declaration
reminded?	Date | null	Declaration
reminderMessage?	string	Declaration
shopifyOrderId?	string	Declaration
forceReminders?	boolean	Declaration
buySide?	boolean	Declaration
canAutoPay?	boolean	Declaration
note?	string | null	Declaration
terms?	Date | null	Declaration
subtotalCost?	number | null	Declaration
taxAmount?	number | null	Declaration
totalCost?	number | null	Declaration
sendSms?	boolean | null	Declaration
sendEmail?	boolean | null	Declaration
sendWhatsapp?	boolean | null	Declaration
unpaid?	boolean | null	Declaration
isTest?	boolean | null	Declaration
currency?	string	Declaration
acceptSquare?	boolean	Declaration
acceptStripe?	boolean	Declaration
acceptPaypal?	boolean	Declaration
acceptUtrust?	boolean	Declaration
acceptBankTransfer?	boolean	Declaration
acceptPhonePayment?	boolean	Declaration
invoiceToken?	string | null	Declaration
paymentUrl?	string	Declaration
isRemindable?	boolean	Declaration
owedMoney?	number	Declaration
paidMoney?	number	Declaration
isCompletelyPaid?	boolean	Declaration
responsibleManager?	User | null	Declaration
creator?	User | null	Declaration
client?	User	Declaration
clientCompany?	Company | null	Declaration
subscriptionCompanies?	Company[]	Declaration
shipping?	Address | null	Declaration
domain?	Domain	Declaration
items?	Item[]	Declaration
pdf?	MerchiFile | null	Declaration
receipt?	MerchiFile | null	Declaration
clientPhone?	PhoneNumber | null	Declaration
clientEmail?	EmailAddress | null	Declaration
clientCompanyPhone?	PhoneNumber | null	Declaration
clientCompanyEmail?	EmailAddress | null	Declaration
internalTags?	InternalTag[]	Declaration
tags?	DomainTag[]	Declaration
shipments?	Shipment[]	Declaration
notifications?	Notification[]	Declaration
reminders?	Reminder[]	Declaration
jobs?	Job[]	Declaration
quotes?	Quote[]	Declaration
cart?	Cart	Declaration
payments?	Payment[]	Declaration

Item

Source and methods · Resource: items

SDK property	Declared type	Source
archived?	Date | null	Declaration
code?	string	Declaration
id?	number	Declaration
quantity?	number | null	Declaration
description?	string	Declaration
cost?	number	Declaration
taxAmount?	number | null	Declaration
cart?	Cart | null	Declaration
discount?	Discount | null	Declaration
invoice?	Invoice | null	Declaration
job?	Job | null	Declaration
taxType?	CountryTax | null	Declaration

Job

Source and methods · Resource: jobs

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
jobType?	number	Declaration
quantity?	number	Declaration
currency?	string	Declaration
jobNotes?	JobNote[]	Declaration
operationLogs?	JobOperationLog[]	Declaration
shopifyShopUrl?	string | null	Declaration
shopifyOrderId?	string	Declaration
shopifyOrderLineItemId?	string	Declaration
productionStatus?	number | null	Declaration
productionQuotingSpec?	string | null	Declaration
productionSpecChanged?	boolean	Declaration
productionQuotingReopened?	boolean	Declaration
designStatus?	number | null	Declaration
supplyChainRequestStatus?	number | null	Declaration
needsDrafting?	boolean	Declaration
assignToAgent?	boolean	Declaration
agentLastRunAt?	Date | null	Declaration
agentNextCheckAt?	Date | null	Declaration
needsGroupBuy?	boolean	Declaration
needsProduction?	boolean	Declaration
needsShipping?	boolean	Declaration
sendWhatsapp?	boolean	Declaration
needsInvoicing?	boolean	Declaration
needsInventory?	boolean	Declaration
needsSupplyChainRequest?	boolean	Declaration
showProductionFilesToClient?	boolean	Declaration
allowClientDraftContribution?	boolean	Declaration
quoteSet?	boolean	Declaration
jobInfoApprovedByClient?	boolean	Declaration
groupBuyStatus?	number | null	Declaration
paymentStatus?	number | null	Declaration
deductionDate?	Date | null	Declaration
shippingStatus?	number | null	Declaration
completed?	boolean	Declaration
callToActions?	string	Declaration
callToActionDetails?	any[]	Declaration
priority?	number	Declaration
jobWeight?	number | null	Declaration
jobVolume?	number | null	Declaration
received?	Date	Declaration
deadline?	Date	Declaration
updated?	Date	Declaration
dateLastActioned?	Date | null	Declaration
dateFirstActioned?	Date | null	Declaration
groupBuyProductionStarted?	Date	Declaration
automaticPriceEnabled?	boolean	Declaration
dropShip?	boolean	Declaration
pickUp?	boolean	Declaration
costPerUnit?	number | null	Declaration
cost?	number | null	Declaration
taxAmount?	number | null	Declaration
totalCost?	number | null	Declaration
inventoriesStatus?	InventoryStatus	Declaration
unreadNotificationsCount?	number	Declaration
unreadJobInfoNotificationsCount?	number	Declaration
unreadJobDraftingNotificationsCount?	number	Declaration
unreadJobProductionNotificationsCount?	number	Declaration
unreadJobShippingNotificationsCount?	number	Declaration
unreadJobInvoicingNotificationsCount?	number	Declaration
limitedStock?	boolean	Declaration
inventoryCount?	number	Declaration
inventorySufficient?	boolean	Declaration
items?	Item[]	Declaration
drafts?	Draft[]	Declaration
sharedDrafts?	Draft[]	Declaration
ownDrafts?	Draft[]	Declaration
comments?	JobComment[]	Declaration
client?	User	Declaration
clientBrowser?	string	Declaration
clientDevice?	string	Declaration
clientOs?	string	Declaration
clientIp?	string	Declaration
clientOrigin?	string	Declaration
sourceChannel?	string | null	Declaration
utmSource?	string | null	Declaration
utmMedium?	string | null	Declaration
utmCampaign?	string | null	Declaration
utmContent?	string | null	Declaration
utmTerm?	string | null	Declaration
sourceClickId?	string | null	Declaration
sourceLanding?	string | null	Declaration
sourceReferrer?	string | null	Declaration
checkoutType?	string | null	Declaration
manager?	User | null	Declaration
designer?	User | null	Declaration
clientCompany?	Company | null	Declaration
notificationSubscribers?	User[]	Declaration
clientPhone?	PhoneNumber | null	Declaration
clientEmail?	EmailAddress | null	Declaration
clientCompanyPhone?	PhoneNumber | null	Declaration
clientCompanyEmail?	EmailAddress | null	Declaration
product?	Product	Declaration
supplyChainRequestProduct?	Product	Declaration
draftComments?	DraftComment[]	Declaration
preDraftCommentsCount?	number	Declaration
taxType?	CountryTax | null	Declaration
internalTags?	InternalTag[]	Declaration
tags?	DomainTag[]	Declaration
createdProducts?	Product[]	Declaration
shipping?	Address | null	Declaration
productionShippingAddress?	Address | null	Declaration
domain?	Domain	Declaration
invoice?	Invoice | null	Declaration
productionFiles?	MerchiFile[]	Declaration
clientFiles?	MerchiFile[]	Declaration
shipment?	Shipment | null	Declaration
matchingInventories?	MatchingInventory[]	Declaration
variationsGroups?	VariationsGroup[]	Declaration
variations?	Variation[]	Declaration
notifications?	Notification[]	Declaration
assignments?	Assignment[]	Declaration
reminders?	Reminder[]	Declaration
supplyAssignment?	Assignment	Declaration
supplyJob?	Job	Declaration
supplyQuoteTotalCost?	number	Declaration
hasValidVolume?	boolean	Declaration
hasValidWeight?	boolean	Declaration
isNewClient?	boolean	Declaration
isTest?	boolean	Declaration

JobComment

Source and methods · Resource: job_comments

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
date?	Date | null	Declaration
text?	string	Declaration
sendSms?	boolean	Declaration
sendEmail?	boolean	Declaration
sendWhatsapp?	boolean	Declaration
openToClient?	boolean	Declaration
urgency?	number	Declaration
files?	MerchiFile[]	Declaration
forwards?	User[]	Declaration
notifications?	Notification[]	Declaration
job?	Job	Declaration
user?	User	Declaration

JobNote

Source and methods · Resource: job_notes

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
noteType?	number	Declaration
richText?	string	Declaration
creationDate?	Date | null	Declaration
lastEditedTime?	Date | null	Declaration
files?	MerchiFile[]	Declaration
job?	Job	Declaration
createdBy?	User	Declaration
lastEditedBy?	User	Declaration

JobOperationLog

Source and methods · Resource: job_operation_logs

SDK property	Declared type	Source
id?	string	Declaration
job?	Job | null	Declaration
user?	User | null	Declaration
sourceType?	string	Declaration
aiInvolved?	boolean	Declaration
action?	string	Declaration
payloadJson?	Record<string, unknown> | null	Declaration
changesJson?	Record<string, unknown> | null	Declaration
operationJson?	Record<string, unknown> | null	Declaration
createdAt?	Date | null	Declaration

MatchingInventory

Source and methods · Resource: matching_inventories

SDK property	Declared type	Source
archived?	Date | null	Declaration
deductionDate?	Date | null	Declaration
job?	Job	Declaration
group?	VariationsGroup | null	Declaration
inventory?	Inventory | null	Declaration
status?	InventoryStatus	Declaration

Notification

Source and methods · Resource: notifications

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
notificationType?	number	Declaration
date?	Date	Declaration
emailOpenedAt?	Date | null	Declaration
seen?	boolean	Declaration
sendEmail?	boolean	Declaration
sendSms?	boolean	Declaration
urgency?	number	Declaration
description?	string | null	Declaration
subject?	string | null	Declaration
message?	string	Declaration
htmlMessage?	string	Declaration
link?	string | null	Declaration
section?	number	Declaration
shortUrl?	ShortUrl | null	Declaration
recipient?	User	Declaration
sender?	User | null	Declaration
relatedJob?	Job | null	Declaration
relatedDraft?	Draft | null	Declaration
relatedAssignment?	Assignment | null	Declaration
relatedInvoice?	Invoice | null	Declaration
relatedJobComment?	JobComment | null	Declaration
relatedDraftComment?	DraftComment | null	Declaration
relatedProductionComment?	ProductionComment | null	Declaration
domain?	Domain	Declaration
avatar?	MerchiFile | null	Declaration
attachment?	MerchiFile | null	Declaration
reminders?	Reminder[]	Declaration

Payment

Source and methods · Resource: payments

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
payDate?	Date	Declaration
paymentType?	number	Declaration
paymentProvider?	string	Declaration
paymentMethod?	string	Declaration
refundedAmount?	number	Declaration
refundStatus?	string | null	Declaration
note?	string	Declaration
amount?	number	Declaration
autoRefundable?	boolean	Declaration
refunded?	Date | null	Declaration
sendSms?	boolean	Declaration
sendEmail?	boolean	Declaration
invoice?	Invoice | null	Declaration
paymentRecorder?	User | null	Declaration
refundIssuer?	User | null	Declaration
chargedByPaymentRelationship?	AutomaticPaymentRelationship | null	Declaration

PaymentDevice

Source and methods · Resource: payment_devices

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
code?	string	Declaration
deviceId?	string	Declaration
squareId?	string	Declaration
deviceData?	string	Declaration
company?	Company | null	Declaration

PhoneNumber

Source and methods · Resource: phone_numbers

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
number?	string	Declaration
code?	string	Declaration
users?	User[]	Declaration
companies?	Company[]	Declaration
paymentCompanies?	Company[]	Declaration
localFormatNumber?	string	Declaration
internationalFormatNumber?	string	Declaration

Product

Source and methods · Resource: products

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
position?	number	Declaration
created?	Date	Declaration
updated?	Date	Declaration
storefrontLastDeployed?	Date | null	Declaration
createdBy?	User | null	Declaration
designer?	User | null	Declaration
updatedBy?	User | null	Declaration
productType?	number	Declaration
minimum?	number	Declaration
defaultQuantity?	number	Declaration
minimumPrice?	number	Declaration
setupPrice?	number	Declaration
setupPerGroup?	boolean	Declaration
minimumPerGroup?	boolean	Declaration
groupsFirst?	boolean	Declaration
deliveryDaysNormal?	number	Declaration
unitPrice?	number	Declaration
buyUnitPrice?	number	Declaration
unitPriceDiscountGroup?	DiscountGroup | null	Declaration
shipmentMethods?	ShipmentMethod[]	Declaration
margin?	number	Declaration
unitWeight?	number | null	Declaration
unitHeight?	number | null	Declaration
unitWidth?	number | null	Declaration
unitDepth?	number | null	Declaration
name?	string	Declaration
country?	string	Declaration
currency?	string	Declaration
description?	string | null	Declaration
notes?	string | null	Declaration
internalUseNotes?	string	Declaration
internalUseAiContext?	string	Declaration
aiContext?	string	Declaration
googleMerchantCenterId?	string	Declaration
googleMerchantCenterTitle?	string	Declaration
googleMerchantCenterDescription?	string	Declaration
googleMerchantCenterProductUrl?	string	Declaration
googleMerchantCenterPrice?	number	Declaration
shopifyProductId?	string | null	Declaration
spProductId?	string | null	Declaration
useCompanyShipmentMethods?	boolean	Declaration
dropShipment?	boolean	Declaration
needsDrafting?	boolean	Declaration
needsProduction?	boolean	Declaration
needsShipping?	boolean	Declaration
needsInvoicing?	boolean	Declaration
needsInventory?	boolean	Declaration
featureDeadline?	Date	Declaration
showFeatureDeadline?	boolean	Declaration
showPublic?	boolean	Declaration
isDraft?	boolean	Declaration
showGroupBuyStatus?	boolean	Declaration
groupBuyStatus?	number | null	Declaration
acceptSquare?	boolean	Declaration
acceptStripe?	boolean	Declaration
acceptPaypal?	boolean	Declaration
acceptUtrust?	boolean	Declaration
acceptBankTransfer?	boolean	Declaration
acceptPhonePayment?	boolean	Declaration
allowAddToCart?	boolean	Declaration
allowAutomaticPaymentSupply?	boolean	Declaration
allowGroupBuy?	boolean	Declaration
allowPaymentUpfront?	boolean	Declaration
allowQuotation?	boolean	Declaration
allowChainedInventoryCreation?	boolean	Declaration
allowClientDraftContribution?	boolean	Declaration
allowAdditionalDesignObjects?	boolean	Declaration
chainedInventoryHandlingUnitPrice?	number	Declaration
bestPrice?	number	Declaration
unitVolume?	number	Declaration
categories?	Category[]	Declaration
platformCategories?	Category[]	Declaration
discountGroups?	DiscountGroup[]	Declaration
domain?	Domain	Declaration
taxType?	CountryTax | null	Declaration
originalProduct?	Product | null	Declaration
clonedFromProduct?	Product | null	Declaration
chainedSupplierProduct?	Product | null	Declaration
chainedSellerProducts?	Product[]	Declaration
chainedInventorySupplierProduct?	Product | null	Declaration
chainedInventorySellerProducts?	Product[]	Declaration
productForm?	ProductForm | null	Declaration
images?	MerchiFile[]	Declaration
publicFiles?	MerchiFile[]	Declaration
productionFiles?	MerchiFile[]	Declaration
groupVariationFields?	VariationField[]	Declaration
independentVariationFields?	VariationField[]	Declaration
tags?	DomainTag[]	Declaration
internalTags?	InternalTag[]	Declaration
featureImage?	MerchiFile | null	Declaration
createdByJob?	Job | null	Declaration
defaultJob?	Job | null	Declaration
savedByCompanies?	Company[]	Declaration
suppliedByDomains?	SupplyDomain[]	Declaration
autoAssignProductionOnAction?	AutoAssignProductionOnAction	Declaration
supplyDomains?	SupplyDomain[]	Declaration
inventoriesOpen?	boolean	Declaration
clientSideCalculation?	boolean	Declaration
supplyChainDisabled?	boolean	Declaration
inventories?	Inventory[]	Declaration
inventoryGroups?	InventoryGroup[]	Declaration
cartItems?	CartItem[]	Declaration
jobs?	Job[]	Declaration
reminders?	Reminder[]	Declaration
supplyChainRequestJobs?	Job[]	Declaration
savedByUsers?	User[]	Declaration
suppliers?	User[]	Declaration
draftTemplates?	DraftTemplate[]	Declaration
draftPreviews?	DraftPreview[]	Declaration

ProductForm

Source and methods · Resource: product_forms

SDK property	Declared type	Source
archived?	Date | null	Declaration
created?	Date	Declaration
updated?	Date	Declaration
id?	number	Declaration
name?	string	Declaration
description?	string	Declaration
tags?	string[]	Declaration
source?	string	Declaration
sdkVersion?	string	Declaration
status?	string	Declaration
activeVersion?	ProductFormVersion | null	Declaration
versions?	ProductFormVersion[]	Declaration
createdBy?	User | null	Declaration
updatedBy?	User | null	Declaration

ProductFormVersion

Source and methods · Resource: product_form_versions

SDK property	Declared type	Source
created?	Date	Declaration
id?	number	Declaration
versionNumber?	number	Declaration
source?	string	Declaration
sdkVersion?	string	Declaration
compiledBundleUrl?	string | null	Declaration
bundleSha?	string | null	Declaration
compiledError?	string | null	Declaration
staticGateReport?	any	Declaration
status?	string	Declaration
approvedAt?	Date | null	Declaration
approvedBy?	User | null	Declaration
createdBy?	User | null	Declaration

ProductReview

Source and methods · Resource: product-reviews

SDK property	Declared type	Source
id?	number	Declaration
product?	Product	Declaration
domain?	Domain	Declaration
authorUserId?	number	Declaration
authorName?	string | null	Declaration
job?	Job	Declaration
rating?	number	Declaration
title?	string | null	Declaration
content?	string | null	Declaration
status?	string	Declaration
purchaseInvoiceId?	number | null	Declaration
submittedAt?	string | null	Declaration
updatedAt?	string | null	Declaration
rejectionReason?	string | null	Declaration

ProductionComment

Source and methods · Resource: production_comments

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
date?	Date | null	Declaration
urgency?	number	Declaration
text?	string	Declaration
isUrgentQuestion?	boolean	Declaration
sendSms?	boolean	Declaration
sendEmail?	boolean	Declaration
sendWhatsapp?	boolean	Declaration
files?	MerchiFile[]	Declaration
user?	User	Declaration
forwards?	User[]	Declaration
notifications?	Notification[]	Declaration
assignment?	Assignment	Declaration

Quote

Source and methods · Resource: quotes

SDK property	Declared type	Source
archived?	Date | null	Declaration
currency?	string	Declaration
id?	number	Declaration
agreedDeadline?	Date | null	Declaration
shipments?	Shipment[]	Declaration
quoteItems?	QuoteItem[]	Declaration
files?	MerchiFile[]	Declaration
assignments?	Assignment[]	Declaration
invoice?	Invoice | null	Declaration

QuoteItem

Source and methods · Resource: quote_items

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
type?	number	Declaration
quantity?	number	Declaration
description?	string | null	Declaration
unitPrice?	number | null	Declaration
taxAmount?	number | null	Declaration
taxType?	CountryTax	Declaration
quote?	Quote	Declaration

Reminder

Source and methods · Resource: reminders

SDK property	Declared type	Source
id?	number	Declaration
user?	User	Declaration
userProfile?	User	Declaration
sendEmail?	boolean	Declaration
sendSms?	boolean	Declaration
created?	Date	Declaration
updated?	Date	Declaration
remindDate?	Date	Declaration
message?	string	Declaration
domainTags?	DomainTag[]	Declaration
remindUsers?	User[]	Declaration
job?	Job	Declaration
product?	Product	Declaration
invoice?	Invoice	Declaration
domain?	Domain	Declaration
company?	Company	Declaration
shipment?	Shipment	Declaration
assignment?	Assignment	Declaration
notifications?	Notification[]	Declaration

Session

Source and methods · Resource: sessions

SDK property	Declared type	Source
archived?	Date | null	Declaration
ip?	string | null	Declaration
token?	string	Declaration
remember?	boolean | null	Declaration
user?	User	Declaration
domain?	Domain | null	Declaration

Shipment

Source and methods · Resource: shipments

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
name?	string	Declaration
shipmentServiceBookingInfo?	string	Declaration
shipmentServiceQuote?	string	Declaration
pickUp?	boolean	Declaration
internalTags?	InternalTag[]	Declaration
shipmentLabel?	MerchiFile | null	Declaration
creationDate?	Date | null	Declaration
dispatchedDate?	Date | null	Declaration
dispatchDate?	Date | null	Declaration
expectedReceiveDate?	Date | null	Declaration
receivedDate?	Date | null	Declaration
senderResponsible?	boolean	Declaration
senderNotes?	string | null	Declaration
receiverNotes?	string | null	Declaration
transportCompany?	number | null	Declaration
transportCompanyName?	string | null	Declaration
trackingNumber?	string | null	Declaration
buyCost?	number | null	Declaration
buyCurrency?	string | null	Declaration
cost?	number | null	Declaration
taxAmount?	number | null	Declaration
maxWeight?	number | null	Declaration
maxVolume?	number | null	Declaration
sendSms?	boolean	Declaration
sendEmail?	boolean	Declaration
sendWhatsapp?	boolean	Declaration
taxType?	CountryTax | null	Declaration
isOnBehalfOf?	boolean	Declaration
onBehalfOf?	User | null	Declaration
onBehalfOfCompany?	Company | null	Declaration
sender?	User | null	Declaration
senderCompany?	Company | null	Declaration
senderAddress?	Address | null	Declaration
blindShipTo?	string | null	Declaration
receiver?	User | null	Declaration
receiverCompany?	Company | null	Declaration
receiverAddress?	Address | null	Declaration
invoices?	Invoice[]	Declaration
quote?	Quote | null	Declaration
shipmentMethod?	ShipmentMethod | null	Declaration
tags?	DomainTag[]	Declaration
assignments?	Assignment[]	Declaration
items?	ShipmentItem[]	Declaration
jobs?	Job[]	Declaration
reminders?	Reminder[]	Declaration
logs?	ShipmentLog[]	Declaration

ShipmentItem

Source and methods · Resource: shipment_items

SDK property	Declared type	Source
job?	Job	Declaration
fulfillments?	ShipmentItemFulfillment[]	Declaration

ShipmentItemFulfillment

Source and methods · Resource: shipment_item_fulfillments

SDK property	Declared type	Source
assignment?	Assignment	Declaration
job?	Job	Declaration

ShipmentLog

Source and methods · Resource: shipment_logs

SDK property	Declared type	Source
id?	number	Declaration
shipment?	Shipment | null	Declaration
user?	User | null	Declaration
sourceType?	string	Declaration
message?	string	Declaration
detailJson?	Record<string, unknown> | null	Declaration
createdAt?	Date | null	Declaration

ShipmentMethod

Source and methods · Resource: shipment_methods

SDK property	Declared type	Source
id?	number	Declaration
name?	string	Declaration
shipmentService?	ShipmentService | null	Declaration
originAddress?	Address | null	Declaration
pickUp?	boolean	Declaration
company?	Company | null	Declaration
companyDefault?	boolean	Declaration
defaultCost?	number	Declaration
currency?	string	Declaration
buyCost?	number	Declaration
buyCurrency?	string	Declaration
transportCompany?	number | null	Declaration
transportCompanyName?	string	Declaration
taxType?	CountryTax | null	Declaration
variations?	ShipmentMethodVariation[]	Declaration
products?	Product[]	Declaration

ShipmentMethodVariation

Source and methods · Resource: shipment_method_variations

SDK property	Declared type	Source
id?	number	Declaration
destinationCountry?	string | null	Declaration
destinationState?	string | null	Declaration
cost?	number | null	Declaration
currency?	string	Declaration
buyCost?	number | null	Declaration
buyCurrency?	string	Declaration
maxWeight?	number | null	Declaration
taxType?	CountryTax | null	Declaration
shipmentMethod?	ShipmentMethod	Declaration

ShortUrl

Source and methods · Resource: short_urls

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
prefixToken?	string	Declaration
suffixToken?	string	Declaration
originalLink?	string	Declaration
triedTimes?	number	Declaration
lastLookup?	Date | null	Declaration
user?	User | null	Declaration
notification?	Notification[]	Declaration

SubscriptionPlan

Source and methods · Resource: subscription_plans

SDK property	Declared type	Source
id?	number	Declaration
created?	Date | null	Declaration
updated?	Date | null	Declaration
createdBy?	User | null	Declaration
updatedBy?	User | null	Declaration
name?	string	Declaration
currency?	string	Declaration
tax?	CountryTax | null	Declaration
baseCost?	number	Declaration
whiteLabelDomainCost?	number	Declaration
perSmsCost?	number	Declaration
perUserCost?	number	Declaration
perDomainCost?	number	Declaration
transactionCost?	number	Declaration
commissionRate?	number	Declaration
baseUserCount?	number	Declaration
baseDomainCount?	number	Declaration
billingCycleDays?	number	Declaration
isPrivate?	boolean	Declaration
showPublic?	boolean	Declaration
companies?	Company[]	Declaration

SupplyDomain

Source and methods · Resource: supply_domains

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
needsDrafting?	boolean	Declaration
product?	Product	Declaration
supplyProduct?	Product | null	Declaration
domain?	Domain	Declaration

SupportConversation

Source and methods · Resource: support_conversations

SDK property	Declared type	Source
id?	number	Declaration
creationDate?	Date | null	Declaration
lastMessageAt?	Date | null	Declaration
archivedAt?	Date | null	Declaration
domain?	Domain	Declaration
tags?	DomainTag[]	Declaration
guestId?	string | null	Declaration
guestContactEmail?	string | null	Declaration
guestContactName?	string | null	Declaration
clientFingerprint?	string | null	Declaration
name?	string | null	Declaration
notes?	string | null	Declaration
user?	User | null	Declaration
assignedUser?	User | null	Declaration
aiAutoReply?	boolean	Declaration
messages?	SupportMessage[]	Declaration
messagesCount?	number	Declaration

SupportMessage

Source and methods · Resource: support_messages

SDK property	Declared type	Source
id?	number	Declaration
conversation?	SupportConversation	Declaration
senderType?	string	Declaration
user?	User | null	Declaration
content?	string	Declaration
creationDate?	Date | null	Declaration
isAiReply?	boolean	Declaration

SystemRole

Source and methods · Resource: system_roles

SDK property	Declared type	Source
id?	number	Declaration
role?	number	Declaration
user?	User	Declaration

Theme

Source and methods · Resource: themes

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
mainCssStatus?	number	Declaration
mainCssErrorMessage?	string | null	Declaration
emailCssStatus?	number	Declaration
emailCssErrorMessage?	string | null	Declaration
lastUpdated?	Date	Declaration
mainCss?	string | null	Declaration
mainCssTemplateUsing?	string | null	Declaration
mainCssTemplateEditing?	string | null	Declaration
emailCss?	string | null	Declaration
emailCssTemplateUsing?	string | null	Declaration
emailCssTemplateEditing?	string | null	Declaration
domain?	Domain | null	Declaration
author?	User | null	Declaration
domains?	Domain[]	Declaration

ThemeCssSetting

Source and methods · Resource: theme_css_settings

SDK property	Declared type	Source
id?	number	Declaration
created?	Date | null	Declaration
createdBy?	User | null	Declaration
allowedAttributes?	string	Declaration
notAllowedAttributes?	string	Declaration

User

Source and methods · Resource: users

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
isSuperUser?	boolean	Declaration
userType?	UserType	Declaration
registeredAsGuest?	boolean	Declaration
isMerchiAgent?	boolean	Declaration
internalTags?	InternalTag[]	Declaration
tags?	DomainTag[]	Declaration
registeredUnderDomains?	Domain[]	Declaration
password?	string | null	Declaration
salt?	string | null	Declaration
facebookUserId?	string | null	Declaration
resetToken?	string | null	Declaration
resetTokenDate?	Date | null	Declaration
smsToken?	string | null	Declaration
resetSmsTokenDate?	Date | null	Declaration
smsClientToken?	string | null	Declaration
smsTokenConfirmed?	boolean	Declaration
smsLoginThreshold?	number	Declaration
jobCountAsClient?	number	Declaration
totalInvoiceValue?	number	Declaration
hasStore?	boolean	Declaration
lastJobReceived?	boolean	Declaration
canEdit?	boolean	Declaration
enableCrashReports?	boolean	Declaration
enableClientEmails?	boolean	Declaration
clientToken?	string | null	Declaration
name?	string	Declaration
internalUseNotes?	string	Declaration
telegramUsername?	string	Declaration
internalUseAiContext?	string	Declaration
aiContext?	string	Declaration
callToActions?	string	Declaration
callToActionDetails?	any[]	Declaration
comments?	string | null	Declaration
timezone?	string | null	Declaration
created?	Date | null	Declaration
preferredLanguage?	string | null	Declaration
enableInvoiceReminders?	boolean	Declaration
enableStoreNotifications?	boolean	Declaration
isAdminOfSubscribedCompany?	boolean	Declaration
jobComments?	JobComment[]	Declaration
jobOperationLogs?	JobOperationLog[]	Declaration
shipmentLogs?	ShipmentLog[]	Declaration
_emailAddresses?	EmailAddress[]	Declaration
_phoneNumbers?	PhoneNumber[]	Declaration
_addresses?	Address[]	Declaration
_companies?	UserCompany[]	Declaration
companiesNeedStripe?	Company[]	Declaration
categories?	Category[]	Declaration
products?	Product[]	Declaration
profilePicture?	MerchiFile | null	Declaration
phoneNumbers?	PhoneNumber[]	Declaration
sessions?	Session[]	Declaration
shipmentsAsSender?	Shipment[]	Declaration
shipmentsAsReceiver?	Shipment[]	Declaration
draftComments?	DraftComment[]	Declaration
forwardedDraftComments?	DraftComment[]	Declaration
systemRoles?	SystemRole[]	Declaration
emailAddresses?	EmailAddress[]	Declaration
notifications?	Notification[]	Declaration
sentNotifications?	Notification[]	Declaration
reminders?	Reminder[]	Declaration
assignments?	Assignment[]	Declaration
userCompanies?	UserCompany[]	Declaration
drafts?	Draft[]	Declaration
companyInvitations?	CompanyInvitation[]	Declaration
addresses?	Address[]	Declaration
uploadFiles?	MerchiFile[]	Declaration
forwardedJobComments?	JobComment[]	Declaration
appliedJobs?	Job[]	Declaration
managedJobs?	Job[]	Declaration
draftingJobs?	Job[]	Declaration
saved_products?	Product[]	Declaration
carts?	Cart[]	Declaration
payments?	Payment[]	Declaration
enrolledDomains?	EnrolledDomain[]	Declaration
responsibleInvoices?	Invoice[]	Declaration
createdInvoices?	Invoice[]	Declaration
invoicesHas?	Invoice[]	Declaration
sentDomainInvitations?	DomainInvitation[]	Declaration
receivedDomainInvitations?	DomainInvitation[]	Declaration
themes?	Theme[]	Declaration
forwardedProductionComments?	ProductionComment[]	Declaration
accessibleDomainsAsClient?	Domain[]	Declaration

UserCompany

Source and methods · Resource: user_companies

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
main?	boolean | null	Declaration
isAdmin?	boolean	Declaration
user?	User | null	Declaration
company?	Company | null	Declaration

Variation

Source and methods · Resource: variations

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
value?	string | null	Declaration
currency?	string	Declaration
cost?	number	Declaration
quantity?	number	Declaration
onceOffCost?	number	Declaration
unitCost?	number	Declaration
unitCostTotal?	number	Declaration
isVisible?	boolean	Declaration
variationField?	VariationField	Declaration
variationsGroup?	VariationsGroup | null	Declaration
job?	Job | null	Declaration
cartItem?	CartItem | null	Declaration
variationFiles?	MerchiFile[]	Declaration
selectedOptions?	VariationOption[]	Declaration
selectableOptions?	VariationOption[]	Declaration

VariationField

Source and methods · Resource: variation_fields

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
position?	number	Declaration
required?	boolean	Declaration
independent?	boolean	Declaration
name?	string	Declaration
instructions?	string	Declaration
placeholder?	string | null	Declaration
defaultValue?	string	Declaration
currency?	string	Declaration
fieldType?	FieldType	Declaration
margin?	number	Declaration
variationCost?	number	Declaration
variationCostDiscountGroup?	DiscountGroup | null	Declaration
variationUnitCost?	number	Declaration
buyUnitCost?	number	Declaration
buyCost?	number	Declaration
variationUnitCostDiscountGroup?	DiscountGroup | null	Declaration
rows?	number	Declaration
fieldMin?	number | null	Declaration
fieldMax?	number | null	Declaration
allowDecimal?	boolean	Declaration
allowAllPantones?	boolean	Declaration
isHtml?	boolean	Declaration
considerBusinessHours?	boolean	Declaration
shippingTimeIncluded?	boolean	Declaration
sellerProductEditable?	boolean	Declaration
multipleSelect?	boolean	Declaration
showFilePreview?	boolean	Declaration
allowFileMultiple?	boolean	Declaration
allowFileJpeg?	boolean	Declaration
allowFileGif?	boolean	Declaration
allowFilePdf?	boolean	Declaration
allowFilePng?	boolean	Declaration
allowFileAi?	boolean	Declaration
maxColours?	number	Declaration
simplifyColours?	boolean	Declaration
colourVariationCost?	number	Declaration
colourVariationCostDiscountGroup?	DiscountGroup | null	Declaration
colourVariationUnitCost?	number	Declaration
colourVariationUnitCostDiscountGroup?	DiscountGroup | null	Declaration
heightVariationCost?	number	Declaration
heightVariationCostDiscountGroup?	DiscountGroup | null	Declaration
heightVariationUnitCost?	number	Declaration
heightVariationUnitCostDiscountGroup?	DiscountGroup | null	Declaration
widthVariationCost?	number	Declaration
widthVariationCostDiscountGroup?	DiscountGroup | null	Declaration
widthVariationUnitCost?	number	Declaration
widthVariationUnitCostDiscountGroup?	DiscountGroup | null	Declaration
heightFieldMin?	number | null	Declaration
heightFieldMax?	number | null	Declaration
widthFieldMin?	number | null	Declaration
widthFieldMax?	number | null	Declaration
areaUnit?	string	Declaration
areaInputType?	string	Declaration
areaStep?	number | null	Declaration
aspectRatioLock?	boolean	Declaration
aspectRatio?	number | null	Declaration
product?	Product	Declaration
selectedBy?	VariationFieldsOption[]	Declaration
inventoryGroup?	InventoryGroup	Declaration
linkedInventoryGroup?	InventoryGroup	Declaration
variations?	Variation[]	Declaration
options?	VariationFieldsOption[]	Declaration

VariationFieldsOption

Source and methods · Resource: variation_fields_options

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
value?	string | null	Declaration
colour?	string | null	Declaration
isExtracted?	boolean	Declaration
currency?	string	Declaration
default?	boolean	Declaration
include?	boolean	Declaration
noInventory?	boolean	Declaration
position?	number	Declaration
deliveryDays?	number	Declaration
variationCost?	number	Declaration
variationCostDiscountGroup?	DiscountGroup | null	Declaration
variationUnitCost?	number	Declaration
buyUnitCost?	number	Declaration
buyCost?	number	Declaration
variationUnitCostDiscountGroup?	DiscountGroup | null	Declaration
variationField?	VariationField | null	Declaration
linkedFile?	MerchiFile | null	Declaration
linkedProductImage?	MerchiFile | null	Declaration
selectedByVariations?	Variation[]	Declaration
inventoryUnitVariations?	InventoryUnitVariation[]	Declaration
selectedBy?	VariationFieldsOption[]	Declaration

VariationOption

Source and methods

SDK property	Declared type	Source
optionId?	number	Declaration
value?	string | null	Declaration
colour?	string | null	Declaration
position?	number	Declaration
available?	boolean	Declaration
default?	boolean	Declaration
include?	boolean	Declaration
isVisible?	boolean	Declaration
linkedFile?	MerchiFile | null	Declaration
fieldName?	string	Declaration
userDeadline?	Date	Declaration
quantity?	number	Declaration
currency?	string	Declaration
onceOffCost?	number	Declaration
unitCost?	number	Declaration
unitCostTotal?	number	Declaration
totalCost?	number	Declaration

VariationsGroup

Source and methods · Resource: variations_groups

SDK property	Declared type	Source
archived?	Date | null	Declaration
id?	number	Declaration
quantity?	number	Declaration
groupCost?	number | null	Declaration
job?	Job | null	Declaration
cartItem?	CartItem | null	Declaration
matchingInventory?	MatchingInventory | null	Declaration
variations?	Variation[]	Declaration
inventoryCount?	number	Declaration
inventorySufficient?	boolean	Declaration