‣
Each schema page contains the following columns
- Default Field Name
- The field name Shoptable creates on the table.
- Direct from API
- Whether the value of the field is directly taken from the Shopify GraphQL API.
- If this checked then you can find more information about the field on the documentation page for the object with matching "Default Column Name".
- e.g.
Products.titleis a field directly taken from the API. Find out more information by going to the Products documentation page and going to the field named "title". - Each schema page will have a link to the matching object GraphQL documentation page.
- Any field with "Direct from API" checked will not have a value in the "Description" column.
- Description
- Information about the field if it's not directly taken from the Shopify GraphQL API.
- Oftentimes this will simply indicate which properties to look up on the object
- Pattern:
<object_name>.<property_name> - There may be multiple property names
- Editable from Airtable
- Whether or not the field is editable from Airtable to Shopify.
- If this is checked then you can modify the field within Airtable and sync back to Shopify using the sync button.
- If you make changes to other fields and sync the record to Shopify, these fields will be reverted back to their previous value.
GraphQL Documentation
| Default Field Name | Direct from API | Description | Editable from Airtable |
|---|---|---|---|
name | |||
id | |||
createdAt | |||
updatedAt | |||
lineItems_json | a JSON of order.lineItems that takes the following shape:
```
{
customAttributes {
...Attribute
}
discountAllocations {
...DiscountAllocation
}
discountedTotalSet {
...MoneyBag
}
discountedUnitPriceSet {
...MoneyBag
}
duties {
...Duty
}
fulfillableQuantity
fulfillmentStatus
id
merchantEditable
name
nonFulfillableQuantity
originalTotalSet {
...MoneyBag
}
originalUnitPriceSet {
...MoneyBag
}
quantity
refundableQuantity
requiresShipping
restockable
sellingPlan {
...LineItemSellingPlan
}
taxLines {
...TaxLine
}
title
totalDiscountSet {
...MoneyBag
}
unfulfilledDiscountedTotalSet {
...MoneyBag
}
unfulfilledOriginalTotalSet {
...MoneyBag
}
unfulfilledQuantity
variant {
id
sku
title
}
vendor
}
``` | ||
displayFinancialStatus | |||
displayFulfillmentStatus | |||
tags | |||
phone | |||
email | |||
note | |||
customAttributes_json | JSON of order.customAttributes with Attribute containing all its properties | ||
discountCode | |||
confirmed | |||
closed | |||
closedAt | |||
cancelledAt | |||
cancelReason | |||
edited | |||
shippingAddressFirstName | order.shippingAddress.firstName | ||
shippingAddressLastName | order.shippingAddress.lastName | ||
shippingAddressAddress1 | order.shippingAddress.address1 | ||
shippingAddressAddress2 | order.shippingAddress.address2 | ||
shippingAddressCity | order.shippingAddress.city | ||
shippingAddressZip | order.shippingAddress.zip | ||
shippingAddressProvinceCode | order.shippingAddress.provinceCode | ||
shippingAddressCountryCodeV2 | order.shippingAddress.countryCodeV2 | ||
shippingAddressPhone | order.shippingAddress.phone | ||
shippingAddressCompany | order.shippingAddress.company | ||
capturable | |||
unpaid | |||
fullyPaid | |||
processedAt | |||
refundDiscrepancy | order.refundDiscrepancySet.shopMoney.amount in the currency of the shop | ||
netPayment | order.netPaymentSet.shopMoney.amount in the currency of the shop | ||
totalPrice | order.totalPriceSet.shopMoney.amount in the currency of the shop | ||
totalTax | order.totalTaxSet.shopMoney.amount in the currency of the shop | ||
totalShippingPrice | order.totalShippingPriceSet.shopMoney.amount in the currency of the shop | ||
subtotalPrice | order.subtotalPriceSet.shopMoney.amount in the currency of the shop | ||
totalDiscounts | order.totalDiscountsSet.shopMoney.amount in the currency of the shop | ||
cartDiscountAmount | order.cartDiscountAmountSet.shopMoney.amount in the currency of the shop | ||
totalCapturable | order.totalCapturableSet.shopMoney.amount in the currency of the shop | ||
totalReceived | order.totalReceivedSet.shopMoney.amount in the currency of the shop | ||
totalOutstanding | order.totalOutstandingSet.shopMoney.amount in the currency of the shop | ||
totalTipReceived | order.totalTipReceivedSet.shopMoney.amount in the currency of the shop | ||
totalRefunded | order.totalRefundedSet.shopMoney.amount in the currency of the shop | ||
totalRefundedShipping | order.totalRefundedShippingSet.shopMoney.amount in the currency of the shop | ||
originalTotalDuties | order.originalTotalDutiesSet.shopMoney.amount in the currency of the shop | ||
originalTotalPrice | order.originalTotalPriceSet.shopMoney.amount in the currency of the shop | ||
taxLines_json | JSON of order.taxLines | ||
currentTaxLines_json | JSON of order.currentTaxLines | ||
disputes_json | JSON of order.disputes with all its properties | ||
transactions_json | JSON of order.transactions with the Transaction object having the following shape:
{
accountNumber
amountSet {
...MoneyBag
}
authorizationCode
authorizationExpiresAt
createdAt
errorCode
fees {
...TransactionFee
}
formattedGateway
gateway
id
kind
manuallyCapturable
maximumRefundableV2 {
...MoneyV2
}
paymentIcon {
...ImageNoMetafields
}
processedAt
settlementCurrency
settlementCurrencyRate
status
test
totalUnsettledSet {
...MoneyBag
}
shopifyPaymentsSet {
...ShopifyPaymentsTransactionSet
}
} | ||
paymentGatewayNames | |||
riskLevel | |||
risks_json | JSON of order.risks with the OrderRisk object containing all its properties | ||
currentTotalPrice | order.currentTotalPriceSet.shopMoney.amount in the currency of the shop | ||
currentTotalTax | order.currentTotalTaxSet.shopMoney.amount in the currency of the shop | ||
taxesIncluded | |||
currentSubtotalPrice | order.currentSubtotalPrice.shopMoney.amount in the currency of the shop | ||
currentCartDiscountAmount | order.currentCardDiscountAmount.shopMoney.amount in the currency of the shop | ||
currentTotalDiscounts | order.currentTotalDiscountsSet.shopMoney.amount in the currency of the shop | ||
currentTotalDuties | order.currentTotalDutiesSet.shopMoney.amount in the currency of the shop | ||
fulfillable | |||
fulfillments_json | JSON of order.fulfillments with the Fulfillment object taking the following shape:
{
createdAt
deliveredAt
displayStatus
estimatedDeliveryAt
id
inTransitAt
legacyResourceId
location {
...Node
}
name
requiresShipping
service {
id
}
status
totalQuantity
trackingInfo {
...FulfillmentTrackingInfo
}
updatedAt
} | ||
shippingLine_json | JSON of order.shippingLine with ShippingLine taking the following shape:
{
carrierIdentifier
code
custom
deliveryCategory
discountAllocations {
...DiscountAllocation
}
discountedPriceSet {
...MoneyBag
}
id
originalPriceSet {
...MoneyBag
}
phone
requestedFulfillmentService {
...FulfillmentServiceIdOnly
}
shippingRateHandle
source
taxLines {
...TaxLine
}
title
} | ||
currentTotalWeight | |||
totalWeight | |||
customer_json | JSON of order.customer with Customer taking the following shape:
{
acceptsMarketing
acceptsMarketingUpdatedAt
addresses {
...MailingAddress
}
averageOrderAmountV2 {
...MoneyV2
}
canDelete
createdAt
defaultAddress {
...MailingAddress
}
displayName
email
firstName
hasNote
hasTimelineComment
id
image {
...ImageNoMetafields
}
lastName
legacyResourceId
lifetimeDuration
locale
marketingOptInLevel
multipassIdentifier
note
ordersCount
phone
productSubscriberStatus
state
tags
taxExempt
taxExemptions
totalSpentV2 {
...MoneyV2
}
updatedAt
validEmailAddress
verifiedEmail
} | ||
customerAcceptsMarketing | |||
canNotifyCustomer | |||
hasTimelineComment | |||
merchantEditable | |||
test | |||
canMarkAsPaid | |||
legacyResourceId | |||
physicalLocationId | |||
publicationId | |||
refundable | |||
requiresShipping | |||
restockable | |||
currencyCode | |||
presentmentCurrencyCode | |||
paymentCollectionDetails_json | JSON of order.paymentCollectionDetails with OrderPaymentCollectionDetails containing all its properties | ||
customerLocale | |||
clientIp | |||
customerJourneySummary_json | JSON of order.customerJourneySummary with CustomerJourneySummary taking the following shape:
fragment CustomerJourneySummary on CustomerJourneySummary {
customerOrderIndex
daysToConversion
firstVisit {
...CustomerVisit
}
lastVisit {
...CustomerVisit
}
momentsCount
ready
}
fragment CustomerVisit on CustomerVisit {
id
landingPage
landingPageHtml
marketingEvent {
...MarketingEvent
}
occurredAt
referralCode
referralInfoHtml
referrerUrl
source
sourceDescription
sourceType
utmParameters {
...UtmParameters
}
}
fragment UtmParameters on UTMParameters {
campaign
content
medium
source
term
} | ||
billingAddressFirstName | order.billingAddress.firstName | ||
billingAddressLastName | order.billingAddress.lastName | ||
billingAddressAddress1 | order.billingAddress.address1 | ||
billingAddressAddress2 | order.billingAddress.address2 | ||
billingAddressCity | order.billingAddress.city | ||
billingAddressZip | order.billingAddress.zip | ||
billingAddressProvinceCode | order.billingAddress.provinceCode | ||
billingAddressCountryCodeV2 | order.billingAddress.countryCodeV2 | ||
billingAddressPhone | order.billingAddress.phone | ||
billingAddressCompany | order.billingAddress.company | ||
displayAddressFirstName | order.displayAddress.firstName | ||
displayAddressLastName | order.displayAddress.lastName | ||
displayAddressAddress1 | order.displayAddress.address1 | ||
displayAddressAddress2 | order.displayAddress.address2 | ||
displayAddressCity | order.displayAddress.city | ||
displayAddressZip | order.displayAddress.zip | ||
displayAddressProvinceCode | order.displayAddress.provinceCode | ||
displayAddressCountryCodeV2 | order.displayAddress.countryCodeV2 | ||
displayAddressPhone | order.displayAddress.phone | ||
displayAddressCompany | order.displayAddress.company | ||
billingAddressCountry | order.billingAddress.country | ||
billingAddressId | order.billingAddress.id | ||
billingAddressLatitude | order.billingAddress.latitude | ||
billingAddressLongitude | order.billingAddress.longitude | ||
shippingAddressLatitude | order.shippingAddress.latitude | ||
shippingAddressLongitude | order.shippingAddress.longitude | ||
displayAddressLatitude | order.displayAddress.latitude | ||
displayAddressLongitude | order.displayAddress.longitude | ||
billingAddressProvince | order.billingAddress.province | ||
currentSubtotalLineItemsQuantity | |||
displayAddressCountry | order.displayAddress.country | ||
displayAddressId | order.displayAddress.id | ||
displayAddressProvince | order.displayAddress.province | ||
merchantEditableErrors | |||
shippingAddressCountry | order.shippingAddress.country | ||
shippingAddressId | order.shippingAddress.id | ||
shippingAddressProvince | order.shippingAddress.province | ||
subtotalLineItemsQuantity |