Shopify Connector Objects (GRAPHQL-2024-07 Schema)

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name	Description
AbandonedCheckoutLineItems	Retrieves a list of line items in the associated resource.
Abandonment	Returns abandonment.
AbandonmentProductsAddedToCart	Returns the products added to the cart during the customer abandoned visit.
AbandonmentProductsViewed	Returns the products viewed during the customer abandoned visit.
AppCredits	Lists credits that can be used towards future app purchases.
AppFeedbacks	Reports the status of shops and their resources and displays this information within Shopify admin. AppFeedback is used to notify merchants about steps they need to take to set up an application on their store.
AppSubscriptionLineItems	Returns the plans attached to the app subscription.
AppSubscriptions	Lists all subscriptions created for a shop on the installed application.
ArticleComments	Returns a list of comments posted on an article.
Articles	Returns a list of the shop's visible articles.
AssignedFulfillmentOrders	Retrieves a paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated, or might currently not be requested to be fulfilled. The app must have 'read_assigned_fulfillment_orders' to be able to retrieve fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the 'CLOSED' status) will be returned by default.
Blogs	Retrieves a list of the shop's blogs.
CarrierServices	Returns a list of activated carrier services and associated shop locations that support them.
Catalogs	The catalogs belonging to the shop.
CollectionProducts	Retrieves a list of the products inside of a collection.
Collections	Returns a list of collections.
Companies	Returns the list of companies in the shop.
CompanyContactRoleAssignments	Returns role assignments.
CompanyContactRoles	Returns available roles for company contacts.
CompanyContacts	Returns contacts for companies.
CompanyEvents	Retrieves a paginated list of events associated with the host subject.
CompanyLocations	Returns a list of locations in the company.
CustomerEvents	Retrieves a paginated list of events associated with the host subject.
Customers	Retrieves a list of customers.
CustomerSegmentMembers	The list of members, such as customers, that's associated with individual segments.
DeliveryProfileLocationGroupCountries	Lists countries already selected in any zone for the specified location group.
DeliveryProfileLocationGroupCountryProvinces	Returns the list of regions associated with this country.
DeliveryProfileLocationGroups	Lists the location groups using this profile.
DeliveryProfileLocationGroupZones	Lists the applicable zones associated to the specified location group.
DeliveryProfiles	Returns a list of saved delivery profiles.
DeliveryProfileUnassignedLocations	Lists the locations that have not been assigned to a location group for this profile.
DiscountEvents	Retrieves a paginated list of events associated with the host subject.
DiscountsAutomaticApp	Returns a list of discounts.
DiscountsAutomaticBasic	Returns a list of discounts.
DiscountsAutomaticBxgy	Returns a list of discounts.
DiscountsCodeApp	Returns a list of discounts.
DiscountsCodeBasic	Returns a list of discounts.
DiscountsCodeBxgy	Returns a list of discounts.
DiscountsCodeFreeShipping	Returns a list of discounts.
DraftOrderCustomAttributes	Retrieves custom attributes associated with the resource.
DraftOrderEvents	Retrieves a paginated list of events associated with the host subject.
DraftOrderLineItemCustomAttributes	Retrieves custom attributes associated with the resource.
DraftOrderLineItems	Returns a list of the line items in the draft order.
DraftOrderLineItemTaxLines	Represents a single tax applied to the associated resource.
DraftOrders	Returns a list of saved draft orders.
DraftOrderTaxLines	Represents a single tax applied to the associated resource.
Files	Returns the list of files that have been uploaded to Shopify.
FulfillmentEvents	Retrieves the history of events associated with one or many fulfillments.
FulfillmentLineItems	Line items from orders that are included in fulfillments.
FulfillmentLineItemTaxLines	Represents a single tax applied to the associated resource.
FulfillmentOrderLineItems	A list of the fulfillment order's line items.
FulfillmentOrderLocationForMoveAvailableLineItems	A list of the fulfillment order's line items.
FulfillmentOrderLocationForMoveUnavailableLineItems	A list of the fulfillment order's line items.
FulfillmentOrderLocationsForMove	A list of locations that the fulfillment order can potentially move to.
FulfillmentOrders	Retrieves a paginated list of merchant-managed and third-party fulfillment orders.
Fulfillments	Fulfillment represents a shipment of one or more items in an order.
FulfillmentServices	Lists fulfillmentServices which Represents service that prepares and ships orders on behalf of the store owner.
FulfillmentTrackingInfo	Lists tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
GiftCards	Returns a list of gift cards. Requires read_gift_cards access scope. Also, note that the API client must be a private or custom application installed on a Shopify Plus or Shopify Plus Partner Sandbox store.(This table is available only with a ShopifyPlus subscription)
InventoryItemCountryHarmonizedSystemCodes	Returns a list of country specific harmonized system codes.
InventoryItemInventoryLevelQuantities	List quantities for inventory items at specific locations.
InventoryItemInventoryLevels	Returns overview information of the inventory item for each location that the inventory item can be stocked at.
InventoryItems	Returns a list of inventory items.
Jobs	Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
Locations	Returns a list of active inventory locations.
MarketingEvents	Returns a list of marketing events associated with the marketing app.
Metafields	Retrieves a list of metafields that belong to one or many resource IDs.
MetaobjectDefinitions	Provides the definition of a generic object structure composed of metafields.
MetaObjects	All metaobjects for the shop.
OrderAdditionalFees	A list of additional fees applied to the order.
OrderAgreementAdditionalFeeSales	Retrieves a list of sales associated with agreements.
OrderAgreementAdjustmentSales	Retrieves a list of sales associated with agreements.
OrderAgreementDutySales	Retrieves a list of sales associated with agreements.
OrderAgreementGiftCardSales	Retrieves a list of sales associated with agreements.
OrderAgreementProductSales	Retrieves a list of sales associated with agreements.
OrderAgreements	Retrieves a list of sales agreements associated with orders.
OrderAgreementShippingLineSales	Retrieves a list of sales associated with agreements.
OrderAgreementTipSales	Retrieves a list of sales associated with agreements.
OrderAgreementUnknownSales	Retrieves a list of sales associated with agreements.
OrderCustomAttributes	Retrieves custom attributes associated with the resource.
OrderDiscountApplications	Returns a list of discounts that are applied to the order, not including order edits and refunds.
OrderEditAgreementAdditionalFeeSales	Retrieves a list of sales associated with agreements.
OrderEditAgreementAdjustmentSales	Retrieves a list of sales associated with agreements.
OrderEditAgreementDutySales	Retrieves a list of sales associated with agreements.
OrderEditAgreementGiftCardSales	Retrieves a list of sales associated with agreements.
OrderEditAgreementProductSales	Retrieves a list of sales associated with agreements.
OrderEditAgreements	Retrieves a list of sales agreements associated with orders.
OrderEditAgreementShippingLineSales	Retrieves a list of sales associated with agreements.
OrderEditAgreementTipSales	Retrieves a list of sales associated with agreements.
OrderEditAgreementUnknownSales	Retrieves a list of sales associated with agreements.
OrderEvents	Retrieves a paginated list of events associated with the host subject.
OrderLineItemCustomAttributes	Retrieves custom attributes associated with the resource.
OrderLineItemDiscountAllocations	Retrieves the discounts that have been allocated onto the line item by discount applications, not including order edits and refunds.
OrderLineItemDuties	Lists the duties associated with the line items.
OrderLineItems	Retrieves line items associated with orders.
OrderNonFulfillableLineItemDuties	Lists the duties associated with the line items.
OrderNonFulfillableLineItems	Retrieves a list of line items in the associated resource.
OrderRefundAgreementAdditionalFeeSales	Retrieves a list of sales associated with agreements.
OrderRefundAgreementAdjustmentSales	Retrieves a list of sales associated with agreements.
OrderRefundAgreementDutySales	Retrieves a list of sales associated with agreements.
OrderRefundAgreementGiftCardSales	Retrieves a list of sales associated with agreements.
OrderRefundAgreementProductSales	Retrieves a list of sales associated with agreements.
OrderRefundAgreements	Retrieves a list of sales agreements associated with orders.
OrderRefundAgreementShippingLineSales	Retrieves a list of sales associated with agreements.
OrderRefundAgreementTipSales	Retrieves a list of sales associated with agreements.
OrderRefundAgreementUnknownSales	Retrieves a list of sales associated with agreements.
OrderRiskAssessments	Retrieves a list of risk assessments for orders.
Orders	Retrieves a list of orders.
OrderTaxLines	Represents a single tax applied to the associated resource.
OrderTransactions	Retrieves the transactions associated with the resource.
Pages	Returns a list of the shop's pages.
PriceListPrices	A list of prices associated with a price list.
PriceLists	All price lists for a shop.
ProductMediaImages	Returns the media images associated with the product.
ProductOptions	Returns a list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.
ProductOptionValues	List all the corresponding option value objects to the product option, including values not assigned to any variants.
ProductResourceFeedbacks	Returns the product resource feedback for the currently authenticated app.
Products	Returns a list of products.
ProductVariants	Returns a list of the product variants.
PublicationCollections	Returns a list of collections published to the publication.
PublicationProducts	Returns the list of publication for products.
Publications	Returns the list of publications.
RefundDuties	Lists the refunded duties as part of this refund.
RefundLineItemDuties	Lists the duties associated with the line items.
RefundLineItems	Retrieves the 'RefundLineItem' resources attached to the refund.
Refunds	Represents a refund of items or transactions in an order.
RefundTransactionFees	Returns the transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
RefundTransactions	Retrieves the transactions associated with the resource.
ReturnExchangeLineItems	Retrieves a list of line items in the associated resource.
ReturnLineItems	Retrieves the return line items attached to the return.
ReturnLineItemsUnverified	Retrieves the unverified return line items attached to the return.
Returns	Retrieves a list of returns for the order.
ScriptTags	Returns a list of script tags.
SegmentFilterParameters	The parameters for event segment filters.
SegmentFilters	A list of filters.
Segments	A list of a shop's segments.
SellingPlanGroups	Returns a list Selling Plan Groups.
SellingPlanGroupSellingPlans	Retrieves selling plans associated to the selling plan group.
Shop	Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.
ShopifyPaymentsAccount	Returns Shopify Payments account information, including balances and payouts.
ShopifyPaymentsAccountBalance	Returns current balances in all currencies for the account.
ShopifyPaymentsAccountBalanceTransactionAdjustmentsOrders	The adjustment orders associated to the transaction.
ShopifyPaymentsAccountBalanceTransactions	A list of balance transactions associated with a Shopify Payments account balance.
ShopifyPaymentsAccountBankAccounts	Lists all bank accounts configured for the Shopify Payments account.
ShopifyPaymentsAccountDisputes	Lists all disputes related to the Shopify Payments account.
ShopifyPaymentsAccountPayouts	Returns all current and previous payouts made between the account and the bank account. Its avaible only in a few certain countries.
ShopifyPaymentsAccountPermittedVerificationDocuments	Retrieves the permitted documents for identity verification.
ShopifyPaymentsAccountVerifications	Returns the verifications necessary for this account.
StaffMembers	Retrieves a paginated list of the shop's staff members.(This table is available only with a ShopifyPlus subscription)
StorefrontAccessTokens	Retrieves the storefront access token of a private application. These are scoped per-application.
TenderTransactions	Returns a list of TenderTransactions associated with the shop.
UrlRedirects	Returns a list of redirects for a shop.

AbandonedCheckoutLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ResourceId	String	False	Abandonment.AbandonedCheckoutPayloadId	No	A globally-unique ID.
Title	String	False		No	Title of the line item. Defaults to the product's title.
ProductId	String	False		No	A globally-unique ID.
VariantId	String	False		No	A globally-unique ID.
VariantTitle	String	False		No	The title of the variant at time of order creation.
Quantity	Int	False		No	The number of variant units ordered.
Sku	String	False		No	The variant SKU number.
ImageId	String	False		No	A unique ID for the image.
ImageWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False		No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False		No	The location of the image as a URL.
DiscountedTotalPriceSetPresentmentMoneyAmount	Decimal	False		No	Final total price for the entire quantity of this line item, including discounts. Decimal money amount.
DiscountedTotalPriceSetPresentmentMoneyCurrencyCode	String	False		No	Final total price for the entire quantity of this line item, including discounts. Currency of the money.
DiscountedTotalPriceSetShopMoneyAmount	Decimal	False		No	Final total price for the entire quantity of this line item, including discounts. Decimal money amount.
DiscountedTotalPriceSetShopMoneyCurrencyCode	String	False		No	Final total price for the entire quantity of this line item, including discounts. Currency of the money.
DiscountedTotalPriceWithCodeDiscountPresentmentMoneyAmount	Decimal	False		No	The total price for the entire quantity of this line item, after all discounts are applied, at both the line item and code-based line item level. Decimal money amount.
DiscountedTotalPriceWithCodeDiscountPresentmentMoneyCurrencyCode	String	False		No	The total price for the entire quantity of this line item, after all discounts are applied, at both the line item and code-based line item level. Currency of the money.
DiscountedTotalPriceWithCodeDiscountShopMoneyAmount	Decimal	False		No	The total price for the entire quantity of this line item, after all discounts are applied, at both the line item and code-based line item level. Decimal money amount.
DiscountedTotalPriceWithCodeDiscountShopMoneyCurrencyCode	String	False		No	The total price for the entire quantity of this line item, after all discounts are applied, at both the line item and code-based line item level. Currency of the money.
DiscountedUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	The price of a single variant unit after discounts are applied at the line item level, in shop and presentment currencies. Decimal money amount.
DiscountedUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	The price of a single variant unit after discounts are applied at the line item level, in shop and presentment currencies. Currency of the money.
DiscountedUnitPriceSetShopMoneyAmount	Decimal	False		No	The price of a single variant unit after discounts are applied at the line item level, in shop and presentment currencies. Decimal money amount.
DiscountedUnitPriceSetShopMoneyCurrencyCode	String	False		No	The price of a single variant unit after discounts are applied at the line item level, in shop and presentment currencies. Currency of the money.
DiscountedUnitPriceWithCodeDiscountPresentmentMoneyAmount	Decimal	False		No	The price of a single variant unit after all discounts are applied, at both the line item and code-based line item level. Decimal money amount.
DiscountedUnitPriceWithCodeDiscountPresentmentMoneyCurrencyCode	String	False		No	The price of a single variant unit after all discounts are applied, at both the line item and code-based line item level. Currency of the money.
DiscountedUnitPriceWithCodeDiscountShopMoneyAmount	Decimal	False		No	The price of a single variant unit after all discounts are applied, at both the line item and code-based line item level. Decimal money amount.
DiscountedUnitPriceWithCodeDiscountShopMoneyCurrencyCode	String	False		No	The price of a single variant unit after all discounts are applied, at both the line item and code-based line item level. Currency of the money.
OriginalTotalPriceSetPresentmentMoneyAmount	Decimal	False		No	Original total price for the entire quantity of this line item, before discounts. Decimal money amount.
OriginalTotalPriceSetPresentmentMoneyCurrencyCode	String	False		No	Original total price for the entire quantity of this line item, before discounts. Currency of the money.
OriginalTotalPriceSetShopMoneyAmount	Decimal	False		No	Original total price for the entire quantity of this line item, before discounts. Decimal money amount.
OriginalTotalPriceSetShopMoneyCurrencyCode	String	False		No	Original total price for the entire quantity of this line item, before discounts. Currency of the money.
OriginalUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Original price for a single unit of this line item, before discounts. Decimal money amount.
OriginalUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Original price for a single unit of this line item, before discounts. Currency of the money.
OriginalUnitPriceSetShopMoneyAmount	Decimal	False		No	Original price for a single unit of this line item, before discounts. Decimal money amount.
OriginalUnitPriceSetShopMoneyCurrencyCode	String	False		No	Original price for a single unit of this line item, before discounts. Currency of the money.

Return to Top

Abandonment

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
AppId	String	False	No	A globally-unique ID.
CustomerId	String	False	No	A globally-unique ID.
AbandonmentType	String	False	No	The abandonment type.
EmailState	String	False	No	The email state (e.g., sent or not sent).
InventoryAvailable	Bool	False	No	Whether the products in abandonment are available.
EmailSentAt	Datetime	False	No	When the email was sent, if that is the case.
MostRecentStep	String	False	No	The most recent step type.
VisitStartedAt	Datetime	False	No	The date and time when the visit started.
IsFromOnlineStore	Bool	False	No	Whether the abandonment event comes from the Online Store sales channel.
IsFromShopApp	Bool	False	No	Whether the abandonment event comes from the Shop app sales channel.
IsFromShopPay	Bool	False	No	Whether the abandonment event comes from Shop Pay.
IsMostSignificantAbandonment	Bool	False	No	Whether the customer did not complete another most significant step since this abandonment.
LastBrowseAbandonmentDate	Datetime	False	No	The date for the latest browse abandonment.
LastCartAbandonmentDate	Datetime	False	No	The date for the latest cart abandonment.
LastCheckoutAbandonmentDate	Datetime	False	No	The date for the latest checkout abandonment.
DaysSinceLastAbandonmentEmail	Int	False	No	The number of days since the last abandonment email was sent to the customer.
HoursSinceLastAbandonedCheckout	Double	False	No	The number of hours since the customer has last abandoned a checkout.
CustomerHasNoOrderSinceAbandonment	Bool	False	No	Whether the customer has completed an order since this checkout has been abandoned.
CreatedAt	Datetime	False	No	The date and time when the abandonment was created.
IsFromCustomStorefront	Bool	False	No	Whether the abandonment event comes from a custom storefront channel.
AbandonedCheckoutPayloadId	String	False	No	A globally-unique ID.
AbandonedCheckoutPayloadDefaultCursor	String	False	No	A default cursor that returns the single next record, sorted ascending by ID.
AbandonedCheckoutPayloadAbandonedCheckoutUrl	String	False	No	The URL for the buyer to recover their checkout.

Return to Top

AbandonmentProductsAddedToCart

Name	Type	ReadOnly	FilterOnly	Description
AbandonmentId	String	False	No	A globally-unique ID.
AbandonedCheckoutPayloadId [KEY]	String	False	No	A globally-unique ID.
ProductId [KEY]	String	False	No	A globally-unique ID.
VariantId [KEY]	String	False	No	A globally-unique ID.
Quantity	Int	False	No	The quantity of the product that the customer requested.

Return to Top

AbandonmentProductsViewed

Name	Type	ReadOnly	References	FilterOnly	Description
AbandonmentId	String	False	Abandonment.Id	No	A globally-unique ID.
AbandonedCheckoutPayloadId [KEY]	String	False		No	A globally-unique ID.
ProductId [KEY]	String	False		No	A globally-unique ID.
VariantId [KEY]	String	False		No	A globally-unique ID.
Quantity	Int	False		No	The quantity of the product that the customer requested.

Return to Top

AppCredits

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
AppInstallationId	String	False	No	A globally-unique ID.
Description	String	False	No	The description of the app credit.
Test	Bool	False	No	Whether the app credit is a test transaction.
CreatedAt	Datetime	False	No	The date and time when the app credit was created.
Amount	Decimal	False	No	Decimal money amount.
AmountCurrencyCode	String	False	No	Currency of the money.

Return to Top

AppFeedbacks

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Title	String	True	No	Name of the app.
Message	String	True	No	The feedback message presented to the merchant.
Url	String	True	No	The URL that the link visits.
Label	String	True	No	A context-sensitive label for the link.
State	String	False	Yes	The state of the feedback and whether it requires merchant action.
FeedbackGeneratedAt	Datetime	False	Yes	The date and time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback.

Return to Top

AppSubscriptionLineItems

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
AppSubscriptionId	String	True	No	A globally-unique ID.
AppInstallationId	String	True	No	A globally-unique ID.
RecurringPricingPlanDiscountDurationLimitInIntervals	Int	True	No	The total number of billing intervals to which the discount will be applied. The discount will be applied to an indefinite number of billing intervals if this value is blank.
RecurringPricingPlanDiscountPriceAfterDiscountAmount	Decimal	True	No	The price of the subscription after the discount is applied. Decimal money amount.
RecurringPricingPlanDiscountPriceAfterDiscountCurrencyCode	String	True	No	The price of the subscription after the discount is applied. Currency of the money.
RecurringPricingPlanDiscountRemainingDurationInIntervals	Int	True	No	The remaining number of billing intervals to which the discount will be applied.
RecurringPricingPlanValueAmount	Decimal	True	No	The value of the discount applied every billing interval. Decimal money amount.
RecurringPricingPlanValueAmountCurrencyCode	String	True	No	The value of the discount applied every billing interval. Currency of the money.
RecurringPricingPlanValuePercentage	Double	True	No	The value of the discount applied every billing interval. The percentage value of a discount.
RecurringPricingPlanInterval	String	True	No	The frequency at which the subscribing shop is billed for an app subscription.
RecurringPricingPlanPriceAmount	Decimal	True	No	The amount to be charged to the subscribing shop every billing interval. Decimal money amount.
RecurringPricingPlanPriceCurrencyCode	String	True	No	The currency to be charged to the subscribing shop every billing interval. Currency of the money.
UsagePricingPlanBalanceUsedAmount	Decimal	True	No	The total usage records for interval. Decimal money amount.
UsagePricingPlanBalanceUsedCurrencyCode	String	True	No	The total usage records for interval. Currency of the money.
UsagePricingPlanCappedAmount	Decimal	False	No	The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Decimal money amount.
UsagePricingPlanCappedAmountCurrencyCode	String	False	No	The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. Currency of the money.
UsagePricingPlanInterval	String	True	No	The frequency with which the app usage records are billed.
UsagePricingPlanTerms	String	True	No	The terms and conditions for app usage pricing. Must be present in order to create usage charges. The terms are presented to the merchant when they approve an app's usage charges.

Return to Top

AppSubscriptions

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
AppInstallationId	String	True	No	A globally-unique ID.
Name	String	True	No	The name of the app subscription.
Status	String	True	No	The status of the app subscription.
Test	Bool	True	No	Specifies whether the app subscription is a test transaction.
ReturnUrl	String	True	No	The URL that the merchant is redirected to after approving the app subscription.
TrialDays	Int	True	No	The number of free trial days, starting at the subscription's creation date, by which billing is delayed.
CurrentPeriodEnd	Datetime	True	No	The date and time when the current app subscription period ends. Returns 'null' if the subscription isn't active.
CreatedAt	Datetime	True	No	The date and time when the app subscription was created.
LineItemIds	String	True	No	The IDs of the plans attached to the app subscription.
LineItem	String	True	No

Return to Top

ArticleComments

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ArticleId	String	False	Articles.Id	No	A globally-unique ID.
ContentHtml	String	False		No	The content of the comment, complete with HTML formatting.
AuthorName	String	False		No	The author's name.
AuthorEmail	String	False		No	The author's email.

Return to Top

Articles

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
Title	String	False	No	The article's name.
Handle	String	False	No	A human-friendly unique string for the Article automatically generated from its title.
Tags	String	False	No	A categorization that a article can be tagged with.
ContentHtml	String	False	No	The content of the article, complete with HTML formatting.
ExcerptHtml	String	False	No	The excerpt of the article, complete with HTML formatting.
OnlineStoreUrl	String	False	No	The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel.
PublishedAt	Datetime	False	No	The date and time when the article was published.
AuthorV2Name	String	False	No	The author's full name.
AuthorV2FirstName	String	False	No	The author's first name.
AuthorV2LastName	String	False	No	The author's last name.
AuthorV2Bio	String	False	No	The author's bio.
AuthorV2Email	String	False	No	The author's email.
BlogId	String	False	No	A globally-unique ID.
BlogTitle	String	False	No	The blogs's title.
ImageId	String	False	No	A unique ID for the image.
ImageWidth	Int	False	No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False	No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False	No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False	No	The location of the image as a URL.
SeoTitle	String	False	No	The SEO title.
SeoDescription	String	False	No	The meta description.
CreatedAt	Datetime	False	No	The date and time when the article was created. This column can only be used as an input for filtering.
UpdatedAt	Datetime	False	No	The date and time when the article was last updated. This column can only be used as an input for filtering.

Return to Top

AssignedFulfillmentOrders

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ShopId	String	False	Shop.Id	No	A globally-unique ID.
OrderId	String	False		No	A globally-unique ID.
Status	String	False		No	The status of the fulfillment order.
FulfillAt	Datetime	False		No	The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date.
FulfillBy	Datetime	False		No	The latest date and time by which all items in the fulfillment order need to be fulfilled.
RequestStatus	String	False		No	The request status of the fulfillment order.
CreatedAt	Datetime	False		No	Date and time when the fulfillment order was created.
UpdatedAt	Datetime	False		No	The date and time when the fulfillment order was last updated.
AssignedLocationName	String	False		No	The name of the location.
AssignedLocationAddress1	String	False		No	The first line of the address for the location.
AssignedLocationAddress2	String	False		No	The second line of the address for the location.
AssignedLocationCity	String	False		No	The city of the location.
AssignedLocationPhone	String	False		No	The phone number of the location.
AssignedLocationProvince	String	False		No	The province of the location.
AssignedLocationZip	String	False		No	The ZIP code of the location.
AssignedLocationCountryCode	String	False		No	The two-letter country code of the location.
AssignedLocationLocationId	String	False		No	A globally-unique ID.
AssignedLocationLocationLegacyResourceId	String	False		No	The ID of the corresponding resource in the REST Admin API.
AssignedLocationLocationName	String	False		No	The name of the location.
AssignedLocationLocationActivatable	Bool	False		No	Whether this location can be reactivated.
AssignedLocationLocationDeactivatable	Bool	False		No	Whether this location can be deactivated.
AssignedLocationLocationDeletable	Bool	False		No	Whether this location can be deleted.
AssignedLocationLocationAddressVerified	Bool	False		No	Whether the location address has been verified.
AssignedLocationLocationDeactivatedAt	String	False		No	The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'.
AssignedLocationLocationIsActive	Bool	False		No	Whether the location is active.
AssignedLocationLocationShipsInventory	Bool	False		No	Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
AssignedLocationLocationFulfillsOnlineOrders	Bool	False		No	Whether this location can fulfill online orders.
AssignedLocationLocationHasActiveInventory	Bool	False		No	Whether this location has active inventory.
AssignedLocationLocationHasUnfulfilledOrders	Bool	False		No	Whether this location has orders that need to be fulfilled.
DeliveryMethodId	String	False		No	A globally-unique ID.
DeliveryMethodMethodType	String	False		No	The type of the delivery method.
DeliveryMethodMaxDeliveryDateTime	Datetime	False		No	The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
DeliveryMethodMinDeliveryDateTime	Datetime	False		No	The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
DeliveryMethodServiceCode	String	False		No	A reference to the shipping method.
DeliveryMethodSourceReference	String	False		No	Promise provider specific data associated with delivery promise.
DeliveryMethodBrandedPromiseName	String	False		No	The name of the branded promise. For example: 'Shop Promise'.
DeliveryMethodBrandedPromiseHandle	String	False		No	The handle of the branded promise. For example: 'shop_promise'.
DeliveryMethodAdditionalInformationPhone	String	False		No	The phone number to contact when performing the delivery.
DeliveryMethodAdditionalInformationInstructions	String	False		No	The delivery instructions to follow when performing the delivery.
DestinationId	String	False		No	A globally-unique ID.
DestinationFirstName	String	False		No	The first name of the customer at the destination.
DestinationLastName	String	False		No	The last name of the customer at the destination.
DestinationAddress1	String	False		No	The first line of the address of the destination.
DestinationAddress2	String	False		No	The second line of the address of the destination.
DestinationCity	String	False		No	The city of the destination.
DestinationCompany	String	False		No	The company of the destination.
DestinationEmail	String	False		No	The email of the customer at the destination.
DestinationPhone	String	False		No	The phone number of the customer at the destination.
DestinationProvince	String	False		No	The province of the destination.
DestinationZip	String	False		No	The ZIP code of the destination.
DestinationCountryCode	String	False		No	The two-letter country code of the destination.
InternationalDutiesIncoterm	String	False		No	The method of duties payment. Example values: 'DDP', 'DAP'.
AssignmentStatus	String	False		No	The assigment status of the fulfillment orders that should be returned. If assignmentStatus argument is not provided, then the query will return all assigned fulfillment orders, except those that have the CLOSED status.

Return to Top

Blogs

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
Title	String	False	No	The blogs's title.
Handle	String	False	No	A human-friendly unique string for the Blog automatically generated from its title.
OnlineStoreUrl	String	False	No	The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel.
SeoTitle	String	False	No	The SEO title.
SeoDescription	String	False	No	The meta description.
CreatedAt	Datetime	False	No	The date and time when the blog was created. This column can only be used as an input for filtering.
UpdatedAt	Datetime	False	No	The date and time when the blog was last updated. This column can only be used as an input for filtering.

Return to Top

CarrierServices

Name	Type	ReadOnly	FilterOnly	Description
Id	String	False	No	A globally-unique ID.
Name	String	False	No	The name of the shipping service provider.
FormattedName	String	False	No	The properly formatted name of the shipping service provider, ready to display.
IconAltText	String	False	No	A word or phrase to share the nature or contents of an image.
IconHeight	Int	False	No	The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify.
IconId	String	False	No	A unique ID for the image.
IconWidth	Int	False	No	The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify.

Return to Top

Catalogs

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Status	String	False	No	The status of the catalog.
Title	String	False	No	The name of the catalog.
PriceListId	String	False	No	A globally-unique ID.
PublicationId	String	False	No	A globally-unique ID.
OperationId	String	True	No	A globally-unique ID.
CompanyLocationIds	String	False	Yes	The IDs of the company locations to associate to the catalog.

Return to Top

CollectionProducts

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	Globally unique identifier.
CollectionId [KEY]	String	False	Collections.Id	No	A globally-unique identifier for the collection.
Title	String	False		No	The title of the product.
Position	Int	False		No	The position in which the products are sorted.

Return to Top

Collections

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
LegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
Title	String	True	No	The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.
Handle	String	True	No	A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title 'Summer Catalog 2022' might have the handle 'summer-catalog-2022'. If the title is changed, the handle doesn't automatically change. The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.
DescriptionHtml	String	True	No	The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.
ProductsCount	Int	True	No	The number of products in the collection.
ProductsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
SortOrder	String	False	No	The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.
TemplateSuffix	String	True	No	The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is 'custom', then the collection is using the 'collection. custom. liquid' template. If the value is 'null', then the collection is using the default 'collection. liquid' template.
AvailablePublicationsCount	Int	True	No	The number of publications a resource is published to without feedback errors.
AvailablePublicationsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
PublishedOnCurrentPublication	Bool	True	No	Check to see whether the resource is published to the calling app's publication.
UpdatedAt	Datetime	True	No	The date and time when the collection was last modified.
FeedbackSummary	String	True	No	Summary of resource feedback pertaining to the resource.
ImageId	String	True	No	A unique ID for the image.
ImageWidth	Int	True	No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	True	No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	True	No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	True	No	The location of the image as a URL.
RuleSetAppliedDisjunctively	Bool	True	No	Whether products must match any or all of the rules to be included in the collection. If true, then products must match at least one of the rules to be included in the collection. If false, then products must match all of the rules to be included in the collection.
SeoTitle	String	True	No	SEO Title.
SeoDescription	String	True	No	SEO Description.

Return to Top

Companies

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
ExternalId	String	False	No	A unique externally-supplied ID for the company.
Name	String	False	No	The name of the company.
Note	String	False	No	A note about the company.
ContactsCount	Int	True	No	The number of contacts that belong to the company.
ContactsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
CustomerSince	Datetime	True	No	The date and time at which the company became the customer.
DefaultCursor	String	True	No	A default cursor that returns the single next record, sorted ascending by ID.
LifetimeDuration	String	True	No	The lifetime duration of the company, since it became a customer of the shop. Examples: '2 days', '3 months', '1 year'.
LocationsCount	Int	True	No	The number of locations that belong to the company.
LocationsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
OrdersCount	Int	True	No	The total number of orders placed for this company, across all its locations.
OrdersCountPrecision	String	True	No	The count's precision, or the exactness of the value.
HasTimelineComment	Bool	True	No	Whether the merchant added a timeline comment to the company.
CreatedAt	Datetime	True	No	The date and time at which the company was created in Shopify.
UpdatedAt	Datetime	True	No	The date and time at which the company was last modified.
DefaultRoleId	String	True	No	A globally-unique ID.
DefaultRoleName	String	True	No	The name of a role. For example, 'admin' or 'buyer'.
DefaultRoleNote	String	True	No	A note for the role.
MainContactId	String	True	No	A globally-unique ID.
TotalSpentAmount	Decimal	True	No	Decimal money amount.
TotalSpentCurrencyCode	String	True	No	Currency of the money.

Return to Top

CompanyContactRoleAssignments

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
CompanyId	String	True	No	The company this role assignment belongs to.
CompanyLocationId	String	True	No	The company location to which the role is assigned.
CompanyContactId	String	True	No	The company contact for whom this role is assigned.
CreatedAt	Datetime	True	No	The date and time when the assignment record was created.
UpdatedAt	Datetime	True	No	The date and time when the assignment record was last updated.
RoleId	String	True	No	A globally-unique ID.
RoleName	String	True	No	The name of a role. For example, 'admin' or 'buyer'.
RoleNote	String	True	No	A note for the role.

Return to Top

CompanyContactRoles

Name	Type	ReadOnly	FilterOnly	Description
CompanyId	String	False	No	The company to which the role belongs.
Id [KEY]	String	False	No	A globally-unique ID.
Name	String	False	No	The name of a role. For example, 'admin' or 'buyer'.
Note	String	False	No	A note for the role.

Return to Top

CompanyContacts

Name	Type	ReadOnly	FilterOnly	Description
CompanyId	String	True	No	The company to which the contact belongs.
Id [KEY]	String	True	No	A globally-unique ID.
IsMainContact	Bool	True	No	Whether the contact is the main contact of the company.
Title	String	False	No	The company contact's job title.
Locale	String	False	No	The company contact's locale (language).
LifetimeDuration	String	True	No	The lifetime duration of the company contact, since its creation date on Shopify. Examples: '1 year', '2 months', '3 days'.
CreatedAt	Datetime	True	No	The date and time at which the company contact was created at Shopify.
UpdatedAt	Datetime	True	No	The date and time at which the company contact was last updated.
CustomerId	String	True	No	The customer associated to this contact.
CustomerFirstName	String	False	No	The customer's first name.
CustomerLastName	String	False	No	The customer's last name.
CustomerEmail	String	False	No	The customer's email address.
CustomerPhone	String	False	No	The customer's phone number.

Return to Top

CompanyEvents

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
HostId	String	False	Companies.Id	No	A globally-unique ID.
AppTitle	String	False		No	The name of the app that created the event.
AttributeToApp	Bool	False		No	Whether the event was created by an app.
AttributeToUser	Bool	False		No	Whether the event was caused by an admin user.
CreatedAt	Datetime	False		No	The date and time when the event was created.
CriticalAlert	Bool	False		No	Whether the event is critical.
Message	String	False		No	Human readable text that describes the event.
CommentEventAuthorId	String	False		No	The id of the staff member that authored the comment event.
CommentEventCanDelete	Bool	False		No	Whether the comment event can be deleted. If true, then the comment event can be deleted.
CommentEventCanEdit	Bool	False		No	Whether the comment event can edited. If true, then the comment event can be edited.
CommentEventEdited	Bool	False		No	Whether the comment event has been edited. If true, then the comment event has been edited.
CommentEventRawMessage	String	False		No	The raw body of the comment event.
CommentEventSubjectId	String	False		No	The parent subject to which the comment event belongs.
CommentEventEmbedCustomerId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedDraftOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductVariantId	String	False		No	The object reference associated with the comment event.

Return to Top

CompanyLocations

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique ID.
CompanyId	String	True	Companies.Id	No	A globally-unique ID.
ExternalId	String	False		No	A unique externally-supplied ID for the company location.
TaxRegistrationId	String	True		No	The tax registration ID for the company location.
Name	String	False		No	The name of the company location.
Currency	String	True		No	The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.
Locale	String	False		No	The preferred locale of the company location.
Note	String	False		No	A note about the company location.
Phone	String	False		No	The phone number of the company location.
DefaultCursor	String	True		No	A default cursor that returns the single next record, sorted ascending by ID.
OrdersCount	Int	True		No	The total number of orders placed for the location.
OrdersCountPrecision	String	True		No	The count's precision, or the exactness of the value.
TaxExemptions	String	True		No	The list of tax exemptions applied to the location.
HasTimelineComment	Bool	True		No	Whether the merchant added a timeline comment to the company location.
CreatedAt	Datetime	True		No	The date and time at which the company location was created in Shopify.
UpdatedAt	Datetime	True		No	The date and time at which the company location was last modified.
BillingAddressId	String	True		No	A globally-unique ID.
BillingAddressCompanyName	String	True		No	The name of the company.
BillingAddressFirstName	String	True		No	The first name of the recipient.
BillingAddressLastName	String	True		No	The last name of the recipient.
BillingAddressAddress1	String	True		No	The first line of the address. Typically the street address or PO Box number.
BillingAddressAddress2	String	True		No	The second line of the address. Typically the number of the apartment, suite, or unit.
BillingAddressCity	String	True		No	The name of the city, district, village, or town.
BillingAddressCountry	String	True		No	The name of the country.
BillingAddressPhone	String	True		No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
BillingAddressProvince	String	True		No	The region of the address, such as the province, state, or district.
BillingAddressRecipient	String	True		No	The identity of the recipient e. g. 'Receiving Department'.
BillingAddressZip	String	True		No	The zip or postal code of the address.
BillingAddressCountryCode	String	True		No	The two-letter code for the country of the address. For example, US.
BillingAddressFormattedArea	String	True		No	A comma-separated list of the values for city, province, and country.
BillingAddressZoneCode	String	True		No	The two-letter code for the region. For example, ON.
BillingAddressCreatedAt	Datetime	True		No	The date and time at which the company address was created.
BillingAddressUpdatedAt	Datetime	True		No	The date and time at which the company address was last updated.
BuyerExperienceConfigurationCheckoutToDraft	Bool	True		No	Whether to checkout to draft order for merchant review.
BuyerExperienceConfigurationPayNowOnly	Bool	True		No	Whether a buyer must pay at checkout or they can also choose to pay later using net terms.
BuyerExperienceConfigurationPaymentTermsTemplateId	String	True		No	A globally-unique ID.
BuyerExperienceConfigurationPaymentTermsTemplateName	String	True		No	The name of the payment terms template.
BuyerExperienceConfigurationPaymentTermsTemplateTranslatedName	String	True		No	The translated payment terms template name.
BuyerExperienceConfigurationPaymentTermsTemplateDescription	String	True		No	The description of the payment terms template.
BuyerExperienceConfigurationPaymentTermsTemplateDueInDays	Int	True		No	The number of days between the issued date and due date if this is the net type of payment terms.
BuyerExperienceConfigurationPaymentTermsTemplatePaymentTermsType	String	True		No	The type of the payment terms template.
MarketId	String	True		No	A globally-unique ID.
ShippingAddressId	String	True		No	A globally-unique ID.
ShippingAddressCompanyName	String	True		No	The name of the company.
ShippingAddressFirstName	String	True		No	The first name of the recipient.
ShippingAddressLastName	String	True		No	The last name of the recipient.
ShippingAddressAddress1	String	True		No	The first line of the address. Typically the street address or PO Box number.
ShippingAddressAddress2	String	True		No	The second line of the address. Typically the number of the apartment, suite, or unit.
ShippingAddressCity	String	True		No	The name of the city, district, village, or town.
ShippingAddressCountry	String	True		No	The name of the country.
ShippingAddressPhone	String	True		No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
ShippingAddressProvince	String	True		No	The region of the address, such as the province, state, or district.
ShippingAddressRecipient	String	True		No	The identity of the recipient e. g. 'Receiving Department'.
ShippingAddressZip	String	True		No	The zip or postal code of the address.
ShippingAddressCountryCode	String	True		No	The two-letter code for the country of the address. For example, US.
ShippingAddressFormattedArea	String	True		No	A comma-separated list of the values for city, province, and country.
ShippingAddressZoneCode	String	True		No	The two-letter code for the region. For example, ON.
ShippingAddressCreatedAt	Datetime	True		No	The date and time at which the company address was created.
ShippingAddressUpdatedAt	Datetime	True		No	The date and time at which the company address was last updated.
TotalSpentAmount	Decimal	True		No	Decimal money amount.
TotalSpentCurrencyCode	String	True		No	Currency of the money.

Return to Top

CustomerEvents

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
HostId	String	False	Customers.Id	No	A globally-unique ID.
AppTitle	String	False		No	The name of the app that created the event.
AttributeToApp	Bool	False		No	Whether the event was created by an app.
AttributeToUser	Bool	False		No	Whether the event was caused by an admin user.
CreatedAt	Datetime	False		No	The date and time when the event was created.
CriticalAlert	Bool	False		No	Whether the event is critical.
Message	String	False		No	Human readable text that describes the event.
CommentEventAuthorId	String	False		No	The id of the staff member that authored the comment event.
CommentEventCanDelete	Bool	False		No	Whether the comment event can be deleted. If true, then the comment event can be deleted.
CommentEventCanEdit	Bool	False		No	Whether the comment event can edited. If true, then the comment event can be edited.
CommentEventEdited	Bool	False		No	Whether the comment event has been edited. If true, then the comment event has been edited.
CommentEventRawMessage	String	False		No	The raw body of the comment event.
CommentEventSubjectId	String	False		No	The parent subject to which the comment event belongs.
CommentEventEmbedCustomerId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedDraftOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductVariantId	String	False		No	The object reference associated with the comment event.

Return to Top

Customers

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
MultipassIdentifier	String	True	No	A unique identifier for the customer that's used with Multipass login.
LegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
ValidEmailAddress	Bool	True	No	Whether the email address is formatted correctly. Returns 'true' when the email is formatted correctly and belongs to an existing domain. This doesn't guarantee that the email address actually exists.
DisplayName	String	True	No	The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
FirstName	String	False	No	The customer's first name.
LastName	String	False	No	The customer's last name.
Email	String	False	No	The customer's email address.
Locale	String	False	No	The customer's locale.
Note	String	False	No	A note about the customer.
Phone	String	False	No	The customer's phone number.
State	String	True	No	The state of the customer's account with the shop.
Tags	String	False	No	A comma separated list of tags that have been added to the customer.
CanDelete	Bool	True	No	Whether the merchant can delete the customer from their store. A customer can be deleted from a store only if they have not yet made an order. After a customer makes an order, they can't be deleted from a store.
LifetimeDuration	String	True	No	The amount of time since the customer was first added to the store. Example: 'about 12 years'.
TaxExempt	Bool	False	No	Whether the customer is exempt from being charged taxes on their orders.
TaxExemptions	String	False	No	The list of tax exemptions applied to the customer.
UnsubscribeUrl	String	True	No	The URL to unsubscribe the customer from the mailing list.
VerifiedEmail	Bool	True	No	Whether the customer has verified their email address. Defaults to 'true' if the customer is created through the Shopify admin or API.
NumberOfOrders	String	True	No	The number of orders that the customer has made at the store in their lifetime.
ProductSubscriberStatus	String	True	No	Possible subscriber states of a customer defined by their subscription contracts.
CreatedAt	Datetime	True	No	The date and time when the customer was added to the store.
UpdatedAt	Datetime	True	No	The date and time when the customer was last updated.
AmountSpentAmount	Decimal	True	No	Decimal money amount.
AmountSpentCurrencyCode	String	True	No	Currency of the money.
DefaultAddressId	String	True	No	A globally-unique ID.
DefaultAddressCoordinatesValidated	Bool	True	No	Whether the address coordinates are valid.
DefaultAddressName	String	True	No	The full name of the customer, based on firstName and lastName.
DefaultAddressFirstName	String	False	No	The first name of the customer.
DefaultAddressLastName	String	False	No	The last name of the customer.
DefaultAddressAddress1	String	False	No	The first line of the address. Typically the street address or PO Box number.
DefaultAddressAddress2	String	False	No	The second line of the address. Typically the number of the apartment, suite, or unit.
DefaultAddressCity	String	False	No	The name of the city, district, village, or town.
DefaultAddressCompany	String	False	No	The name of the customer's company or organization.
DefaultAddressCountry	String	False	No	The name of the country.
DefaultAddressLatitude	Double	True	No	The latitude coordinate of the customer address.
DefaultAddressLongitude	Double	True	No	The longitude coordinate of the customer address.
DefaultAddressPhone	String	False	No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
DefaultAddressProvince	String	False	No	The region of the address, such as the province, state, or district.
DefaultAddressZip	String	False	No	The zip or postal code of the address.
DefaultAddressFormattedArea	String	True	No	A comma-separated list of the values for city, province, and country.
DefaultAddressProvinceCode	String	False	No	The two-letter code for the region. For example, ON.
DefaultAddressCountryCodeV2	String	False	No	The two-letter code for the country of the address. For example, US.
EmailMarketingConsentMarketingState	String	True	No	The current email marketing state for the customer.
EmailMarketingConsentMarketingOptInLevel	String	True	No	The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the customer gave when they consented to receive marketing material by email.
EmailMarketingConsentConsentUpdatedAt	Datetime	True	No	The date and time at which the customer consented to receive marketing material by email. The customer's consent state reflects the consent record with the most recent 'consent_updated_at' date. If no date is provided, then the date and time at which the consent information was sent is used.
ImageId	String	True	No	A unique ID for the image.
ImageWidth	Int	True	No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	True	No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	True	No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	True	No	The location of the image as a URL.
LastOrderId	String	True	No	A globally-unique ID.
MarketId	String	True	No	A globally-unique ID.
MergeableReason	String	True	No	The reason why the customer can't be merged with another customer.
MergeableErrorFields	String	True	No	The list of fields preventing the customer from being merged.
MergeableIsMergeable	Bool	True	No	Whether the customer can be merged with another customer.
MergeableMergeInProgressJobId	String	True	No	The UUID of the merge job.
MergeableMergeInProgressResultingCustomerId	String	True	No	The ID of the customer resulting from the merge.
MergeableMergeInProgressStatus	String	True	No	The status of the customer merge request.
SmsMarketingConsentMarketingState	String	False	No	The current SMS marketing state for the customer.
SmsMarketingConsentConsentCollectedFrom	String	True	No	The source from which the SMS marketing information for the customer was collected.
SmsMarketingConsentMarketingOptInLevel	String	False	No	The marketing subscription opt-in level that was set when the customer consented to receive marketing information.
SmsMarketingConsentConsentUpdatedAt	Datetime	False	No	The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used.
StatisticsPredictedSpendTier	String	True	No	The predicted spend tier of a customer with a shop.

Return to Top

CustomerSegmentMembers

Name	Type	ReadOnly	References	FilterOnly	Description
SegmentId [KEY]	String	False	Segments.Id	No	The ID of the segment.
Id [KEY]	String	False		No	The member's ID.
DisplayName	String	False		No	The full name of the member, which is based on the values of the 'first_name' and 'last_name' fields. If the member's first name and last name aren't available, then the customer's email address is used. If the customer's email address isn't available, then the customer's phone number is used.
FirstName	String	False		No	The member's first name.
LastName	String	False		No	The member's last name.
Note	String	False		No	A note about the member.
LastOrderId	String	False		No	The ID of the member's most recent order.
NumberOfOrders	String	False		No	The total number of orders that the member has made.
AmountSpentAmount	Decimal	False		No	Decimal money amount.
AmountSpentCurrencyCode	String	False		No	Currency of the money.
DefaultAddressId	String	False		No	A globally-unique ID.
DefaultAddressCountry	String	False		No	The name of the country.
DefaultAddressProvince	String	False		No	The region of the address, such as the province, state, or district.
DefaultAddressCity	String	False		No	The name of the city, district, village, or town.
DefaultAddressFormattedArea	String	False		No	A comma-separated list of the values for city, province, and country.
DefaultAddressCompany	String	False		No	The name of the customer's company or organization.
DefaultAddressAddress1	String	False		No	The first line of the address. Typically the street address or PO Box number.
DefaultAddressAddress2	String	False		No	The second line of the address. Typically the number of the apartment, suite, or unit.
DefaultAddressName	String	False		No	The full name of the customer, based on firstName and lastName.
DefaultAddressFirstName	String	False		No	The first name of the customer.
DefaultAddressLastName	String	False		No	The last name of the customer.
DefaultAddressLatitude	Double	False		No	The latitude coordinate of the customer address.
DefaultAddressLongitude	Double	False		No	The longitude coordinate of the customer address.
DefaultAddressCoordinatesValidated	Bool	False		No	Whether the address coordinates are valid.
DefaultAddressPhone	String	False		No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
DefaultAddressZip	String	False		No	The zip or postal code of the address.
DefaultAddressProvinceCode	String	False		No	The alphanumeric code for the region. For example, ON.
DefaultAddressCountryCode	String	False		No	The two-letter code for the country of the address. For example, US.
DefaultAddressTimeZone	String	False		No	The time zone of the address.
DefaultEmailAddressEmailAddress	String	False		No	The customer's default email address.
DefaultEmailAddressMarketingState	String	False		No	Whether the customer has subscribed to email marketing.
DefaultEmailAddressMarketingUnsubscribeUrl	String	False		No	The URL to unsubscribe a member from all mailing lists.
DefaultEmailAddressOpenTrackingLevel	String	False		No	Whether the customer has opted in to having their opened emails tracked.
DefaultEmailAddressOpenTrackingUrl	String	False		No	The URL that can be used to opt a customer in or out of email open tracking.
DefaultPhoneNumberMarketingState	String	False		No	Whether the customer has subscribed to SMS marketing material.
DefaultPhoneNumberPhoneNumber	String	False		No	A customer's phone number.
MergeableReason	String	False		No	The reason why the customer can't be merged with another customer.
MergeableErrorFields	String	False		No	The list of fields preventing the customer from being merged.
MergeableIsMergeable	Bool	False		No	Whether the customer can be merged with another customer.
MergeableMergeInProgressJobId	String	False		No	The UUID of the merge job.
MergeableMergeInProgressResultingCustomerId	String	False		No	The ID of the customer resulting from the merge.
MergeableMergeInProgressStatus	String	False		No	The status of the customer merge request.

Return to Top

DeliveryProfileLocationGroupCountries

Name	Type	ReadOnly	FilterOnly	Description
CountryId [KEY]	String	False	No	A globally-unique ID.
LocationGroupId [KEY]	String	False	No	A globally-unique ID.
DeliveryProfileId	String	False	No	The ID of the DeliveryProfile to return.
Zone	String	False	No	The name of the shipping zone.
CountryName	String	False	No	The full name of the country.
CountryTranslatedName	String	False	No	The translated name of the country. The translation returned is based on the system's locale.
CountryCodeCountryCode	String	False	No	The country code in the ISO 3166-1 alpha-2 format.
CountryCodeRestOfWorld	Bool	False	No	Whether the country is a part of the 'Rest of World' shipping zone.

Return to Top

DeliveryProfileLocationGroupCountryProvinces

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
CountryId	String	False	No	A globally-unique ID.
Code	String	False	No	The code of the region.
Name	String	False	No	The full name of the region.
TranslatedName	String	False	No	The translated name of the region. The translation returned is based on the system's locale.

Return to Top

DeliveryProfileLocationGroups

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
DeliveryProfileId	String	False	No	The ID of the DeliveryProfile to return.
LocationsCount	Int	False	No	A count of all locations that are part of this location group.
LocationsCountPrecision	String	False	No	The count's precision, or the exactness of the value.

Return to Top

DeliveryProfileLocationGroupZones

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
LocationGroupId [KEY]	String	False		No	Filter the location groups of the profile by location group ID.
DeliveryProfileId	String	False	DeliveryProfiles.Id	No	The ID of the DeliveryProfile to return.
Name	String	False		No	The name of the zone.
MethodDefinitionCountsParticipantDefinitionsCount	Int	False		No	The number of participant method definitions for the specified zone.
MethodDefinitionCountsRateDefinitionsCount	Int	False		No	The number of merchant-defined method definitions for the specified zone.

Return to Top

DeliveryProfiles

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Name	String	False	No	The name of the delivery profile.
Default	Bool	True	No	Whether this is the default profile.
LegacyMode	Bool	True	No	Whether this shop has enabled legacy compatibility mode for delivery profiles.
OriginLocationCount	Int	True	No	The number of active origin locations for the profile.
ZoneCountryCount	Int	True	No	The number of countries with active rates to deliver to.
ActiveMethodDefinitionsCount	Int	True	No	The number of active shipping rates for the profile.
LocationsWithoutRatesCount	Int	True	No	The number of locations without rates defined.
ProductVariantsCount	Int	True	No	The product variant count.
ProductVariantsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
MerchantOwnedOnly	Bool	True	No	If 'true', returns only delivery profiles that were created by the merchant.

Return to Top

DeliveryProfileUnassignedLocations

Name	Type	ReadOnly	References	FilterOnly	Description
DeliveryProfileId [KEY]	String	False	DeliveryProfiles.Id	No	A globally-unique ID.
LocationId [KEY]	String	False	Locations.Id	No	A globally-unique ID.

Return to Top

DiscountEvents

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
HostId	String	False	No	A globally-unique ID.
AppTitle	String	False	No	The name of the app that created the event.
AttributeToApp	Bool	False	No	Whether the event was created by an app.
AttributeToUser	Bool	False	No	Whether the event was caused by an admin user.
CreatedAt	Datetime	False	No	The date and time when the event was created.
CriticalAlert	Bool	False	No	Whether the event is critical.
Message	String	False	No	Human readable text that describes the event.
CommentEventAuthorId	String	False	No	The id of the staff member that authored the comment event.
CommentEventCanDelete	Bool	False	No	Whether the comment event can be deleted. If true, then the comment event can be deleted.
CommentEventCanEdit	Bool	False	No	Whether the comment event can edited. If true, then the comment event can be edited.
CommentEventEdited	Bool	False	No	Whether the comment event has been edited. If true, then the comment event has been edited.
CommentEventRawMessage	String	False	No	The raw body of the comment event.
CommentEventSubjectId	String	False	No	The parent subject to which the comment event belongs.
CommentEventEmbedCustomerId	String	False	No	The object reference associated with the comment event.
CommentEventEmbedDraftOrderId	String	False	No	The object reference associated with the comment event.
CommentEventEmbedOrderId	String	False	No	The object reference associated with the comment event.
CommentEventEmbedProductId	String	False	No	The object reference associated with the comment event.
CommentEventEmbedProductVariantId	String	False	No	The object reference associated with the comment event.

Return to Top

DiscountsAutomaticApp

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
DiscountId	String	True	No	The ID for the discount.
Title	String	False	No	The title of the discount.
Status	String	True	No	The status of the discount.
DiscountClass	String	True	No	The class of the discount for combining purposes.
EndsAt	Datetime	False	No	The date and time when the discount ends. For open-ended discounts, use 'null'.
StartsAt	Datetime	False	No	The date and time when the discount starts.
AsyncUsageCount	Int	True	No	The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
CreatedAt	Datetime	True	No	The date and time when the discount was created.
UpdatedAt	Datetime	True	No	The date and time when the discount was updated.
AppDiscountTypeFunctionId	String	False	No	The ID of the function providing the app discount type.
AppDiscountTypeTitle	String	True	No	The title of the app discount type.
AppDiscountTypeDescription	String	True	No	A description of the app discount type.
AppDiscountTypeAppKey	String	True	No	The client ID of the app providing the app discount type.
AppDiscountTypeDiscountClass	String	True	No	The class of the app discount type.
AppDiscountTypeTargetType	String	True	No	The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'.
CombinesWithOrderDiscounts	Bool	False	No	Combines with order discounts.
CombinesWithProductDiscounts	Bool	False	No	Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False	No	Combines with shipping discounts.
ErrorHistoryFirstOccurredAt	Datetime	True	No	The date and time that the first error occurred.
ErrorHistoryErrorsFirstOccurredAt	Datetime	True	No	The date and time that the first error occurred.
ErrorHistoryHasSharedRecentErrors	Bool	True	No	Whether the merchant has shared all the recent errors with the developer.
ErrorHistoryHasBeenSharedSinceLastError	Bool	True	No	Whether the merchant has shared all the recent errors with the developer.

Return to Top

DiscountsAutomaticBasic

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Title	String	False	No	The title of the discount.
Status	String	True	No	The status of the discount.
Summary	String	True	No	A detailed summary of the discount.
DiscountClass	String	True	No	The class of the discount for combining purposes.
EndsAt	Datetime	False	No	The date and time when the discount ends. For open-ended discounts, use 'null'.
ShortSummary	String	True	No	A short summary of the discount.
StartsAt	Datetime	False	No	The date and time when the discount starts.
AsyncUsageCount	Int	True	No	The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
CreatedAt	Datetime	True	No	The date and time when the discount was created.
CombinesWithOrderDiscounts	Bool	False	No	Combines with order discounts.
CombinesWithProductDiscounts	Bool	False	No	Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False	No	Combines with shipping discounts.
DiscountMinimumQuantityGreaterThanOrEqualToQuantity	String	True	No	The minimum quantity of items that's required for the discount to be applied.
AppliesOnEachItem	Bool	False	Yes	If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.
DiscountAmount	Decimal	False	Yes	The value of the discount.
ProductsToAdd	String	False	Yes	A simple, comma-separated list of products IDs to add.
ProductsToRemove	String	False	Yes	A simple, comma-separated list of products IDs to remove.
MinimumQuantity	String	False	Yes	The minimum quantity of items that's required for the discount to be applied.
MinimumSubtotal	String	False	Yes	The minimum subtotal that's required for the discount to be applied.

Return to Top

DiscountsAutomaticBxgy

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Title	String	False	No	The title of the discount.
Status	String	True	No	The status of the discount.
Summary	String	True	No	A detailed summary of the discount.
DiscountClass	String	True	No	The class of the discount for combining purposes.
EndsAt	Datetime	False	No	The date and time when the discount ends. For open-ended discounts, use 'null'.
StartsAt	Datetime	False	No	The date and time when the discount starts.
AsyncUsageCount	Int	True	No	The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
UsesPerOrderLimit	Int	False	No	The maximum number of times that the discount can be applied to an order.
CreatedAt	Datetime	True	No	The date and time when the discount was created.
CombinesWithOrderDiscounts	Bool	False	No	Combines with order discounts.
CombinesWithProductDiscounts	Bool	False	No	Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False	No	Combines with shipping discounts.
DiscountOnQuantity	String	False	Yes	The value of the discount.
DiscountPercentage	Double	False	Yes	The value of the discount.
ProductsToAdd	String	False	Yes	A simple, comma-separated list of products IDs to add.
ProductsToRemove	String	False	Yes	A simple, comma-separated list of products IDs to remove.
DiscountQuantityToBuy	String	False	Yes	The quantity of prerequisite items.
DiscountAmountToBuy	String	False	Yes	The value of the discount.
ProductsBuysToAdd	String	False	Yes	A simple, comma-separated list of products IDs to add.
ProductsBuysToRemove	String	False	Yes	A simple, comma-separated list of products IDs to remove.

Return to Top

DiscountsCodeApp

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
DiscountId	String	True	No	The ID for the discount.
Title	String	False	No	The title of the discount.
Status	String	True	No	The status of the discount.
CodesCount	Int	True	No	The number of redeem codes for the discount.
CodesCountPrecision	String	True	No	The count's precision, or the exactness of the value.
DiscountClass	String	True	No	The class of the discount for combining purposes.
EndsAt	Datetime	False	No	The date and time when the discount ends. For open-ended discounts, use 'null'.
StartsAt	Datetime	False	No	The date and time when the discount starts.
UsageLimit	Int	False	No	The maximum number of times that the discount can be used.
AsyncUsageCount	Int	True	No	The number of times that the discount has been used.
HasTimelineComment	Bool	True	No	Indicates whether there are any timeline comments on the discount.
RecurringCycleLimit	Int	True	No	The number of times a discount applies on recurring purchases (subscriptions).
AppliesOncePerCustomer	Bool	False	No	Whether the discount can be applied only once per customer.
CreatedAt	Datetime	True	No	The date and time when the discount was created.
AppDiscountTypeFunctionId	String	False	No	The ID of the function providing the app discount type.
AppDiscountTypeTitle	String	True	No	The title of the app discount type.
AppDiscountTypeDescription	String	True	No	A description of the app discount type.
AppDiscountTypeAppKey	String	True	No	The client ID of the app providing the app discount type.
AppDiscountTypeDiscountClass	String	True	No	The class of the app discount type.
AppDiscountTypeTargetType	String	True	No	The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'.
CombinesWithOrderDiscounts	Bool	False	No	Combines with order discounts.
CombinesWithProductDiscounts	Bool	False	No	Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False	No	Combines with shipping discounts.
DiscountCustomerAllAllCustomers	Bool	False	No	Whether the discount can be applied by all customers. This value is always 'true'.
ErrorHistoryFirstOccurredAt	Datetime	True	No	The date and time that the first error occurred.
ErrorHistoryErrorsFirstOccurredAt	Datetime	True	No	The date and time that the first error occurred.
ErrorHistoryHasSharedRecentErrors	Bool	True	No	Whether the merchant has shared all the recent errors with the developer.
ErrorHistoryHasBeenSharedSinceLastError	Bool	True	No	Whether the merchant has shared all the recent errors with the developer.
TotalSalesAmount	Decimal	True	No	Decimal money amount.
TotalSalesCurrencyCode	String	True	No	Currency of the money.
Code	String	False	Yes	The code to use the discount.
AddAllCustomers	Bool	False	Yes	Whether all customers can use this discount.
CustomersToAdd	String	False	Yes	A simple, comma-separated list of customers IDs to add.
CustomersToRemove	String	False	Yes	A simple, comma-separated list of customers IDs to remove.
CustomerSegmentsToAdd	String	False	Yes	A simple, comma-separated list of customers IDs to add.
CustomerSegmentsToRemove	String	False	Yes	A simple, comma-separated list of customers IDs to remove.

Return to Top

DiscountsCodeBasic

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Title	String	False	No	The title of the discount.
Status	String	True	No	The status of the discount.
Summary	String	True	No	A detailed summary of the discount.
CodesCount	Int	True	No	The number of redeem codes for the discount.
CodesCountPrecision	String	True	No	The count's precision, or the exactness of the value.
DiscountClass	String	True	No	The class of the discount for combining purposes.
EndsAt	Datetime	False	No	The date and time when the discount ends. For open-ended discounts, use 'null'.
ShortSummary	String	True	No	A short summary of the discount.
StartsAt	Datetime	False	No	The date and time when the discount starts.
UsageLimit	Int	False	No	The maximum number of times that the discount can be used.
AsyncUsageCount	Int	True	No	The number of times that the discount has been used.
HasTimelineComment	Bool	True	No	Indicates whether there are any timeline comments on the discount.
RecurringCycleLimit	Int	False	No	The number of times a discount applies on recurring purchases (subscriptions).
AppliesOncePerCustomer	Bool	False	No	Whether the discount can be applied only once per customer.
CreatedAt	Datetime	True	No	The date and time when the discount was created.
CombinesWithOrderDiscounts	Bool	False	No	Combines with order discounts.
CombinesWithProductDiscounts	Bool	False	No	Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False	No	Combines with shipping discounts.
CustomerGetsAppliesOnSubscription	Bool	False	No	Whether the discount applies on subscription items.
CustomerGetsAppliesOnOneTimePurchase	Bool	False	No	Whether the discount applies on regular one-time-purchase items.
DiscountCustomerAllAllCustomers	Bool	False	No	Whether the discount can be applied by all customers. This value is always 'true'.
DiscountMinimumQuantityGreaterThanOrEqualToQuantity	String	False	No	The minimum quantity of items that's required for the discount to be applied.
TotalSalesAmount	Decimal	True	No	Decimal money amount.
TotalSalesCurrencyCode	String	True	No	Currency of the money.
Code	String	False	Yes	The code to use the discount.
AppliesOnEachItem	Bool	False	Yes	If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.
DiscountAmount	Decimal	False	Yes	The value of the discount.
ProductsToAdd	String	False	Yes	A simple, comma-separated list of products IDs to add.
ProductsToRemove	String	False	Yes	A simple, comma-separated list of products IDs to remove.
AddAllCustomers	Bool	False	Yes	Whether all customers can use this discount.
CustomersToAdd	String	False	Yes	A simple, comma-separated list of customers IDs to add.
CustomersToRemove	String	False	Yes	A simple, comma-separated list of customers IDs to remove.
CustomerSegmentsToAdd	String	False	Yes	A simple, comma-separated list of customers IDs to add.
CustomerSegmentsToRemove	String	False	Yes	A simple, comma-separated list of customers IDs to remove.

Return to Top

DiscountsCodeBxgy

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Title	String	False	No	The title of the discount.
Status	String	True	No	The status of the discount.
Summary	String	True	No	A detailed summary of the discount.
CodesCount	Int	True	No	The number of redeem codes for the discount.
CodesCountPrecision	String	True	No	The count's precision, or the exactness of the value.
DiscountClass	String	True	No	The class of the discount for combining purposes.
EndsAt	Datetime	False	No	The date and time when the discount ends. For open-ended discounts, use 'null'.
StartsAt	Datetime	False	No	The date and time when the discount starts.
UsageLimit	Int	False	No	The maximum number of times that the discount can be used.
AsyncUsageCount	Int	True	No	The number of times that the discount has been used.
HasTimelineComment	Bool	True	No	Indicates whether there are any timeline comments on the discount.
AppliesOncePerCustomer	Bool	False	No	Whether the discount can be applied only once per customer.
UsesPerOrderLimit	Int	False	No	The maximum number of times that the discount can be applied to an order.
CreatedAt	Datetime	True	No	The date and time when the discount was created.
CombinesWithOrderDiscounts	Bool	False	No	Combines with order discounts.
CombinesWithProductDiscounts	Bool	False	No	Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False	No	Combines with shipping discounts.
CustomerGetsAppliesOnSubscription	Bool	True	No	Whether the discount applies on subscription items.
CustomerGetsAppliesOnOneTimePurchase	Bool	True	No	Whether the discount applies on regular one-time-purchase items.
DiscountCustomerAllAllCustomers	Bool	True	No	Whether the discount can be applied by all customers. This value is always 'true'.
TotalSalesAmount	Decimal	True	No	Decimal money amount.
TotalSalesCurrencyCode	String	True	No	Currency of the money.
Code	String	False	Yes	The code to use the discount.
DiscountOnQuantity	String	False	Yes	The value of the discount.
DiscountPercentage	Double	False	Yes	The value of the discount.
ProductsToAdd	String	False	Yes	A simple, comma-separated list of products IDs to add.
ProductsToRemove	String	False	Yes	A simple, comma-separated list of products IDs to remove.
DiscountAmountToBuy	String	False	Yes	The value of the discount.
DiscountQuantityToBuy	Double	False	Yes	The quantity of prerequisite items.
ProductsBuysToAdd	String	False	Yes	A simple, comma-separated list of products IDs to add.
ProductsBuysToRemove	String	False	Yes	A simple, comma-separated list of products IDs to remove.
AddAllCustomers	Bool	False	Yes	Whether all customers can use this discount.
CustomersToAdd	String	False	Yes	A simple, comma-separated list of customers IDs to add.
CustomersToRemove	String	False	Yes	A simple, comma-separated list of customers IDs to remove.
CustomerSegmentsToAdd	String	False	Yes	A simple, comma-separated list of customers IDs to add.
CustomerSegmentsToRemove	String	False	Yes	A simple, comma-separated list of customers IDs to remove.

Return to Top

DiscountsCodeFreeShipping

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
Title	String	False	No	The title of the discount.
Status	String	False	No	The status of the discount.
Summary	String	False	No	A detailed summary of the discount.
CodesCount	Int	False	No	The number of redeem codes for the discount.
CodesCountPrecision	String	False	No	The count's precision, or the exactness of the value.
DiscountClass	String	False	No	The class of the discount for combining purposes.
EndsAt	Datetime	False	No	The date and time when the discount ends. For open-ended discounts, use 'null'.
ShortSummary	String	False	No	A short summary of the discount.
StartsAt	Datetime	False	No	The date and time when the discount starts.
UsageLimit	Int	False	No	The maximum number of times that the discount can be used.
AppliesOnSubscription	Bool	False	No	Whether the discount applies on subscription shipping lines.
AsyncUsageCount	Int	False	No	The number of times that the discount has been used.
HasTimelineComment	Bool	False	No	Indicates whether there are any timeline comments on the discount.
RecurringCycleLimit	Int	False	No	The number of times a discount applies on recurring purchases (subscriptions).
AppliesOncePerCustomer	Bool	False	No	Whether the discount can be applied only once per customer.
AppliesOnOneTimePurchase	Bool	False	No	Whether the discount applies on regular one-time-purchase shipping lines.
CreatedAt	Datetime	False	No	The date and time when the discount was created.
CombinesWithOrderDiscounts	Bool	False	No	Combines with order discounts.
CombinesWithProductDiscounts	Bool	False	No	Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False	No	Combines with shipping discounts.
DiscountCustomerAllAllCustomers	Bool	False	No	Whether the discount can be applied by all customers. This value is always 'true'.
DiscountCountriesCountries	String	False	No	The codes for the countries where the discount can be applied.
DiscountCountriesIncludeRestOfWorld	Bool	False	No	Whether the discount is applicable to countries that have not been defined in the shop's shipping zones.
DiscountCountryAllAllCountries	Bool	False	No	Whether the discount can be applied to all countries as shipping destination. This value is always 'true'.
MaximumShippingPriceAmount	Decimal	False	No	Decimal money amount.
MaximumShippingPriceCurrencyCode	String	False	No	Currency of the money.
DiscountMinimumQuantityGreaterThanOrEqualToQuantity	String	False	No	The minimum quantity of items that's required for the discount to be applied.
TotalSalesAmount	Decimal	False	No	Decimal money amount.
TotalSalesCurrencyCode	String	False	No	Currency of the money.

Return to Top

DraftOrderCustomAttributes

Name	Type	ReadOnly	References	FilterOnly	Description
ResourceId [KEY]	String	False	DraftOrders.Id	No	A globally-unique ID.
Key [KEY]	String	False		No	Key or name of the attribute.
Value	String	False		No	Value of the attribute.

Return to Top

DraftOrderEvents

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
HostId	String	False	DraftOrders.Id	No	A globally-unique ID.
AppTitle	String	False		No	The name of the app that created the event.
AttributeToApp	Bool	False		No	Whether the event was created by an app.
AttributeToUser	Bool	False		No	Whether the event was caused by an admin user.
CreatedAt	Datetime	False		No	The date and time when the event was created.
CriticalAlert	Bool	False		No	Whether the event is critical.
Message	String	False		No	Human readable text that describes the event.
CommentEventAuthorId	String	False		No	The id of the staff member that authored the comment event.
CommentEventCanDelete	Bool	False		No	Whether the comment event can be deleted. If true, then the comment event can be deleted.
CommentEventCanEdit	Bool	False		No	Whether the comment event can edited. If true, then the comment event can be edited.
CommentEventEdited	Bool	False		No	Whether the comment event has been edited. If true, then the comment event has been edited.
CommentEventRawMessage	String	False		No	The raw body of the comment event.
CommentEventSubjectId	String	False		No	The parent subject to which the comment event belongs.
CommentEventEmbedCustomerId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedDraftOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductVariantId	String	False		No	The object reference associated with the comment event.

Return to Top

DraftOrderLineItemCustomAttributes

Name	Type	ReadOnly	References	FilterOnly	Description
ResourceId [KEY]	String	False	DraftOrderLineItems.Id	No	A globally-unique ID.
Key [KEY]	String	False		No	Key or name of the attribute.
Value	String	False		No	Value of the attribute.

Return to Top

DraftOrderLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
DraftOrderId	String	False	DraftOrders.Id	No	A globally-unique ID.
Name	String	False		No	The name of the product.
Title	String	False		No	The title of the product or variant. This field only applies to custom line items.
VariantTitle	String	False		No	The name of the variant.
Custom	Bool	False		No	Whether the line item is a custom line item ('true') or a product variant line item ('false').
Quantity	Int	False		No	The number of product variants that are requested in the draft order.
Sku	String	False		No	The SKU number of the product variant.
Taxable	Bool	False		No	Whether the variant is taxable.
Vendor	String	False		No	The name of the vendor who created the product variant.
RequiresShipping	Bool	False		No	Whether physical shipping is required for the variant.
IsGiftCard	Bool	False		No	Whether the line item is a gift card.
AppliedDiscountTitle	String	False		No	Name of the order-level discount.
AppliedDiscountDescription	String	False		No	Description of the order-level discount.
AppliedDiscountValue	Double	False		No	The order level discount amount. If 'valueType' is 'percentage', then 'value' is the percentage discount.
AppliedDiscountValueType	String	False		No	Type of the order-level discount.
AppliedDiscountAmountV2Amount	Decimal	False		No	Decimal money amount.
AppliedDiscountAmountV2CurrencyCode	String	False		No	Currency of the money.
DiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
FulfillmentServiceId	String	False		No	The ID of the fulfillment service.
ImageId	String	False		No	A unique ID for the image.
ImageWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False		No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False		No	The location of the image as a URL.
OriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
ProductId	String	False		No	A globally-unique ID.
TotalDiscountSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
TotalDiscountSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
VariantId	String	False		No	A globally-unique ID.
WeightValue	Double	False		No	The weight value using the unit system specified with 'unit'.
WeightUnit	String	False		No	The unit of measurement for 'value'.

Return to Top

DraftOrderLineItemTaxLines

Name	Type	ReadOnly	References	FilterOnly	Description
Title [KEY]	String	False		No	The name of the tax.
ResourceId [KEY]	String	False	DraftOrderLineItems.Id	No	A globally-unique ID.
Rate	Double	False		No	The proportion of the line item price that the tax represents as a decimal.
ChannelLiable	Bool	False		No	Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentage	Double	False		No	The proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

DraftOrders

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique ID.
LegacyResourceId	String	True		No	The ID of the corresponding resource in the REST Admin API.
Name	String	True		No	The identifier for the draft order, which is unique within the store. For example, #D1223.
MarketName	String	True		No	The name of the selected market.
Email	String	False		No	Email address of the customer, which is used to send notifications to.
Note2	String	True		No	The text from an optional note attached to the draft order.
Phone	String	True		No	The phone number assigned to the draft order.
Ready	Bool	True		No	Whether the Draft Order is ready and can be completed. Draft Orders might have asynchronous operations that can take time to finish.
Status	String	True		No	Status of the draft order.
Tags	String	True		No	A comma separated list of tags associated with the draft order. Updating 'tags' overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the mutation.
CompletedAt	Datetime	True		No	The date and time when the draft order converted to a new order, and the draft order's status changed to Completed.
CurrencyCode	String	True		No	The three letter code for the currency of the store at the time of the most recent update to the draft order.
DefaultCursor	String	True		No	A default cursor that returns the single next record, sorted ascending by ID.
InvoiceUrl	String	True		No	The link to the checkout, which is sent to the customer in the invoice email.
TaxExempt	Bool	True		No	Whether the draft order is tax exempt.
TaxesIncluded	Bool	True		No	Whether the line item prices include taxes.
TotalWeight	String	True		No	The total weight in grams of the draft order.
HasTimelineComment	Bool	True		No	Whether the merchant has added timeline comments to the draft order.
InvoiceSentAt	Datetime	True		No	The date and time when the invoice was last emailed to the customer.
PresentmentCurrencyCode	String	True		No	The payment currency of the customer for this draft order.
ReserveInventoryUntil	Datetime	True		No	The time after which inventory will automatically be restocked.
VisibleToCustomer	Bool	True		No	Whether the draft order will be visible to the customer on the self-serve portal.
InvoiceEmailTemplateSubject	String	True		No	The subject defined for the draft invoice email template.
MarketRegionCountryCode	String	True		No	The selected market region country code for the draft order.
BillingAddressMatchesShippingAddress	Bool	True		No	Whether the billing address matches the shipping address.
CreatedAt	Datetime	True		No	The date and time when the draft order was created in Shopify.
UpdatedAt	Datetime	True		No	The date and time when the draft order was last changed. The format is YYYY-MM-DD HH: mm: ss. For example, 2016-02-05 17: 04: 01.
OrderId	String	True		No	A globally-unique ID.
PurchasingEntityCustomerId	String	True		No	A globally-unique ID.
PurchasingEntityCompanyCompanyId	String	True		No	A globally-unique ID.
CustomerId	String	False	Customers.Id	No	Customer who will be sent an invoice for the draft order, if there is one.
BillingAddressId	String	False		No	A globally-unique ID.
BillingAddressCoordinatesValidated	Bool	True		No	Whether the address coordinates are valid.
BillingAddressName	String	True		No	The full name of the customer, based on firstName and lastName.
BillingAddressFirstName	String	False		No	The first name of the customer.
BillingAddressLastName	String	False		No	The last name of the customer.
BillingAddressAddress1	String	False		No	The first line of the address. Typically the street address or PO Box number.
BillingAddressAddress2	String	False		No	The second line of the address. Typically the number of the apartment, suite, or unit.
BillingAddressCity	String	False		No	The name of the city, district, village, or town.
BillingAddressCompany	String	False		No	The name of the customer's company or organization.
BillingAddressCountry	String	False		No	The name of the country.
BillingAddressLatitude	Double	True		No	The latitude coordinate of the customer address.
BillingAddressLongitude	Double	True		No	The longitude coordinate of the customer address.
BillingAddressPhone	String	False		No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
BillingAddressProvince	String	False		No	The region of the address, such as the province, state, or district.
BillingAddressZip	String	False		No	The zip or postal code of the address.
BillingAddressFormattedArea	String	True		No	A comma-separated list of the values for city, province, and country.
BillingAddressProvinceCode	String	False		No	The two-letter code for the region. For example, ON.
BillingAddressCountryCodeV2	String	False		No	The two-letter code for the country of the address. For example, US.
ShippingAddressId	String	False		No	A globally-unique ID.
ShippingAddressCoordinatesValidated	Bool	True		No	Whether the address coordinates are valid.
ShippingAddressName	String	True		No	The full name of the customer, based on firstName and lastName.
ShippingAddressFirstName	String	False		No	The first name of the customer.
ShippingAddressLastName	String	False		No	The last name of the customer.
ShippingAddressAddress1	String	False		No	The first line of the address. Typically the street address or PO Box number.
ShippingAddressAddress2	String	False		No	The second line of the address. Typically the number of the apartment, suite, or unit.
ShippingAddressCity	String	False		No	The name of the city, district, village, or town.
ShippingAddressCompany	String	False		No	The name of the customer's company or organization.
ShippingAddressCountry	String	False		No	The name of the country.
ShippingAddressLatitude	Double	True		No	The latitude coordinate of the customer address.
ShippingAddressLongitude	Double	True		No	The longitude coordinate of the customer address.
ShippingAddressPhone	String	False		No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
ShippingAddressProvince	String	False		No	The region of the address, such as the province, state, or district.
ShippingAddressZip	String	False		No	The zip or postal code of the address.
ShippingAddressFormattedArea	String	True		No	A comma-separated list of the values for city, province, and country.
ShippingAddressProvinceCode	String	False		No	The two-letter code for the region. For example, ON.
ShippingAddressCountryCodeV2	String	False		No	The two-letter code for the country of the address. For example, US.
ShippingLineId	String	True		No	A globally-unique ID.
ShippingLineCarrierIdentifier	String	True		No	A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
ShippingLineTitle	String	True		No	Returns the title of the shipping line.
ShippingLineCode	String	True		No	A reference to the shipping method.
ShippingLineCustom	Bool	True		No	Whether the shipping line is custom or not.
ShippingLinePhone	String	True		No	The phone number at the shipping address.
ShippingLineSource	String	True		No	Returns the rate source for the shipping line.
ShippingLineDeliveryCategory	String	True		No	The general classification of the delivery method.
ShippingLineShippingRateHandle	String	True		No	A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.
ShippingLineRequestedFulfillmentServiceId	String	True		No	The ID of the fulfillment service.
AppliedDiscountTitle	String	False		No	Name of the order-level discount.
AppliedDiscountDescription	String	False		No	Description of the order-level discount.
AppliedDiscountValue	Double	False		No	Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount).
AppliedDiscountValueType	String	False		No	Type of the order-level discount.
PaymentTermsId	String	True		No	A globally-unique ID.
PaymentTermsTranslatedName	String	True		No	The payment terms name, translated into the shop admin's preferred language.
PaymentTermsPaymentTermsName	String	True		No	The name of the payment terms template used to create the payment terms.
PaymentTermsOverdue	Bool	True		No	Whether the payment terms have overdue payment schedules.
PaymentTermsDueInDays	Int	True		No	Duration of payment terms in days based on the payment terms template used to create the payment terms.
PaymentTermsPaymentTermsType	String	True		No	The payment terms template type used to create the payment terms.
PaymentTermsOrderId	String	True		No	A globally-unique ID.
AppliedDiscountAmountV2Amount	Decimal	False		No	Decimal money amount.
AppliedDiscountAmountV2CurrencyCode	String	True		No	Currency of the money.
LineItemsSubtotalPricePresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
LineItemsSubtotalPricePresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
LineItemsSubtotalPriceShopMoneyAmount	Decimal	True		No	Decimal money amount.
LineItemsSubtotalPriceShopMoneyCurrencyCode	String	True		No	Currency of the money.
SubtotalPriceSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
SubtotalPriceSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
SubtotalPriceSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
SubtotalPriceSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
TotalDiscountsSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
TotalDiscountsSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
TotalDiscountsSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
TotalDiscountsSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
TotalLineItemsPriceSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
TotalLineItemsPriceSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
TotalLineItemsPriceSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
TotalLineItemsPriceSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
TotalPriceSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
TotalPriceSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
TotalPriceSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
TotalPriceSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
TotalShippingPriceSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
TotalShippingPriceSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
TotalShippingPriceSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
TotalShippingPriceSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
TotalTaxSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
TotalTaxSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
TotalTaxSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
TotalTaxSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
DraftOrderLineItems	String	False		No	The list of the line items in the draft order.
DiscountCodes	String	False		No	The discount codes used for the draft order.
AcceptAutomaticDiscounts	Bool	False		No	Whether or not to accept automatic discounts on the draft order during calculation.
AllowDiscountCodesInCheckout	Bool	False		No	Whether discount codes are allowed during checkout of this draft order.
Warnings	String	True		No	The list of warnings raised while calculating.
PlatformDiscountIds	String	True		No	The list of platform discounts applied.

Return to Top

DraftOrderTaxLines

Name	Type	ReadOnly	References	FilterOnly	Description
Title [KEY]	String	False		No	The name of the tax.
ResourceId [KEY]	String	False	DraftOrders.Id	No	A globally-unique ID.
Rate	Double	False		No	The proportion of the line item price that the tax represents as a decimal.
ChannelLiable	Bool	False		No	Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentage	Double	False		No	The proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

Files

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Description	String	True	No	The description of the file.
Status	String	True	No	The status of the file.
FileErrors	String	True	No	Any errors that have occurred on the file.
CreatedAt	Datetime	True	No	The date and time at which the file was created in Shopify.
UpdatedAt	Datetime	True	No	The date and time at which the file was last modified.

Return to Top

FulfillmentEvents

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique ID.
FulfillmentId	String	True	Fulfillments.Id	No	A globally-unique ID.
OrderId	String	True	Orders.Id	No	A globally-unique identifier.
Status	String	True		No	The status of this fulfillment event.
HappenedAt	Datetime	True		No	The time at which this fulfillment event happened.
Address1	String	True		No	The street address where this fulfillment event occurred.
City	String	True		No	The city where this fulfillment event occurred.
Country	String	True		No	The country where this fulfillment event occurred.
Latitude	Double	True		No	The latitude where this fulfillment event occurred.
Longitude	Double	True		No	The longitude where this fulfillment event occurred.
Message	String	True		No	A message associated with this fulfillment event.
Province	String	True		No	The province where this fulfillment event occurred.
Zip	String	True		No	The zip code of the location where this fulfillment event occurred.
EstimatedDeliveryAt	Datetime	True		No	The estimated delivery date and time of the fulfillment.

Return to Top

FulfillmentLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
FulfillmentId	String	False	Fulfillments.Id	No	A globally-unique ID.
DiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
Quantity	Int	False		No	Number of line items in the fulfillment.
LineItemId	String	False		No	A globally-unique ID.
LineItemName	String	False		No	The title of the product, optionally appended with the title of the variant (if applicable).
LineItemTitle	String	False		No	The title of the product at time of order creation.
LineItemVariantTitle	String	False		No	The title of the variant at time of order creation.
LineItemVariantId	String	False		No	A globally-unique ID.
LineItemProductId	String	False		No	A globally-unique ID.
LineItemSellingPlanSellingPlanId	String	False		No	The ID of the selling plan associated with the line item.
LineItemQuantity	Int	False		No	The number of variant units ordered.
LineItemRestockable	Bool	False		No	Whether the line item can be restocked.
LineItemSku	String	False		No	The variant SKU number.
LineItemTaxable	Bool	False		No	Whether the variant is taxable.
LineItemVendor	String	False		No	The name of the vendor who made the variant.
LineItemCurrentQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
LineItemMerchantEditable	Bool	False		No	Whether the line item can be edited or not.
LineItemRefundableQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
LineItemRequiresShipping	Bool	False		No	Whether physical shipping is required for the variant.
LineItemUnfulfilledQuantity	Int	False		No	The number of units not yet fulfilled.
LineItemNonFulfillableQuantity	Int	False		No	The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details.
LineItemIsGiftCard	Bool	False		No	Whether the line item represents the purchase of a gift card.
LineItemDiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemDiscountedTotalSetPresentmentMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
LineItemDiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemDiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemDiscountedTotalSetShopMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
LineItemDiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemDiscountedUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemDiscountedUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemDiscountedUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemDiscountedUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemImageId	String	False		No	A unique ID for the image.
LineItemImageWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
LineItemImageAltText	String	False		No	A word or phrase to share the nature or contents of an image.
LineItemImageHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
LineItemImageUrl	String	False		No	The location of the image as a URL.
LineItemOriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemOriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemOriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemOriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemOriginalUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemOriginalUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemOriginalUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemOriginalUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemTotalDiscountSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemTotalDiscountSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemTotalDiscountSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemTotalDiscountSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemUnfulfilledDiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemUnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemUnfulfilledDiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemUnfulfilledDiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemUnfulfilledOriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemUnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemUnfulfilledOriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
LineItemUnfulfilledOriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

FulfillmentLineItemTaxLines

Name	Type	ReadOnly	References	FilterOnly	Description
Title [KEY]	String	False		No	The name of the tax.
ResourceId [KEY]	String	False	FulfillmentLineItems.Id	No	A globally-unique ID.
Rate	Double	False		No	The proportion of the line item price that the tax represents as a decimal.
ChannelLiable	Bool	False		No	Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentage	Double	False		No	The proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

FulfillmentOrderLineItems

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The unique identifier of the line item.
FulfillmentOrderId	String	False	No	The unique identifier of the fulfillment order.
ImageId	String	False	No	A unique ID for the image.
ImageWidth	Int	False	No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False	No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False	No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False	No	The location of the image as a URL.
InventoryItemId	String	False	No	The ID of the inventory item.
Sku	String	False	No	The variant SKU number.
ProductTitle	String	False	No	The title of the product.
VariantTitle	String	False	No	The name of the variant.
Vendor	String	False	No	The name of the vendor who made the variant.
RemainingQuantity	Int	False	No	The number of units remaining to be fulfilled.
TotalQuantity	Int	False	No	The total number of units to be fulfilled.
RequiresShipping	Bool	False	No	Whether physical shipping is required for the variant.
WeightUnit	String	False	No	The weight of a line item unit. The unit of measurement for value.
WeightValue	Double	False	No	The weight value using the unit system specified with unit.
Warnings	String	False	No	Warning messages for a fulfillment order line item.
FinancialSummaries	String	False	No	The financial summary for the Fulfillment Order's Line Items.

Return to Top

FulfillmentOrderLocationForMoveAvailableLineItems

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The unique identifier of the line item.
FulfillmentOrderId	String	False	No	The unique identifier of the fulfillment order.
ImageId	String	False	No	A unique ID for the image.
ImageWidth	Int	False	No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False	No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False	No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False	No	The location of the image as a URL.
InventoryItemId	String	False	No	The ID of the inventory item.
Sku	String	False	No	The variant SKU number.
ProductTitle	String	False	No	The title of the product.
VariantTitle	String	False	No	The name of the variant.
Vendor	String	False	No	The name of the vendor who made the variant.
RemainingQuantity	Int	False	No	The number of units remaining to be fulfilled.
TotalQuantity	Int	False	No	The total number of units to be fulfilled.
RequiresShipping	Bool	False	No	Whether physical shipping is required for the variant.
WeightUnit	String	False	No	The weight of a line item unit. The unit of measurement for value.
WeightValue	Double	False	No	The weight value using the unit system specified with unit.
Warnings	String	False	No	Warning messages for a fulfillment order line item.
FinancialSummaries	String	False	No	The financial summary for the Fulfillment Order's Line Items.
LocationId [KEY]	String	False	No	The unique identifier of the location.

Return to Top

FulfillmentOrderLocationForMoveUnavailableLineItems

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	The unique identifier of the line item.
FulfillmentOrderId	String	False	No	The unique identifier of the fulfillment order.
ImageId	String	False	No	A unique ID for the image.
ImageWidth	Int	False	No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False	No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False	No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False	No	The location of the image as a URL.
InventoryItemId	String	False	No	The ID of the inventory item.
Sku	String	False	No	The variant SKU number.
ProductTitle	String	False	No	The title of the product.
VariantTitle	String	False	No	The name of the variant.
Vendor	String	False	No	The name of the vendor who made the variant.
RemainingQuantity	Int	False	No	The number of units remaining to be fulfilled.
TotalQuantity	Int	False	No	The total number of units to be fulfilled.
RequiresShipping	Bool	False	No	Whether physical shipping is required for the variant.
WeightUnit	String	False	No	The weight of a line item unit. The unit of measurement for value.
WeightValue	Double	False	No	The weight value using the unit system specified with unit.
Warnings	String	False	No	Warning messages for a fulfillment order line item.
FinancialSummaries	String	False	No	The financial summary for the Fulfillment Order's Line Items.
LocationId [KEY]	String	False	No	The unique identifier of the location.

Return to Top

FulfillmentOrderLocationsForMove

Name	Type	ReadOnly	FilterOnly	Description
FulfillmentOrderId [KEY]	String	False	No	The unique identifier of the fulfillment order.
LocationId [KEY]	String	False	No	The unique identifier of the location.
AvailableLineItemsCount	Int	False	No	Total number of fulfillment order line items that can be moved from their current assigned location to the given location.
AvailableLineItemsCountPrecision	String	False	No	The count's precision, or the exactness of the value.
UnavailableLineItemsCount	Int	False	No	Total number of fulfillment order line items that can't be moved from their current assigned location to the given location.
UnavailableLineItemsCountPrecision	String	False	No	The count's precision, or the exactness of the value.
Movable	Bool	False	No	Whether the fulfillment order can be moved to the location.
Message	String	False	No	A human-readable string with the reason why the fulfillment order, or some of its line items, can't be moved to the location.

Return to Top

FulfillmentOrders

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Status	String	False	No	The status of the fulfillment order.
FulfillAt	Datetime	True	No	The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the 'fulfill_at' date for a subscription order might be the 1st of each month, a pre-order 'fulfill_at' date would be 'nil', and a standard order 'fulfill_at' date would be the order creation date.
FulfillBy	Datetime	True	No	The latest date and time by which all items in the fulfillment order need to be fulfilled.
OrderName	String	True	No	The unique identifier for the order that appears on the order page.
RequestStatus	String	True	No	The request status of the fulfillment order.
CreatedAt	Datetime	True	No	Date and time when the fulfillment order was created.
UpdatedAt	Datetime	True	No	The date and time when the fulfillment order was last updated.
OrderProcessedAt	Datetime	True	No	The date and time when the fulfillment order was processed at.
AssignedLocationName	String	True	No	The name of the location.
AssignedLocationAddress1	String	True	No	The first line of the address for the location.
AssignedLocationAddress2	String	True	No	The second line of the address for the location.
AssignedLocationCity	String	True	No	The city of the location.
AssignedLocationPhone	String	True	No	The phone number of the location.
AssignedLocationProvince	String	True	No	The province of the location.
AssignedLocationZip	String	True	No	The ZIP code of the location.
AssignedLocationCountryCode	String	True	No	The two-letter country code of the location.
AssignedLocationLocationId	String	True	No	A globally-unique ID.
AssignedLocationLocationLegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
AssignedLocationLocationName	String	True	No	The name of the location.
AssignedLocationLocationActivatable	Bool	True	No	Whether this location can be reactivated.
AssignedLocationLocationDeactivatable	Bool	True	No	Whether this location can be deactivated.
AssignedLocationLocationDeletable	Bool	True	No	Whether this location can be deleted.
AssignedLocationLocationAddressVerified	Bool	True	No	Whether the location address has been verified.
AssignedLocationLocationDeactivatedAt	String	True	No	The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'.
AssignedLocationLocationIsActive	Bool	True	No	Whether the location is active.
AssignedLocationLocationShipsInventory	Bool	True	No	Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
AssignedLocationLocationFulfillsOnlineOrders	Bool	True	No	Whether this location can fulfill online orders.
AssignedLocationLocationHasActiveInventory	Bool	True	No	Whether this location has active inventory.
AssignedLocationLocationHasUnfulfilledOrders	Bool	True	No	Whether this location has orders that need to be fulfilled.
DeliveryMethodId	String	True	No	A globally-unique ID.
DeliveryMethodMethodType	String	True	No	The type of the delivery method.
DeliveryMethodMaxDeliveryDateTime	Datetime	True	No	The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
DeliveryMethodMinDeliveryDateTime	Datetime	True	No	The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
DeliveryMethodServiceCode	String	True	No	A reference to the shipping method.
DeliveryMethodSourceReference	String	True	No	Promise provider specific data associated with delivery promise.
DeliveryMethodBrandedPromiseName	String	True	No	The name of the branded promise. For example: 'Shop Promise'.
DeliveryMethodBrandedPromiseHandle	String	True	No	The handle of the branded promise. For example: 'shop_promise'.
DeliveryMethodAdditionalInformationPhone	String	True	No	The phone number to contact when performing the delivery.
DeliveryMethodAdditionalInformationInstructions	String	True	No	The delivery instructions to follow when performing the delivery.
DestinationId	String	True	No	A globally-unique ID.
DestinationFirstName	String	True	No	The first name of the customer at the destination.
DestinationLastName	String	True	No	The last name of the customer at the destination.
DestinationAddress1	String	True	No	The first line of the address of the destination.
DestinationAddress2	String	True	No	The second line of the address of the destination.
DestinationCity	String	True	No	The city of the destination.
DestinationCompany	String	True	No	The company of the destination.
DestinationEmail	String	True	No	The email of the customer at the destination.
DestinationPhone	String	True	No	The phone number of the customer at the destination.
DestinationProvince	String	True	No	The province of the destination.
DestinationZip	String	True	No	The ZIP code of the destination.
DestinationCountryCode	String	True	No	The two-letter country code of the destination.
InternationalDutiesIncoterm	String	True	No	The method of duties payment. Example values: 'DDP', 'DAP'.
OrderId	String	True	No	A globally-unique ID.

Return to Top

Fulfillments

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
LegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
OrderId	String	True	No	Globally unique identifier.
Name	String	True	No	Human readable reference identifier for this fulfillment.
Status	String	True	No	The status of the fulfillment.
DeliveredAt	Datetime	True	No	The date that this fulfillment was delivered.
DisplayStatus	String	True	No	Human readable display status for this fulfillment.
RequiresShipping	Bool	True	No	Whether any of the line items in the fulfillment require shipping.
TotalQuantity	Int	True	No	Sum of all line item quantities for the fulfillment.
EstimatedDeliveryAt	Datetime	True	No	The estimated date that this fulfillment will arrive.
InTransitAt	Datetime	True	No	The date and time when the fulfillment went into transit.
CreatedAt	Datetime	True	No	The date and time when the fulfillment was created.
UpdatedAt	Datetime	True	No	The date and time when the fulfillment was last modified.
LocationId	String	True	No	A globally-unique ID.
ServiceId	String	True	No	The ID of the fulfillment service.
OriginAddressAddress1	String	True	No	The street address of the fulfillment location.
OriginAddressAddress2	String	True	No	The second line of the address. Typically the number of the apartment, suite, or unit.
OriginAddressCity	String	True	No	The city in which the fulfillment location is located.
OriginAddressCountryCode	String	True	No	The country code of the fulfillment location.
OriginAddressProvinceCode	String	True	No	The province code of the fulfillment location.
OriginAddressZip	String	True	No	The zip code of the fulfillment location.
TrackingInfoNumber	String	True	No	TrackingInfoNumber
TrackingInfoUrl	String	True	No	TrackingInfoUrl
FulfillmentOrderIds	String	False	Yes	An aggregated object containing the FulfillmentOrder ids. Ex: [{'fulfillmentOrderId': 'gid://shopify/FulfillmentOrder/xxx'}]

Return to Top

FulfillmentServices

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	The ID of the fulfillment service.
ServiceName	String	False	No	The name of the fulfillment service as seen by merchants.
Handle	String	True	No	Human-readable unique identifier for this fulfillment service.
Type	String	True	No	Type associated with the fulfillment service.
CallbackUrl	String	False	No	The callback URL the fulfillment service has registered for requests.
InventoryManagement	Bool	False	No	Whether the fulfillment service tracks product inventory and provides updates to Shopify.
PermitsSkuSharing	Bool	True	No	Whether the fulfillment service can stock inventory alongside other locations.
LocationId	String	True	No	Globally unique identifier.

Return to Top

FulfillmentTrackingInfo

Name	Type	ReadOnly	References	FilterOnly	Description
FulfillmentId	String	False	Fulfillments.Id	No	The ID of the Fulfillment to return.
Company	String	False		No	The name of the tracking company.
Number	String	False		No	The tracking number of the fulfillment.
Url	String	False		No	The URLs to track the fulfillment.

Return to Top

GiftCards

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Enabled	Bool	True	No	Whether the gift card is enabled.
Note	String	False	No	The note associated with the gift card, which is not visible to the customer.
DisabledAt	Datetime	True	No	The date and time at which the gift card was disabled.
ExpiresOn	Date	False	No	The date at which the gift card will expire.
LastCharacters	String	True	No	The final four characters of the gift card code.
MaskedCode	String	True	No	The gift card code. Everything but the final four characters is masked.
CreatedAt	Datetime	True	No	The date and time at which the gift card was created.
BalanceAmount	Decimal	True	No	Decimal money amount.
BalanceCurrencyCode	String	True	No	Currency of the money.
InitialValueAmount	Decimal	True	No	Decimal money amount.
InitialValueCurrencyCode	String	True	No	Currency of the money.
CustomerId	String	False	No	A globally-unique ID.
OrderId	String	True	No	A globally-unique ID.

Return to Top

InventoryItemCountryHarmonizedSystemCodes

Name	Type	ReadOnly	References	FilterOnly	Description
InventoryItemId	String	False	InventoryItems.Id	No	A globally-unique ID.
CountryCode	String	False		No	The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code.
HarmonizedSystemCode [KEY]	String	False		No	The country-specific harmonized system code. These are usually longer than 6 digits.

Return to Top

InventoryItemInventoryLevelQuantities

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
InventoryLevelId	String	False	InventoryItemInventoryLevels.Id	No	A globally-unique ID.
InventoryLevelLocationId	String	False		No	A globally-unique ID.
Name	String	False		No	The name that identifies the inventory quantity.
Quantity	Int	False		No	The quantity for the quantity name.
UpdatedAt	Datetime	False		No	When the quantity was last updated.

Return to Top

InventoryItemInventoryLevels

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
InventoryItemId	String	False	InventoryItems.Id	No	A globally-unique ID.
LocationId	String	False		No	A globally-unique ID.
CanDeactivate	Bool	False		No	Whether the inventory items associated with the inventory level can be deactivated.
DeactivationAlert	String	False		No	Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.
CreatedAt	Datetime	False		No	The date and time when the inventory level was created.
UpdatedAt	Datetime	False		No	The date and time when the inventory level was updated.

Return to Top

InventoryItems

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
LegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
VariantId	String	True	No	A globally-unique ID.
Sku	String	False	No	Inventory item SKU.
Tracked	Bool	False	No	Whether inventory levels are tracked for the item.
LocationsCount	Int	True	No	The number of locations where this inventory item is stocked.
LocationsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
RequiresShipping	Bool	False	No	Whether the inventory item requires shipping.
DuplicateSkuCount	Int	True	No	The number of inventory items that share the same SKU with this item.
HarmonizedSystemCode	String	False	No	The harmonized system code of the item.
InventoryHistoryUrl	String	True	No	The URL that points to the inventory history for the item.
CountryCodeOfOrigin	String	False	No	The ISO 3166-1 alpha-2 country code of where the item originated from.
ProvinceCodeOfOrigin	String	False	No	The ISO 3166-2 alpha-2 province code of where the item originated from.
CreatedAt	Datetime	True	No	The date and time when the inventory item was created.
UpdatedAt	Datetime	True	No	The date and time when the inventory item was updated.
TrackedEditableLocked	Bool	True	No	Whether the attribute is locked for editing.
TrackedEditableReason	String	True	No	The reason the attribute is locked for editing.
MeasurementId	String	True	No	A globally-unique ID.
MeasurementWeightValue	Double	False	No	The weight value using the unit system specified with 'unit'.
MeasurementWeightUnit	String	False	No	The unit of measurement for 'value'.
UnitCostAmount	Decimal	False	No	Decimal money amount.
UnitCostCurrencyCode	String	True	No	Currency of the money.
InventoryItemCountryHarmonizedSystemCodes	String	False	No	List of country-specific harmonized system codes.

Return to Top

Jobs

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID that's returned when running an asynchronous mutation.
Done	Bool	False		No	This indicates if the job is still queued or has been run.

Return to Top

Locations

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
LegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
Name	String	False	No	The name of the location.
Activatable	Bool	True	No	Whether this location can be reactivated.
Deactivatable	Bool	True	No	Whether this location can be deactivated.
Deletable	Bool	True	No	Whether this location can be deleted.
AddressVerified	Bool	True	No	Whether the location address has been verified.
DeactivatedAt	String	True	No	The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'.
IsActive	Bool	False	No	Whether the location is active.
ShipsInventory	Bool	True	No	Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
IsFulfillmentService	Bool	True	No	Whether this location is a fulfillment service.
FulfillsOnlineOrders	Bool	False	No	Whether this location can fulfill online orders.
HasActiveInventory	Bool	True	No	Whether this location has active inventory.
HasUnfulfilledOrders	Bool	True	No	Whether this location has orders that need to be fulfilled.
CreatedAt	Datetime	True	No	The date and time that the location was added to a shop.
UpdatedAt	Datetime	True	No	The date and time when the location was last updated.
AddressAddress1	String	False	No	The first line of the address for the location.
AddressAddress2	String	False	No	The second line of the address for the location.
AddressCity	String	False	No	The city of the location.
AddressCountry	String	True	No	The country of the location.
AddressFormatted	String	True	No	A formatted version of the address for the location.
AddressLatitude	Double	True	No	The latitude coordinates of the location.
AddressLongitude	Double	True	No	The longitude coordinates of the location.
AddressPhone	String	False	No	The phone number of the location.
AddressProvince	String	True	No	The province of the location.
AddressZip	String	False	No	The ZIP code of the location.
AddressCountryCode	String	False	No	The country code of the location.
AddressProvinceCode	String	False	No	The code for the province, state, or district of the address of the location.
FulfillmentServiceId	String	True	No	The ID of the fulfillment service.
LocalPickupSettingsV2Instructions	String	True	No	Additional instructions or information related to the local pickup.
LocalPickupSettingsV2PickupTime	String	True	No	The estimated pickup time to show customers at checkout.
IncludeInactive	Bool	True	No	If true, also include the locations that are deactivated.
IncludeLegacy	Bool	True	No	If true, also include the legacy locations of fulfillment services.

Return to Top

MarketingEvents

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
RemoteId	String	False	No	An optional ID that helps Shopify validate engagement data.
LegacyResourceId	String	False	No	The ID of the corresponding resource in the REST Admin API.
AppId	String	False	No	A globally-unique ID.
MarketingChannelType	String	False	No	The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
Description	String	False	No	A human-readable description of the marketing event.
Type	String	False	No	The marketing event type.
EndedAt	Datetime	False	No	The date and time when the marketing event ended.
ManageUrl	String	False	No	The URL where the marketing event can be managed.
PreviewUrl	String	False	No	The URL where the marketing event can be previewed.
StartedAt	Datetime	False	No	The date and time when the marketing event started.
UtmCampaign	String	False	No	The name of the marketing campaign.
UtmMedium	String	False	No	The medium that the marketing campaign is using. Example values: 'cpc', 'banner'.
UtmSource	String	False	No	The referrer of the marketing event. Example values: 'google', 'newsletter'.
SourceAndMedium	String	False	No	Where the 'MarketingEvent' occurred and what kind of content was used. Because 'utmSource' and 'utmMedium' are often used interchangeably, this is based on a combination of 'marketingChannel', 'referringDomain', and 'type' to provide a consistent representation for any given piece of marketing regardless of the app that created it.
ScheduledToEndAt	Datetime	False	No	The date and time when the marketing event is scheduled to end.

Return to Top

Metafields

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	The unique ID of the metafield.
LegacyResourceId	Long	True	No	The ID of the corresponding resource in the REST Admin API.
Namespace	String	True	No	A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.
Key	String	True	No	The name of the metafield.
Value	String	True	No	The information to be stored as metadata.
Type	String	True	No	The metafield's information type.
Description	String	True	No	A description of the information that the metafield contains.
OwnerId	String	True	No	The ID of the resource that the metafield is attached to.
OwnerResource	String	True	No	The type of resource that the metafield is attached to.
CreatedAt	Datetime	True	No	The date and time when the metafield was created.
UpdatedAt	Datetime	True	No	The date and time when the metafield was last updated.

Return to Top

MetaobjectDefinitions

Name	Type	ReadOnly	FilterOnly	Description
ID	String	False	No	A globally-unique ID.
Name	String	False	No	The human-readable name.
MetaobjectsCount	Int	False	No	The count of metaobjects created for the definition.
Type	String	False	No	The type of the object definition. Defines the namespace of associated metafields.
Description	String	False	No	The administrative description.
DisplayNameKey	String	False	No	The key of a field to reference as the display name for each object.
AccessAdmin	String	False	No	Access configuration for the metaobject definition. Access configuration for Admin API surface areas, including the GraphQL Admin API.
AccessStorefront	String	False	No	Access configuration for the metaobject definition. Access configuration for Storefront surface areas, including the GraphQL Storefront API and Liquid.
CapabilitiesPublishableEnabled	Bool	False	No	The capabilities of the metaobject definition. Indicate whether a metaobject definition is publishable. Indicates if the capability is enabled.
CapabilitiesTranslatableEnabled	Bool	False	No	The capabilities of the metaobject definition. Indicate whether a metaobject definition is translatable. Indicates if the capability is enabled.
CapabilitiesOnlineStoreEnabled	Bool	False	No	The capabilities of the metaobject definition. Indicates whether a metaobject definition can be displayed as a page on the Online Store. Indicates if the capability is enabled.
CapabilitiesOnlineStoreDataCanCreateRedirects	Bool	False	No	The capabilities of the metaobject definition. Indicates whether a metaobject definition can be displayed as a page on the Online Store. The data associated with the Online Store capability. Flag indicating if a sufficient number of redirects are available to redirect all published entries.
CapabilitiesOnlineStoreDataUrlHandle	String	False	No	The capabilities of the metaobject definition. Indicates whether a metaobject definition can be displayed as a page on the Online Store. The data associated with the Online Store capability. The URL handle for accessing pages of this metaobject type in the Online Store.
CapabilitiesRenderableEnabled	Bool	False	No	The capabilities of the metaobject definition. Indicate whether a metaobject definition is renderable and exposes SEO data. Indicates if the capability is enabled.
CapabilitiesRenderableDataMetaDescriptionKey	String	False	No	The capabilities of the metaobject definition. Indicate whether a metaobject definition is renderable and exposes SEO data. The data associated with the renderable capability. The metaobject field used as an alias for the SEO page description.
CapabilitiesRenderableDataMetaTitleKey	String	False	No	The capabilities of the metaobject definition. Indicate whether a metaobject definition is renderable and exposes SEO data. The data associated with the renderable capability. The metaobject field used as an alias for the SEO page title.

Return to Top

MetaObjects

Name	Type	ReadOnly	FilterOnly	Description
ID [KEY]	String	False	No	A globally-unique ID.
Handle	String	False	No	The unique handle of the object, useful as a custom ID.
DisplayName	String	False	No	The preferred display name field value of the metaobject.
CreatedByDeveloperName	String	False	No	The name of the app developer.
DefinitionId	String	False	No	The identifier of the MetaobjectDefinition that models this object type.
Title	String	False	No	Name of the app.
Type	String	False	No	The type of the metaobject.
Key [KEY]	String	False	No	The object key of this field.
Value	String	False	No	The assigned field value, always stored as a string regardless of the field type.
TypeField	String	False	No	The type of the field.
UpdatedAt	Datetime	False	No	When the object was last updated.
CapabilitiesPublishableStatus	String	False	No	Metaobject capabilities for this Metaobject. The publishable capability for this metaobject.
CapabilitiesOnlineStoreTemplateSuffix	String	False	No	Metaobject capabilities for this Metaobject. The Online Store capability for this metaobject. The theme template used when viewing the metaobject in a store.
ThumbnailFieldKey	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The object key of this field.
ThumbnailFieldThumbnailHex	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The hexadecimal color code to be used for respresenting this metaobject.
ThumbnailFieldFileId	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. A globally-unique ID.
ThumbnailFieldFileAlt	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. A word or phrase to describe the contents or the function of a file.
ThumbnailFieldFileCreatedAt	Datetime	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The date and time when the file was created.
ThumbnailFieldFileUpdatedAt	Datetime	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The date and time when the file was last updated.
ThumbnailFieldFileFileStatus	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The status of the file.
ThumbnailFieldFileFileErrors	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. Any errors that have occurred on the file.
ThumbnailFieldFilePreviewStatus	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The preview image for the media. Current status of the preview image.
ThumbnailFieldFilePreviewImageId	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The preview image for the media. A unique ID for the image.
ThumbnailFieldFilePreviewImageAltText	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The preview image for the media. A word or phrase to share the nature or contents of an image.
ThumbnailFieldFilePreviewImageHeight	Int	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The preview image for the media. The original height of the image in pixels. Returns null if the image isn't hosted by Shopify.
ThumbnailFieldFilePreviewImageWidth	Int	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The preview image for the media. The original width of the image in pixels. Returns null if the image isn't hosted by Shopify.
ThumbnailFieldFilePreviewImageUrl	String	False	No	The recommended field to visually represent this metaobject. May be a file reference or color field. The file to be used for visual representation of this metaobject. The preview image for the media. The location of the image as a URL.

Return to Top

OrderAdditionalFees

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
OrderId	String	False	Orders.Id	No	A globally-unique ID.
Name	String	False		No	The name of the additional fee.
PricePresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PricePresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

OrderAgreementAdditionalFeeSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
AdditionalFeeSaleAdditionalFeeId	String	False		No	A sale associated with an additional fee charge. The additional fees for the associated sale. A globally-unique ID.

Return to Top

OrderAgreementAdjustmentSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.

Return to Top

OrderAgreementDutySales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
DutySaleDutyId	String	False		No	A sale associated with a duty charge. The duty for the associated sale. A globally-unique ID.

Return to Top

OrderAgreementGiftCardSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
GiftCardSaleLineItemId	String	False		No	A sale associated with a gift card. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderAgreementProductSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
ProductSaleLineItemId	String	False		No	A sale associated with a product. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderAgreements

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
Id [KEY]	String	False		No	The unique ID for the agreement.
HappenedAt	Datetime	False		No	The date and time at which the agreement occurred.
Reason	String	False		No	The reason the agreement was created.
UserId	String	False		No	The staff member associated with the agreement. A globally-unique ID.(This column is available only with a ShopifyPlus subscription)
AppApiKey	String	False		No	The application that created the agreement. A unique application API identifier.

Return to Top

OrderAgreementShippingLineSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
ShippingLineSaleShippingLineId	String	False		No	A sale associated with a shipping charge. The shipping line item for the associated sale. shippingLine is not available if the SaleActionType is a return. A globally-unique ID.

Return to Top

OrderAgreementTipSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
TipSaleLineItemId	String	False		No	A sale associated with a tip. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderAgreementUnknownSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.

Return to Top

OrderCustomAttributes

Name	Type	ReadOnly	References	FilterOnly	Description
ResourceId [KEY]	String	False	Orders.Id	No	A globally-unique ID.
Key [KEY]	String	False		No	Key or name of the attribute.
Value	String	False		No	Value of the attribute.

Return to Top

OrderDiscountApplications

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId [KEY]	String	False	Orders.Id	No	A globally-unique ID.
AllocationMethod	String	False		No	The method by which the discount's value is applied to its entitled items.
Index [KEY]	Int	False		No	An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
TargetSelection	String	False		No	How the discount amount is distributed on the discounted lines.
TargetType	String	False		No	Whether the discount is applied on line items or shipping lines.
ValueAmount	Decimal	False		No	The value of the discount application. Decimal money amount.
ValueCurrencyCode	String	False		No	The value of the discount application. Currency of the money.
ValuePercentage	Double	False		No	The value of the discount application. The percentage value of the object. This is a number between -100 (free) and 0 (no discount).
AutomaticDiscountApplicationTitle	String	False		No	The title of the discount application.
DiscountCodeApplicationCode	String	False		No	The string identifying the discount code that was used at the time of application.
ManualDiscountApplicationTitle	String	False		No	The title of the discount application.
ManualDiscountApplicationDescription	String	False		No	The description of the discount application.
ScriptDiscountApplicationTitle	String	False		No	The title of the discount application.

Return to Top

OrderEditAgreementAdditionalFeeSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
AdditionalFeeSaleAdditionalFeeId	String	False		No	A sale associated with an additional fee charge. The additional fees for the associated sale. A globally-unique ID.

Return to Top

OrderEditAgreementAdjustmentSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.

Return to Top

OrderEditAgreementDutySales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
DutySaleDutyId	String	False		No	A sale associated with a duty charge. The duty for the associated sale. A globally-unique ID.

Return to Top

OrderEditAgreementGiftCardSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
GiftCardSaleLineItemId	String	False		No	A sale associated with a gift card. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderEditAgreementProductSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
ProductSaleLineItemId	String	False		No	A sale associated with a product. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderEditAgreements

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
Id [KEY]	String	False		No	The unique ID for the agreement.
HappenedAt	Datetime	False		No	The date and time at which the agreement occurred.
Reason	String	False		No	The reason the agreement was created.
UserId	String	False		No	The staff member associated with the agreement. A globally-unique ID.(This column is available only with a ShopifyPlus subscription)
AppApiKey	String	False		No	The application that created the agreement. A unique application API identifier.

Return to Top

OrderEditAgreementShippingLineSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
ShippingLineSaleShippingLineId	String	False		No	A sale associated with a shipping charge. The shipping line item for the associated sale. shippingLine is not available if the SaleActionType is a return. A globally-unique ID.

Return to Top

OrderEditAgreementTipSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
TipSaleLineItemId	String	False		No	A sale associated with a tip. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderEditAgreementUnknownSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.

Return to Top

OrderEvents

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
HostId	String	False	Orders.Id	No	A globally-unique ID.
AppTitle	String	False		No	The name of the app that created the event.
AttributeToApp	Bool	False		No	Whether the event was created by an app.
AttributeToUser	Bool	False		No	Whether the event was caused by an admin user.
CreatedAt	Datetime	False		No	The date and time when the event was created.
CriticalAlert	Bool	False		No	Whether the event is critical.
Message	String	False		No	Human readable text that describes the event.
CommentEventAuthorId	String	False		No	The id of the staff member that authored the comment event.
CommentEventCanDelete	Bool	False		No	Whether the comment event can be deleted. If true, then the comment event can be deleted.
CommentEventCanEdit	Bool	False		No	Whether the comment event can edited. If true, then the comment event can be edited.
CommentEventEdited	Bool	False		No	Whether the comment event has been edited. If true, then the comment event has been edited.
CommentEventRawMessage	String	False		No	The raw body of the comment event.
CommentEventSubjectId	String	False		No	The parent subject to which the comment event belongs.
CommentEventEmbedCustomerId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedDraftOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedOrderId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductId	String	False		No	The object reference associated with the comment event.
CommentEventEmbedProductVariantId	String	False		No	The object reference associated with the comment event.

Return to Top

OrderLineItemCustomAttributes

Name	Type	ReadOnly	References	FilterOnly	Description
ResourceId [KEY]	String	False	OrderLineItems.Id	No	A globally-unique ID.
Key [KEY]	String	False		No	Key or name of the attribute.
Value	String	False		No	Value of the attribute.

Return to Top

OrderLineItemDiscountAllocations

Name	Type	ReadOnly	FilterOnly	Description
OrderLineItemId [KEY]	String	False	No	The ID of the Order to return.
DiscountApplicationIndex [KEY]	Decimal	False	No	An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
AllocatedAmountSetPresentmentMoneyAmount	Decimal	False	No	Decimal money amount.
AllocatedAmountSetPresentmentMoneyCurrencyCode	String	False	No	Currency of the money.
AllocatedAmountSetShopMoneyAmount	Decimal	False	No	Decimal money amount.
AllocatedAmountSetShopMoneyCurrencyCode	String	False	No	Currency of the money.

Return to Top

OrderLineItemDuties

Name	Type	ReadOnly	References	FilterOnly	Description
LineItemId	String	False	OrderLineItems.Id	No	A globally-unique ID.
Id [KEY]	String	False		No	A globally-unique ID.
CountryCodeOfOrigin	String	False		No	The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.
HarmonizedSystemCode	String	False		No	The harmonized system code of the item used in calculating the duty.
PricePresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PricePresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

OrderLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ResourceId	String	False	Orders.Id	No	A globally-unique ID.
Name	String	False		No	The title of the product, optionally appended with the title of the variant (if applicable).
Title	String	False		No	The title of the product at time of order creation.
VariantTitle	String	False		No	The title of the variant at time of order creation.
VariantId	String	False		No	A globally-unique ID.
ProductId	String	False		No	A globally-unique ID.
SellingPlanSellingPlanId	String	False		No	The ID of the selling plan associated with the line item.
Quantity	Int	False		No	The number of variant units ordered.
Restockable	Bool	False		No	Whether the line item can be restocked.
Sku	String	False		No	The variant SKU number.
Taxable	Bool	False		No	Whether the variant is taxable.
Vendor	String	False		No	The name of the vendor who made the variant.
CurrentQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
MerchantEditable	Bool	False		No	Whether the line item can be edited or not.
RefundableQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
RequiresShipping	Bool	False		No	Whether physical shipping is required for the variant.
UnfulfilledQuantity	Int	False		No	The number of units not yet fulfilled.
NonFulfillableQuantity	Int	False		No	The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details.
IsGiftCard	Bool	False		No	Whether the line item represents the purchase of a gift card.
DiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
ImageId	String	False		No	A unique ID for the image.
ImageWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False		No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False		No	The location of the image as a URL.
OriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
TotalDiscountSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
TotalDiscountSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledDiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledDiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledOriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledOriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledOriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was modified last.

Return to Top

OrderNonFulfillableLineItemDuties

Name	Type	ReadOnly	References	FilterOnly	Description
LineItemId	String	False	OrderNonFulfillableLineItems.Id	No	A globally-unique ID.
Id [KEY]	String	False		No	A globally-unique ID.
CountryCodeOfOrigin	String	False		No	The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.
HarmonizedSystemCode	String	False		No	The harmonized system code of the item used in calculating the duty.
PricePresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PricePresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

OrderNonFulfillableLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ResourceId	String	False	Orders.Id	No	A globally-unique ID.
Name	String	False		No	The title of the product, optionally appended with the title of the variant (if applicable).
Title	String	False		No	The title of the product at time of order creation.
VariantTitle	String	False		No	The title of the variant at time of order creation.
VariantId	String	False		No	A globally-unique ID.
ProductId	String	False		No	A globally-unique ID.
SellingPlanSellingPlanId	String	False		No	The ID of the selling plan associated with the line item.
Quantity	Int	False		No	The number of variant units ordered.
Restockable	Bool	False		No	Whether the line item can be restocked.
Sku	String	False		No	The variant SKU number.
Taxable	Bool	False		No	Whether the variant is taxable.
Vendor	String	False		No	The name of the vendor who made the variant.
CurrentQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
MerchantEditable	Bool	False		No	Whether the line item can be edited or not.
RefundableQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
RequiresShipping	Bool	False		No	Whether physical shipping is required for the variant.
UnfulfilledQuantity	Int	False		No	The number of units not yet fulfilled.
NonFulfillableQuantity	Int	False		No	The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details.
IsGiftCard	Bool	False		No	Whether the line item represents the purchase of a gift card.
DiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
ImageId	String	False		No	A unique ID for the image.
ImageWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False		No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False		No	The location of the image as a URL.
OriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
TotalDiscountSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
TotalDiscountSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledDiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledDiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledOriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledOriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledOriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

OrderRefundAgreementAdditionalFeeSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
AdditionalFeeSaleAdditionalFeeId	String	False		No	A sale associated with an additional fee charge. The additional fees for the associated sale. A globally-unique ID.

Return to Top

OrderRefundAgreementAdjustmentSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.

Return to Top

OrderRefundAgreementDutySales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
DutySaleDutyId	String	False		No	A sale associated with a duty charge. The duty for the associated sale. A globally-unique ID.

Return to Top

OrderRefundAgreementGiftCardSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
GiftCardSaleLineItemId	String	False		No	A sale associated with a gift card. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderRefundAgreementProductSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
ProductSaleLineItemId	String	False		No	A sale associated with a product. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderRefundAgreements

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
Id [KEY]	String	False		No	The unique ID for the agreement.
HappenedAt	Datetime	False		No	The date and time at which the agreement occurred.
Reason	String	False		No	The reason the agreement was created.
UserId	String	False		No	The staff member associated with the agreement. A globally-unique ID.(This column is available only with a ShopifyPlus subscription)
AppApiKey	String	False		No	The application that created the agreement. A unique application API identifier.
RefundId	String	False	Refunds.Id	No	The refund associated with the agreement.

Return to Top

OrderRefundAgreementShippingLineSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
ShippingLineSaleShippingLineId	String	False		No	A sale associated with a shipping charge. The shipping line item for the associated sale. shippingLine is not available if the SaleActionType is a return. A globally-unique ID.

Return to Top

OrderRefundAgreementTipSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.
TipSaleLineItemId	String	False		No	A sale associated with a tip. The line item for the associated sale. A globally-unique ID.

Return to Top

OrderRefundAgreementUnknownSales

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	String	False	Orders.Id	No	The parent resource of the agreement.
AgreementId	String	False		No	The unique ID for the agreement.
Id [KEY]	String	False		No	The unique ID for the sale.
ActionType	String	False		No	The type of order action that the sale represents.
LineType	String	False		No	The line type associated with the sale.
Quantity	Int	False		No	The number of units either ordered or intended to be returned.
TotalAmountPresentmentMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Decimal money amount.
TotalAmountPresentmentCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in presentment currency. Currency of the money.
TotalAmountShopMoneyAmount	Decimal	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Decimal money amount.
TotalAmountShopMoneyCurrencyCode	String	False		No	The total sale amount after taxes and discounts. Amount in shop currency. Currency of the money.
TotalTaxAmountPresentmentMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in presentment currency. Decimal money amount.
TotalTaxAmountPresentmentCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in presentment currency. Currency of the money.
TotalTaxAmountShopMoneyAmount	Decimal	False		No	The total amount of taxes for the sale. Amount in shop currency. Decimal money amount.
TotalTaxAmountShopMoneyCurrencyCode	String	False		No	The total amount of taxes for the sale. Amount in shop currency. Currency of the money.
TotalDiscountAmountBeforeTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountBeforeTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountBeforeTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale before taxes. Amount in shop currency. Currency of the money.
TotalDiscountAmountAfterTaxesPresentmentMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Decimal money amount.
TotalDiscountAmountAfterTaxesPresentmentCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in presentment currency. Currency of the money.
TotalDiscountAmountAfterTaxesShopMoneyAmount	Decimal	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Decimal money amount.
TotalDiscountAmountAfterTaxesShopMoneyCurrencyCode	String	False		No	The total discounts allocated to the sale after taxes. Amount in shop currency. Currency of the money.
Taxes	String	False		No	The individual taxes associated with the sale.

Return to Top

OrderRiskAssessments

Name	Type	ReadOnly	FilterOnly	Description
OrderId	String	True	No	A globally-unique ID.
RiskLevel	String	True	No	The likelihood that the order is fraudulent, based on this risk assessment.
Facts	String	True	No	Optional facts used to describe the risk assessment. The values in here are specific to the provider.
ProviderId	String	True	No	A globally-unique ID.
ProviderTitle	String	True	No	Name of the app.

Return to Top

Orders

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Unpaid	Bool	True	No	Whether no payments have been made for the order.
FullyPaid	Bool	True	No	Whether the order has been paid in full.
SourceIdentifier	String	True	No	A unique POS or third party order identifier. For example, '1234-12-1000' or '111-98567-54'. The 'receipt_number' field is derived from this value for POS orders.
LegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
CanMarkAsPaid	Bool	True	No	Whether the order can be manually marked as paid.
Name	String	True	No	The unique identifier for the order that appears on the order page in the Shopify admin and the order status page. For example, '#1001', 'EN1001', or '1001-A'. This value isn't unique across multiple stores.
PaymentGatewayNames	String	True	No	A list of the names of all payment gateways used for the order. For example, 'Shopify Payments' and 'Cash on Delivery (COD)'.
Capturable	Bool	True	No	Whether payment for the order can be captured.
Closed	Bool	True	No	Whether the order is closed.
Confirmed	Bool	True	No	Whether inventory has been reserved for the order.
Edited	Bool	True	No	Whether the order has had any edits applied.
Email	String	False	No	The email address associated with the customer.
Fulfillable	Bool	True	No	Whether there are line items that can be fulfilled. This field returns 'false' when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the object.
Note	String	False	No	The contents of the note associated with the order.
Phone	String	True	No	The phone number associated with the customer.
Refundable	Bool	True	No	Whether the order can be refunded.
Restockable	Bool	True	No	Whether any line item on the order can be restocked.
Tags	String	True	No	A comma separated list of tags associated with the order. Updating 'tags' overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the mutation.
Test	Bool	True	No	Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order cannot be converted into a real order and vice versa.
CancelReason	String	True	No	The reason provided when the order was canceled. Returns 'null' if the order wasn't canceled.
CancelledAt	Datetime	True	No	The date and time when the order was canceled. Returns 'null' if the order wasn't canceled.
ClientIp	String	True	No	The IP address of the API client that created the order.
ClosedAt	Datetime	True	No	The date and time when the order was closed. Returns 'null' if the order is not closed.
ConfirmationNumber	String	True	No	A randomly generated alpha-numeric identifier for the order that may be shown to the customer instead of the sequential order name. For example, XPAV284CT, R50KELTJP or 35PKUN0UJ. This value isn't guaranteed to be unique.
CurrencyCode	String	True	No	The shop currency when the order was placed.
CustomerLocale	String	True	No	A two-letter or three-letter language code, optionally followed by a region modifier.
DiscountCode	String	True	No	The discount code used for the order.
DiscountCodes	String	True	No	The discount codes used for the order.
EstimatedTaxes	Bool	True	No	Whether taxes on the order are estimated. This field returns 'false' when taxes on the order are finalized and aren't subject to any changes.
MerchantEditable	Bool	True	No	Whether the order can be edited by the merchant. For example, canceled orders can't be edited.
ProcessedAt	Datetime	True	No	The date and time when the order was processed. This date and time might not match the date and time when the order was created.
RequiresShipping	Bool	True	No	Whether the order has shipping lines or at least one line item on the order that requires shipping.
RiskRecommendation	String	True	No	The recommendation for the order based on the results of the risk assessments. This suggests the action the merchant should take with regards to its risk of fraud.
ReturnStatus	String	True	No	The order's aggregated return status for display purposes.
TaxesIncluded	Bool	True	No	Whether taxes are included in the subtotal price of the order.
TotalWeight	String	True	No	The total weight of the order before returns, in grams.
CanNotifyCustomer	Bool	True	No	Whether a customer email exists for the order.
CurrentTotalWeight	String	True	No	The total weight of the order after returns, in grams.
CustomerAcceptsMarketing	Bool	True	No	Whether the customer agreed to receive marketing materials.
DisplayFinancialStatus	String	True	No	The financial status of the order that can be shown to the merchant. This field does not capture all the details of an order's financial state. It should only be used for display summary purposes.
DisplayFulfillmentStatus	String	True	No	The fulfillment status for the order that can be shown to the merchant. This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. For a more granular view of the fulfillment status, refer to the object.
HasTimelineComment	Bool	True	No	Whether the merchant added a timeline comment to the order.
MerchantEditableErrors	String	True	No	A list of reasons why the order can't be edited. For example, 'Canceled orders can't be edited'.
PresentmentCurrencyCode	String	True	No	The payment 'CurrencyCode' of the customer for the order.
RegisteredSourceUrl	String	True	No	The URL of the source that the order originated from, if found in the domain registry.
SubtotalLineItemsQuantity	Int	True	No	The sum of the quantities for all line items that contribute to the order's subtotal price.
BillingAddressMatchesShippingAddress	Bool	True	No	Whether the billing address matches the shipping address.
CurrentSubtotalLineItemsQuantity	Int	True	No	The sum of the quantities for all line items that contribute to the order's current subtotal price.
CreatedAt	Datetime	True	No	Date and time when the order was created in Shopify.
UpdatedAt	Datetime	True	No	The date and time when the order was modified last.
AppId	String	True	No	The application ID.
MerchantOfRecordAppId	String	True	No	The application ID.
PhysicalLocationId	String	True	No	A globally-unique ID.
ChannelInformationId	String	True	No	A globally-unique ID.
ChannelInformationChannelId	String	True	No	The unique ID for the channel.
ChannelInformationAppId	String	True	No	A globally-unique ID.
PublicationId	String	True	No	A globally-unique ID.
PurchasingEntityCustomerId	String	True	No	A globally-unique ID.
PurchasingEntityCompanyId	String	True	No	A globally-unique ID.
CustomerId	String	True	No	A globally-unique ID.
CustomerFirstName	String	True	No	The customer's first name.
CustomerLastName	String	True	No	The customer's last name.
CustomerJourneySummaryReady	Bool	True	No	Whether the attributed sessions for the order have been created yet.
CustomerJourneySummaryMomentsCount	Int	True	No	The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed.
CustomerJourneySummaryMomentsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
CustomerJourneySummaryCustomerOrderIndex	Int	True	No	The position of the current order within the customer's order history. Test orders aren't included.
CustomerJourneySummaryDaysToConversion	Int	True	No	The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order.
CustomerJourneySummaryFirstVisitId	String	True	No	A globally-unique ID.
CustomerJourneySummaryFirstVisitSource	String	True	No	Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.
CustomerJourneySummaryFirstVisitLandingPage	String	True	No	URL of the first page the customer landed on for the session.
CustomerJourneySummaryFirstVisitOccurredAt	Datetime	True	No	The date and time when the customer's session occurred.
CustomerJourneySummaryFirstVisitReferralCode	String	True	No	Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.
CustomerJourneySummaryFirstVisitReferrerUrl	String	True	No	Webpage where the customer clicked a link that sent them to the online store. For example, https: //randomblog. com/page1 or android-app: //com. google. android. gm.
CustomerJourneySummaryFirstVisitSourceDescription	String	True	No	Describes the source explicitly for first or last session.
CustomerJourneySummaryFirstVisitSourceType	String	True	No	Type of marketing tactic.
CustomerJourneySummaryFirstVisitLandingPageHtml	String	True	No	Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1.
CustomerJourneySummaryFirstVisitReferralInfoHtml	String	True	No	Referral information with URLs linked in HTML.
CustomerJourneySummaryLastVisitId	String	True	No	A globally-unique ID.
CustomerJourneySummaryLastVisitSource	String	True	No	Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.
CustomerJourneySummaryLastVisitLandingPage	String	True	No	URL of the first page the customer landed on for the session.
CustomerJourneySummaryLastVisitOccurredAt	Datetime	True	No	The date and time when the customer's session occurred.
CustomerJourneySummaryLastVisitReferralCode	String	True	No	Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore. com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.
CustomerJourneySummaryLastVisitReferrerUrl	String	True	No	Webpage where the customer clicked a link that sent them to the online store. For example, https: //randomblog. com/page1 or android-app: //com. google. android. gm.
CustomerJourneySummaryLastVisitSourceDescription	String	True	No	Describes the source explicitly for first or last session.
CustomerJourneySummaryLastVisitSourceType	String	True	No	Type of marketing tactic.
CustomerJourneySummaryLastVisitLandingPageHtml	String	True	No	Landing page information with URL linked in HTML. For example, the first page the customer visited was store. myshopify. com/products/1.
CustomerJourneySummaryLastVisitReferralInfoHtml	String	True	No	Referral information with URLs linked in HTML.
DisplayAddressId	String	True	No	A globally-unique ID.
DisplayAddressCoordinatesValidated	Bool	True	No	Whether the address coordinates are valid.
DisplayAddressName	String	True	No	The full name of the customer, based on firstName and lastName.
DisplayAddressFirstName	String	True	No	The first name of the customer.
DisplayAddressLastName	String	True	No	The last name of the customer.
DisplayAddressAddress1	String	True	No	The first line of the address. Typically the street address or PO Box number.
DisplayAddressAddress2	String	True	No	The second line of the address. Typically the number of the apartment, suite, or unit.
DisplayAddressCity	String	True	No	The name of the city, district, village, or town.
DisplayAddressCompany	String	True	No	The name of the customer's company or organization.
DisplayAddressCountry	String	True	No	The name of the country.
DisplayAddressLatitude	Double	True	No	The latitude coordinate of the customer address.
DisplayAddressLongitude	Double	True	No	The longitude coordinate of the customer address.
DisplayAddressPhone	String	True	No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
DisplayAddressProvince	String	True	No	The region of the address, such as the province, state, or district.
DisplayAddressZip	String	True	No	The zip or postal code of the address.
DisplayAddressFormattedArea	String	True	No	A comma-separated list of the values for city, province, and country.
DisplayAddressProvinceCode	String	True	No	The two-letter code for the region. For example, ON.
DisplayAddressCountryCodeV2	String	True	No	The two-letter code for the country of the address. For example, US.
BillingAddressId	String	True	No	A globally-unique ID.
BillingAddressCoordinatesValidated	Bool	True	No	Whether the address coordinates are valid.
BillingAddressName	String	True	No	The full name of the customer, based on firstName and lastName.
BillingAddressFirstName	String	True	No	The first name of the customer.
BillingAddressLastName	String	True	No	The last name of the customer.
BillingAddressAddress1	String	True	No	The first line of the address. Typically the street address or PO Box number.
BillingAddressAddress2	String	True	No	The second line of the address. Typically the number of the apartment, suite, or unit.
BillingAddressCity	String	True	No	The name of the city, district, village, or town.
BillingAddressCompany	String	True	No	The name of the customer's company or organization.
BillingAddressCountry	String	True	No	The name of the country.
BillingAddressLatitude	Double	True	No	The latitude coordinate of the customer address.
BillingAddressLongitude	Double	True	No	The longitude coordinate of the customer address.
BillingAddressPhone	String	True	No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
BillingAddressProvince	String	True	No	The region of the address, such as the province, state, or district.
BillingAddressZip	String	True	No	The zip or postal code of the address.
BillingAddressFormattedArea	String	True	No	A comma-separated list of the values for city, province, and country.
BillingAddressProvinceCode	String	True	No	The two-letter code for the region. For example, ON.
BillingAddressCountryCodeV2	String	True	No	The two-letter code for the country of the address. For example, US.
ShippingAddressId	String	False	No	A globally-unique ID.
ShippingAddressCoordinatesValidated	Bool	True	No	Whether the address coordinates are valid.
ShippingAddressName	String	True	No	The full name of the customer, based on firstName and lastName.
ShippingAddressFirstName	String	False	No	The first name of the customer.
ShippingAddressLastName	String	False	No	The last name of the customer.
ShippingAddressAddress1	String	False	No	The first line of the address. Typically the street address or PO Box number.
ShippingAddressAddress2	String	False	No	The second line of the address. Typically the number of the apartment, suite, or unit.
ShippingAddressCity	String	False	No	The name of the city, district, village, or town.
ShippingAddressCompany	String	False	No	The name of the customer's company or organization.
ShippingAddressCountry	String	False	No	The name of the country.
ShippingAddressLatitude	Double	True	No	The latitude coordinate of the customer address.
ShippingAddressLongitude	Double	True	No	The longitude coordinate of the customer address.
ShippingAddressPhone	String	False	No	A unique phone number for the customer. Formatted using E. 164 standard. For example, +16135551111.
ShippingAddressProvince	String	False	No	The region of the address, such as the province, state, or district.
ShippingAddressZip	String	False	No	The zip or postal code of the address.
ShippingAddressFormattedArea	String	True	No	A comma-separated list of the values for city, province, and country.
ShippingAddressProvinceCode	String	False	No	The two-letter code for the region. For example, ON.
ShippingAddressCountryCodeV2	String	False	No	The two-letter code for the country of the address. For example, US.
ShippingLineId	String	True	No	A globally-unique ID.
ShippingLineCarrierIdentifier	String	True	No	A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
ShippingLineTitle	String	True	No	Returns the title of the shipping line.
ShippingLineCode	String	True	No	A reference to the shipping method.
ShippingLineCustom	Bool	True	No	Whether the shipping line is custom or not.
ShippingLinePhone	String	True	No	The phone number at the shipping address.
ShippingLineSource	String	True	No	Returns the rate source for the shipping line.
ShippingLineDeliveryCategory	String	True	No	The general classification of the delivery method.
ShippingLineShippingRateHandle	String	True	No	A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.
ShippingLineRequestedFulfillmentServiceId	String	True	No	The ID of the fulfillment service.
PaymentTermsId	String	True	No	A globally-unique ID.
PaymentTermsTranslatedName	String	True	No	The payment terms name, translated into the shop admin's preferred language.
PaymentTermsPaymentTermsName	String	True	No	The name of the payment terms template used to create the payment terms.
PaymentTermsOverdue	Bool	True	No	Whether the payment terms have overdue payment schedules.
PaymentTermsDueInDays	Int	True	No	Duration of payment terms in days based on the payment terms template used to create the payment terms.
PaymentTermsPaymentTermsType	String	True	No	The payment terms template type used to create the payment terms.
PaymentTermsDraftOrderId	String	True	No	A globally-unique ID.
CartDiscountAmountSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CartDiscountAmountSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CartDiscountAmountSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CartDiscountAmountSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
ChannelInformationChannelDefinitionId	String	True	No	The unique ID for the channel definition.
CurrentCartDiscountAmountSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentCartDiscountAmountSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentCartDiscountAmountSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentCartDiscountAmountSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentSubtotalPriceSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentSubtotalPriceSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentSubtotalPriceSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentSubtotalPriceSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalAdditionalFeesSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalAdditionalFeesSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalAdditionalFeesSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalAdditionalFeesSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalDiscountsSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalDiscountsSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalDiscountsSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalDiscountsSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalDutiesSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalDutiesSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalDutiesSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalDutiesSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalPriceSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalPriceSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalPriceSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalPriceSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalTaxSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalTaxSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
CurrentTotalTaxSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
CurrentTotalTaxSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
NetPaymentSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
NetPaymentSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
NetPaymentSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
NetPaymentSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
OriginalTotalAdditionalFeesSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
OriginalTotalAdditionalFeesSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
OriginalTotalAdditionalFeesSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
OriginalTotalAdditionalFeesSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
OriginalTotalDutiesSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
OriginalTotalDutiesSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
OriginalTotalDutiesSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
OriginalTotalDutiesSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
OriginalTotalPriceSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
OriginalTotalPriceSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
OriginalTotalPriceSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
OriginalTotalPriceSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
PaymentCollectionDetailsAdditionalPaymentCollectionUrl	String	True	No	The URL to use for collecting an additional payment on the order.
RefundDiscrepancySetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
RefundDiscrepancySetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
RefundDiscrepancySetShopMoneyAmount	Decimal	True	No	Decimal money amount.
RefundDiscrepancySetShopMoneyCurrencyCode	String	True	No	Currency of the money.
SubtotalPriceSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
SubtotalPriceSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
SubtotalPriceSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
SubtotalPriceSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalCapturableSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalCapturableSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalCapturableSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalCapturableSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalDiscountsSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalDiscountsSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalDiscountsSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalDiscountsSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalOutstandingSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalOutstandingSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalOutstandingSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalOutstandingSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalPriceSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalPriceSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalPriceSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalPriceSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalReceivedSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalReceivedSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalReceivedSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalReceivedSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalRefundedSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalRefundedSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalRefundedSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalRefundedSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalRefundedShippingSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalRefundedShippingSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalRefundedShippingSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalRefundedShippingSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalShippingPriceSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalShippingPriceSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalShippingPriceSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalShippingPriceSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalTaxSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalTaxSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalTaxSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalTaxSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
TotalTipReceivedSetPresentmentMoneyAmount	Decimal	True	No	Decimal money amount.
TotalTipReceivedSetPresentmentMoneyCurrencyCode	String	True	No	Currency of the money.
TotalTipReceivedSetShopMoneyAmount	Decimal	True	No	Decimal money amount.
TotalTipReceivedSetShopMoneyCurrencyCode	String	True	No	Currency of the money.
RetailLocationId	String	True	No	A globally-unique ID.

Return to Top

OrderTaxLines

Name	Type	ReadOnly	References	FilterOnly	Description
Title [KEY]	String	False		No	The name of the tax.
ResourceId [KEY]	String	False	Orders.Id	No	A globally-unique ID.
Rate	Double	False		No	The proportion of the line item price that the tax represents as a decimal.
ChannelLiable	Bool	False		No	Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentage	Double	False		No	The proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

OrderTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique ID.
ResourceId [KEY]	String	True	Orders.Id	No	A globally-unique ID.
PaymentId	String	True		No	The payment ID associated with the transaction.
ParentTransactionId	String	True		No	The associated parent transaction, for example the authorization of a capture.
AccountNumber	String	True		No	The masked account number associated with the payment method.
Gateway	String	True		No	The payment gateway used to process the transaction.
Kind	String	True		No	The kind of transaction.
Status	String	True		No	The status of this transaction.
Test	Bool	True		No	Whether the transaction is a test transaction.
AuthorizationCode	String	True		No	Authorization code associated with the transaction.
ErrorCode	String	True		No	A standardized error code, independent of the payment provider.
FormattedGateway	String	True		No	The human-readable payment gateway name used to process the transaction.
ManuallyCapturable	Bool	True		No	Whether the transaction can be manually captured.
MultiCapturable	Bool	True		No	Whether the transaction can be captured multiple times.
ProcessedAt	Datetime	True		No	Date and time when the transaction was processed.
ReceiptJson	String	True		No	The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction.
SettlementCurrency	String	True		No	The settlement currency.
AuthorizationExpiresAt	Datetime	True		No	The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations.
SettlementCurrencyRate	Decimal	True		No	The rate used when converting the transaction amount to settlement currency.
CreatedAt	Datetime	True		No	Date and time when the transaction was created.
CardPaymentDetailsName	String	True		No	The holder of the credit card.
CardPaymentDetailsBin	String	True		No	The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
CardPaymentDetailsCompany	String	True		No	The name of the company that issued the customer's credit card.
CardPaymentDetailsNumber	String	True		No	The customer's credit card number, with most of the leading digits redacted.
CardPaymentDetailsWallet	String	True		No	Digital wallet used for the payment.
CardPaymentDetailsExpirationMonth	Int	True		No	The month in which the used credit card expires.
CardPaymentDetailsExpirationYear	Int	True		No	The year in which the used credit card expires.
CardPaymentDetailsAvsResultCode	String	True		No	The response code from the address verification system (AVS). The code is always a single letter.
CardPaymentDetailsCvvResultCode	String	True		No	The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string.
PaymentIconId	String	True		No	A unique ID for the image.
PaymentIconWidth	Int	True		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
PaymentIconAltText	String	True		No	A word or phrase to share the nature or contents of an image.
PaymentIconHeight	Int	True		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
AmountSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
AmountSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
AmountSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
AmountSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
MaximumRefundableV2Amount	Decimal	True		No	Decimal money amount.
MaximumRefundableV2CurrencyCode	String	True		No	Currency of the money.
ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt	Datetime	True		No	The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment.
ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt	Datetime	True		No	The time after which capture will incur an additional fee.
ShopifyPaymentsSetRefundSetAcquirerReferenceNumber	String	True		No	The acquirer reference number (ARN) code generated for Visa/Mastercard transactions.
TotalUnsettledSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
TotalUnsettledSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
TotalUnsettledSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
TotalUnsettledSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
Amount	Decimal	False		Yes	The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.
Currency	String	False		Yes	The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.

Return to Top

Pages

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
Title	String	False	No	The title of the page.
Body	String	False	No	The description of the page, complete with HTML formatting.
Handle	String	False	No	A human-friendly unique string for the page automatically generated from its title.
BodySummary	String	False	No	Summary of the page body.
OnlineStoreUrl	String	False	No	The URL used for viewing the resource on the shop's Online Store. Returns 'null' if the resource is currently not published to the Online Store sales channel.
CreatedAt	Datetime	False	No	The timestamp of the page creation.
UpdatedAt	Datetime	False	No	The timestamp of the latest page update.
SeoTitle	String	False	No	The SEO title.
SeoDescription	String	False	No	The meta description.

Return to Top

PriceListPrices

Name	Type	ReadOnly	References	FilterOnly	Description
PriceListId [KEY]	String	False	PriceLists.Id	No	The unique identifier of the price list.
ProductVariantId [KEY]	String	False	ProductVariants.Id	No	The unique identifier of the product variant associated with this price.
OriginType	String	False		No	The origin of a price, either fixed (defined on the price list) or relative (calculated using a price list adjustment configuration).
PriceAmount	Decimal	False		No	The price of the product variant on this price list. Decimal money amount.
PriceCurrencyCode	String	False		No	The price of the product variant on this price list. Currency of the money.
CompareAtPriceAmount	Decimal	False		No	The compare-at price of the product variant on this price list. Decimal money amount.
CompareAtPriceCurrencyCode	String	False		No	The compare-at price of the product variant on this price list. Currency of the money.

Return to Top

PriceLists

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Currency	String	False	No	The currency for fixed prices associated with this price list.
FixedPricesCount	Int	True	No	The number of fixed prices on the price list.
Name	String	False	No	The unique name of the price list, used as a human-readable identifier.
ParentAdjustmentType	String	False	No	The type of price adjustment, such as percentage increase or decrease.
ParentAdjustmentValue	Double	False	No	The value of price adjustment, where positive numbers reduce the prices and negative numbers increase them.
ParentSettingsCompareAtMode	String	False	No	The type of price list adjustment setting for compare at price.

Return to Top

ProductMediaImages

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A unique identifier for the media image.
ProductId [KEY]	String	True	Products.Id	No	A globally-unique identifier for the product.
AltText	String	False		No	A word or phrase to share the nature or contents of a media image.
MediaContentType	String	True		No	The media content type.
Height	Int	True		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
Width	Int	True		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
Url	String	False		No	The location of the image as a URL.

Return to Top

ProductOptions

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique identifier.
ProductId	String	False	Products.Id	No	A globally-unique identifier.
Name	String	False		No	The product option's name.
Position	Int	False		No	The product option's position.
Values	String	True		No	The corresponding value to the product option name.
OptionValues	String	True		No	Similar to values, option_values returns all the corresponding option value objects to the product option, including values not assigned to any variants.
LinkedMetafieldKey	String	False		Yes	The key of the metafield this option is linked to.
LinkedMetafieldNamespace	String	False		Yes	The namespace of the metafield this option is linked to.
LinkedMetafieldValues	String	False		Yes	Comma-separated list of values associated with the option.
DeleteVariantStrategy	String	False		Yes	The strategy defines which behavior is observed, such as how to handle a situation where deleting an option would result in duplicate variants. If set to 'DEFAULT', the specified Option may only have one corresponding value. If set to 'NON_DESTRUCTIVE', an Option with multiple values can be deleted, but the operation only succeeds if no product variants get deleted. If set to 'POSITION', an Option with multiple values can be deleted. Remaining variants will be deleted, highest position first, in the event of duplicates being detected.

Return to Top

ProductOptionValues

Name	Type	ReadOnly	FilterOnly	Description
ProductId	String	False	No	A globally-unique ID.
ProductOptionId	String	False	No	A globally-unique ID.
ProductOptionName	String	True	No	The product option's name.
Id [KEY]	String	True	No	A globally-unique ID.
Name	String	False	No	Value associated with an option.
LinkedMetafieldValue	String	False	No	Metafield value associated with an option.
HasVariants	Bool	True	No	Whether the product option value has any linked variants.
SwatchColor	String	True	No	The swatch associated with the product option value. The color representation of the swatch.
SwatchImageId	String	True	No	The swatch associated with the product option value. An image representation of the swatch. A globally-unique ID.
VariantStrategy	String	False	Yes	The strategy defines which behavior is observed regarding variants. The strategy 'LEAVE_AS_IS' is used by default - variants are not created nor deleted. If set to 'MANAGE', variants are created and deleted according to the option values to add and to delete.

Return to Top

ProductResourceFeedbacks

Name	Type	ReadOnly	References	FilterOnly	Description
ProductId [KEY]	String	True	Products.Id	No	The product associated with the resource feedback.
FeedbackGeneratedAt	Datetime	True		No	The time when the feedback was generated. Used to help determine whether incoming feedback is outdated compared to existing feedback.
Messages	String	True		No	The feedback messages presented to the merchant.
ProductUpdatedAt	Datetime	True		No	The timestamp of the product associated with the feedback.
State	String	True		No	Conveys the state of the feedback and whether it requires merchant action or not.

Return to Top

Products

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique identifier.
LegacyResourceId	Long	True	No	The ID of the corresponding resource in the REST Admin API.
Description	String	True	No	The description of the product, complete with HTML formatting.
DescriptionHtml	String	False	No	The description of the product, complete with HTML formatting.
Title	String	False	No	The title of the product.
Handle	String	False	No	A unique human-friendly string of the product's title.
Tags	String	False	No	A comma separated list of tags associated with the product. Updating 'tags' overwrites any existing tags that were previously added to the product.
Status	String	False	No	The product status. This controls visibility across all channels.
Vendor	String	False	No	The name of the product's vendor.
OnlineStorePreviewUrl	String	True	No	The online store preview URL.
OnlineStoreUrl	String	True	No	The online store URL for the product.A value of 'null' indicates that the product is not published to the Online Store sales channel.
TracksInventory	Bool	True	No	Whether inventory tracking has been enabled for the product.
TotalInventory	Int	True	No	The quantity of inventory in stock.
HasOnlyDefaultVariant	Bool	True	No	Whether the product has only a single variant with the default option and value.
HasOutOfStockVariants	Bool	True	No	Whether the product has out of stock variants.
HasVariantsThatRequiresComponents	Bool	True	No	Whether at least one of the product variants requires bundle components.
VariantsCount	Int	True	No	The number of variants that are associated with the product.
VariantsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
TemplateSuffix	String	False	No	The theme template used when viewing the product in a store.
GiftCardTemplateSuffix	String	False	No	The theme template used when viewing the gift card in a store.
IsGiftCard	Bool	False	No	Whether the product is a gift card.
PublishedAt	Datetime	True	No	The date and time when the product was published to the Online Store.
UpdatedAt	Datetime	True	No	The date and time when the product was last modified.A product's 'updatedAt' value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.
CreatedAt	Datetime	True	No	The date and time when the product was created.
ProductType	String	False	No	The product type specified by the merchant.
CategoryId	String	True	No	The globally-unique ID of the TaxonomyCategory.
CategoryName	String	True	No	The name of the taxonomy category. For example, Dog Beds.
CategoryFullName	String	True	No	The full name of the taxonomy category. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds.
SeoTitle	String	False	No	SEO Title.
SeoDescription	String	False	No	SEO Description.
RequiresSellingPlan	Bool	False	No	Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription ('requiresSellingPlan: true') can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store.
SellingPlanGroupsCount	Int	True	No	Count of selling plan groups associated with the product.
SellingPlanGroupsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
PriceRangeMaxVariantPriceAmount	Decimal	True	No	Decimal money amount.
PriceRangeMaxVariantPriceCurrencyCode	String	True	No	Currency of the money.
PriceRangeMinVariantPriceAmount	Decimal	True	No	Decimal money amount.
PriceRangeMinVariantPriceCurrencyCode	String	True	No	Currency of the money.
CompareAtPriceRangeMaxVariantCompareAtPriceAmount	Decimal	True	No	Decimal money amount.
CompareAtPriceRangeMaxVariantCompareAtPriceCurrencyCode	String	True	No	Currency of the money.
CompareAtPriceRangeMinVariantCompareAtPriceAmount	Decimal	True	No	Decimal money amount.
CompareAtPriceRangeMinVariantCompareAtPriceCurrencyCode	String	True	No	Currency of the money.
MediaCount	Int	True	No	Total count of media belonging to a product.
MediaCountPrecision	String	True	No	The count's precision, or the exactness of the value.
FeaturedMediaId	String	True	No	A globally-unique ID.
FeaturedMediaAlt	String	True	No	A word or phrase to share the nature or contents of a media.
FeaturedMediaContentType	String	True	No	The media content type.
FeaturedMediaStatus	String	True	No	Current status of the media.
FeaturedMediaPreviewStatus	String	True	No	Current status of the preview image.
FeaturedMediaPreviewImageId	String	True	No	The preview image for the media. Returns null until status is READY.
FeaturedMediaPreviewImageAltText	String	True	No	A word or phrase to share the nature or contents of an image.
FeaturedMediaPreviewImageUrl	String	True	No	The location of the image as a URL.
FeaturedMediaPreviewImageWidth	Int	True	No	The original width of the image in pixels. Returns null if the image isn't hosted by Shopify.
FeaturedMediaPreviewImageHeight	Int	True	No	The original height of the image in pixels. Returns null if the image isn't hosted by Shopify.
AvailablePublicationsCount	Int	True	No	The number of publications a resource is published to without feedback errors.
AvailablePublicationsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
PublishedOnCurrentPublication	Bool	True	No	Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.
ResourcePublicationOnCurrentPublicationAutoPublish	Bool	True	No	Whether new products are automatically published to this publication.
ResourcePublicationOnCurrentPublicationIsPublished	Bool	True	No	Whether the resource publication is published. If true, then the resource publication is published to the publication. If false, then the resource publication is staged to be published to the publication.
ResourcePublicationOnCurrentPublicationPublishDate	Datetime	True	No	The date that the resource publication was or is going to be published to the publication.
ResourcePublicationOnCurrentPublicationPublicationId	String	True	No	A globally-unique identifier.
ResourcePublicationOnCurrentPublicationPublicationName	String	True	No	Name of the publication.
ResourcePublicationOnCurrentPublicationPublicationSupportsFuturePublishing	Bool	True	No	Whether the publication supports future publishing.
ResourcePublicationsCount	Int	True	No	The number of publications that a resource is published to, without feedback errors.
ResourcePublicationsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
FeedbackSummary	String	True	No	Summary of resource feedback pertaining to the resource.
FeedbackDetails	String	True	No	List of AppFeedback detailing issues regarding a resource.
Metafields	String	False	Yes	The additional customizable information about the product variant.

Return to Top

ProductVariants

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique identifier.
LegacyResourceId	Long	True		No	The ID of the corresponding resource in the REST Admin API.
ProductId	String	False	Products.Id	No	A globally-unique identifier.
Position	Int	True		No	The order of the product variant in the list of product variants. The first position in the list is 1.
DisplayName	String	True		No	Display name of the variant, based on product's title + variant's title.
Barcode	String	False		No	The value of the barcode associated with the product.
Sku	String	True		No	An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
Title	String	True		No	The title of the product variant.
RequiresComponents	Bool	True		No	Whether a product variant requires components. The default value is 'false'. If 'true', then the product variant can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles.
UpdatedAt	Datetime	True		No	The date and time when the product variant was last modified.
CreatedAt	Datetime	True		No	The date and time when the variant was created.
SelectedOptions	String	True		No	List of product options applied to the variant.
AvailableForSale	Bool	True		No	Whether the product variant is available for sale.
Price	Decimal	False		No	The price of the product variant in the default shop currency.
CompareAtPrice	Decimal	False		No	The compare-at price of the variant in the default shop currency.
TaxCode	String	False		No	The tax code for the product variant.
Taxable	Bool	False		No	Whether a tax is charged when the product variant is sold.
SellableOnlineQuantity	Int	True		No	The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture (limitations based on customer location).
SellingPlanGroupsCount	Int	True		No	Count of selling plan groups associated with the product variant.
SellingPlanGroupsCountPrecision	String	True		No	The count's precision, or the exactness of the value.
DeliveryProfileId	String	True		No	A globally-unique identifier.
InventoryPolicy	String	False		No	Whether customers are allowed to place an order for the product variant when it's out of stock.
InventoryQuantity	Int	True		No	The total sellable quantity of the variant.
InventoryItemId	String	True		No	A globally-unique identifier.
InventoryItemUnitCostAmount	Decimal	False		No	Unit cost associated with the inventory item.
InventoryItemUnitCostCurrencyCode	String	True		No	Currency code of the unit cost associated with the inventory item.
InventoryItemHarmonizedSystemCode	String	False		No	The harmonized system code of the inventory item.
InventoryItemMeasurementWeightValue	Double	False		No	The weight value using the unit system specified with 'unit'.
InventoryItemMeasurementWeightUnit	String	False		No	The unit of measurement for 'value'.
InventoryItemRequiresShipping	Bool	False		No	Whether the inventory item requires shipping.
InventoryItemTracked	Bool	False		No	Whether inventory levels are tracked for the item.
ImageId	String	True		No	A unique identifier for the image.
ImageAltText	String	True		No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	True		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageWidth	Int	True		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	True		No	The location of the image as a URL.
MediaId	String	False		Yes	The ID of the media to associate with the variant.
MediaSrc	String	False		Yes	The URL of the media to associate with the variant.
InventoryQuantities	String	False		Yes	The inventory quantities at each location where the variant is stocked. The number of elements in the array of inventory quantities can't exceed the amount specified for the plan.
OptionValues	String	False		Yes	The custom properties that a shop owner uses to define product variants.
Metafields	String	False		Yes	The additional customizable information about the product variant.
Strategy	String	False		Yes	The strategy defines which behavior is observed, such as whether to keep or delete the standalone variant (when product has only a single or default variant) when creating new variants. If set to 'DEFAULT', keep the standalone variant (when product has only a single or default variant) when creating variants. If set to 'REMOVE_STANDALONE_VARIANT', delete the standalone variant (when product has only a single or default variant) when creating new variants.
AllowPartialUpdates	Bool	False		Yes	When partial updates are allowed, valid variant changes may be persisted even if some of the variants updated have invalid data and cannot be persisted. When partial updates are not allowed, any error will prevent all variants from updating.

Return to Top

PublicationCollections

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
LegacyResourceId	String	False		No	The ID of the corresponding resource in the REST Admin API.
PublicationId [KEY]	String	False	Publications.Id	No	A globally-unique ID.

Return to Top

PublicationProducts

Name	Type	ReadOnly	References	FilterOnly	Description
ProductId [KEY]	String	False	Products.Id	No	A globally-unique ID.
PublishDate	Datetime	False		No	The date that the resource publication was or is going to be published to the publication.
IsPublished	Bool	False		No	Whether the resource publication is published.
PublicationId [KEY]	String	False		No	A globally-unique ID.
PublicationName	String	False		No	Name of the publication.

Return to Top

Publications

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
AutoPublish	Bool	False	No	Whether new products are automatically published to this publication.
SupportsFuturePublishing	Bool	True	No	Whether the publication supports future publishing.
CatalogId	String	True	No	A globally-unique ID.
AddAllProductsOperationId	String	True	No	A globally-unique ID.
AddAllProductsOperationStatus	String	True	No	The status of this operation.
AddAllProductsOperationProcessedRowCount	Int	True	No	The count of processed rows, summing imported, failed, and skipped rows.
AddAllProductsOperationRowCountCount	Int	True	No	Estimated number of rows contained within this background operation.
AddAllProductsOperationRowCountExceedsMax	Bool	True	No	Whether the operation exceeds max number of reportable rows.
CatalogCsvOperationId	String	True	No	A globally-unique ID.
CatalogCsvOperationStatus	String	True	No	The status of this operation.
CatalogCsvOperationProcessedRowCount	Int	True	No	The count of processed rows, summing imported, failed, and skipped rows.
CatalogCsvOperationRowCountCount	Int	True	No	Estimated number of rows contained within this background operation.
CatalogCsvOperationRowCountExceedsMax	Bool	True	No	Whether the operation exceeds max number of reportable rows.
PublicationResourceOperationId	String	True	No	A globally-unique ID.
PublicationResourceOperationStatus	String	True	No	The status of this operation.
PublicationResourceOperationProcessedRowCount	Int	True	No	The count of processed rows, summing imported, failed, and skipped rows.
PublicationResourceOperationRowCountCount	Int	True	No	Estimated number of rows contained within this background operation.
PublicationResourceOperationRowCountExceedsMax	Bool	True	No	Whether the operation exceeds max number of reportable rows.
CatalogType	String	True	No	Filter publications by catalog type.
DefaultState	String	False	Yes	Whether to create an empty publication or prepopulate it with all products.
PublishablesToAdd	String	False	Yes	A simple, comma-separated list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50.
PublishablesToRemove	String	False	Yes	A simple, comma-separated list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50.

Return to Top

RefundDuties

Name	Type	ReadOnly	References	FilterOnly	Description
OriginalDutyId [KEY]	String	False		No	A globally-unique ID.
RefundId [KEY]	String	False	Refunds.Id	No	A globally-unique ID.
OriginalDutyHarmonizedSystemCode	String	False		No	The harmonized system code of the item used in calculating the duty.
OriginalDutyCountryCodeOfOrigin	String	False		No	The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.
AmountSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
AmountSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
AmountSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
AmountSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

RefundLineItemDuties

Name	Type	ReadOnly	FilterOnly	Description
RefundId	String	False	No	A globally-unique ID.
LineItemId	String	False	No	A globally-unique ID.
Id [KEY]	String	False	No	A globally-unique ID.
CountryCodeOfOrigin	String	False	No	The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.
HarmonizedSystemCode	String	False	No	The harmonized system code of the item used in calculating the duty.
PricePresentmentMoneyAmount	Decimal	False	No	Decimal money amount.
PricePresentmentMoneyCurrencyCode	String	False	No	Currency of the money.
PriceShopMoneyAmount	Decimal	False	No	Decimal money amount.
PriceShopMoneyCurrencyCode	String	False	No	Currency of the money.

Return to Top

RefundLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
LineItemId	String	False		No	A globally-unique ID.
RefundId [KEY]	String	False	Refunds.Id	No	A globally-unique ID.
LineItemName	String	False		No	The title of the product, optionally appended with the title of the variant (if applicable).
LineItemTitle	String	False		No	The title of the product at time of order creation.
LineItemVariantTitle	String	False		No	The title of the variant at time of order creation.
LineItemQuantity	Int	False		No	The number of variant units ordered.
LineItemRestockable	Bool	False		No	Whether the line item can be restocked.
LineItemSku	String	False		No	The variant SKU number.
LineItemTaxable	Bool	False		No	Whether the variant is taxable.
LineItemVendor	String	False		No	The name of the vendor who made the variant.
LineItemCurrentQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
LineItemMerchantEditable	Bool	False		No	Whether the line item can be edited or not.
LineItemRefundableQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
LineItemNonFulfillableQuantity	Int	False		No	The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details.
LineItemRequiresShipping	Bool	False		No	Whether physical shipping is required for the variant.
LineItemUnfulfilledQuantity	Int	False		No	The number of units not yet fulfilled.
LineItemImageId	String	False		No	A unique ID for the image.
LineItemImageWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
LineItemImageAltText	String	False		No	A word or phrase to share the nature or contents of an image.
LineItemImageHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
LineItemImageUrl	String	False		No	The location of the image as a URL.
LineItemProductId	String	False		No	A globally-unique ID.
LineItemVariantId	String	False		No	A globally-unique ID.
LineItemSellingPlanSellingPlanId	String	False		No	The ID of the selling plan associated with the line item.
LineItemStaffMemberId	String	False		No	A globally-unique ID.(This column is available only with a ShopifyPlus subscription)
Quantity	Int	False		No	The quantity of a refunded line item.
Restocked	Bool	False		No	Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.
RestockType	String	False		No	The type of restock for the refunded line item.
LocationId	String	False		No	A globally-unique ID.
PriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
PriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
PriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
SubtotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
SubtotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
SubtotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
SubtotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
TotalTaxSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
TotalTaxSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
TotalTaxSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
TotalTaxSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
LineItemContractId	String	False		No	A globally-unique ID.

Return to Top

Refunds

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Globally unique identifier.
LegacyResourceId	String	True		No	The ID of the corresponding resource in the REST Admin API.
OrderId	String	True	Orders.Id	No	A globally-unique ID.
Note	String	True		No	The optional note associated with the refund.
CreatedAt	Datetime	True		No	The date and time when the refund was created.
UpdatedAt	Datetime	True		No	The date and time when the refund was updated.
ReturnId	String	True		No	A globally-unique ID.
StaffMemberId	String	True		No	A globally-unique ID.(This column is available only with a ShopifyPlus subscription)
TotalRefundedSetPresentmentMoneyAmount	Decimal	True		No	Decimal money amount.
TotalRefundedSetPresentmentMoneyCurrencyCode	String	True		No	Currency of the money.
TotalRefundedSetShopMoneyAmount	Decimal	True		No	Decimal money amount.
TotalRefundedSetShopMoneyCurrencyCode	String	True		No	Currency of the money.
RefundLineItems	String	True		No	The list of the line items in the draft order.

Return to Top

RefundTransactionFees

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
TransactionId	String	False	RefundTransactions.Id	No	A globally-unique ID.
RefundId	String	False	Refunds.Id	No	A globally-unique ID.
RateName	String	False		No	Name of the credit card rate.
FlatFeeName	String	False		No	Name of the credit card flat fee.
Rate	Decimal	False		No	Percentage charge.
Type	String	False		No	Name of the type of fee.
AmountAmount	Decimal	False		No	Decimal money amount.
AmountCurrencyCode	String	False		No	Currency of the money.
FlatFeeAmount	Decimal	False		No	Decimal money amount.
FlatFeeCurrencyCode	String	False		No	Currency of the money.
TaxAmountAmount	Decimal	False		No	Decimal money amount.
TaxAmountCurrencyCode	String	False		No	Currency of the money.

Return to Top

RefundTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ResourceId [KEY]	String	False	Refunds.Id	No	A globally-unique ID.
PaymentId	String	False		No	The payment ID associated with the transaction.
ParentTransactionId	String	False		No	The associated parent transaction, for example the authorization of a capture.
AccountNumber	String	False		No	The masked account number associated with the payment method.
Gateway	String	False		No	The payment gateway used to process the transaction.
Kind	String	False		No	The kind of transaction.
Status	String	False		No	The status of this transaction.
Test	Bool	False		No	Whether the transaction is a test transaction.
AuthorizationCode	String	False		No	Authorization code associated with the transaction.
ErrorCode	String	False		No	A standardized error code, independent of the payment provider.
FormattedGateway	String	False		No	The human-readable payment gateway name used to process the transaction.
ManuallyCapturable	Bool	False		No	Whether the transaction can be manually captured.
MultiCapturable	Bool	False		No	Whether the transaction can be captured multiple times.
ProcessedAt	Datetime	False		No	Date and time when the transaction was processed.
ReceiptJson	String	False		No	The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction.
SettlementCurrency	String	False		No	The settlement currency.
AuthorizationExpiresAt	Datetime	False		No	The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations.
SettlementCurrencyRate	Decimal	False		No	The rate used when converting the transaction amount to settlement currency.
CreatedAt	Datetime	False		No	Date and time when the transaction was created.
CardPaymentDetailsName	String	False		No	The holder of the credit card.
CardPaymentDetailsBin	String	False		No	The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
CardPaymentDetailsCompany	String	False		No	The name of the company that issued the customer's credit card.
CardPaymentDetailsNumber	String	False		No	The customer's credit card number, with most of the leading digits redacted.
CardPaymentDetailsWallet	String	False		No	Digital wallet used for the payment.
CardPaymentDetailsExpirationMonth	Int	False		No	The month in which the used credit card expires.
CardPaymentDetailsExpirationYear	Int	False		No	The year in which the used credit card expires.
CardPaymentDetailsAvsResultCode	String	False		No	The response code from the address verification system (AVS). The code is always a single letter.
CardPaymentDetailsCvvResultCode	String	False		No	The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string.
PaymentIconId	String	False		No	A unique ID for the image.
PaymentIconWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
PaymentIconAltText	String	False		No	A word or phrase to share the nature or contents of an image.
PaymentIconHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
AmountSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
AmountSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
AmountSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
AmountSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
MaximumRefundableV2Amount	Decimal	False		No	Decimal money amount.
MaximumRefundableV2CurrencyCode	String	False		No	Currency of the money.
ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt	Datetime	False		No	The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment.
ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt	Datetime	False		No	The time after which capture will incur an additional fee.
ShopifyPaymentsSetRefundSetAcquirerReferenceNumber	String	False		No	The acquirer reference number (ARN) code generated for Visa/Mastercard transactions.
TotalUnsettledSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
TotalUnsettledSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
TotalUnsettledSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
TotalUnsettledSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

ReturnExchangeLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ResourceId	String	False	Returns.Id	No	A globally-unique ID.
Name	String	False		No	The title of the product, optionally appended with the title of the variant (if applicable).
Title	String	False		No	The title of the product at time of order creation.
VariantTitle	String	False		No	The title of the variant at time of order creation.
VariantId	String	False		No	A globally-unique ID.
ProductId	String	False		No	A globally-unique ID.
SellingPlanSellingPlanId	String	False		No	The ID of the selling plan associated with the line item.
Quantity	Int	False		No	The number of variant units ordered.
Restockable	Bool	False		No	Whether the line item can be restocked.
Sku	String	False		No	The variant SKU number.
Taxable	Bool	False		No	Whether the variant is taxable.
Vendor	String	False		No	The name of the vendor who made the variant.
CurrentQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
MerchantEditable	Bool	False		No	Whether the line item can be edited or not.
RefundableQuantity	Int	False		No	The line item's quantity, minus the removed quantity.
RequiresShipping	Bool	False		No	Whether physical shipping is required for the variant.
UnfulfilledQuantity	Int	False		No	The number of units not yet fulfilled.
NonFulfillableQuantity	Int	False		No	The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the object for more fulfillment details.
IsGiftCard	Bool	False		No	Whether the line item represents the purchase of a gift card.
DiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
DiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyAmountWithCodeDiscounts	Decimal	False		No	Decimal money amount.
DiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
DiscountedUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
DiscountedUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
ImageId	String	False		No	A unique ID for the image.
ImageWidth	Int	False		No	The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText	String	False		No	A word or phrase to share the nature or contents of an image.
ImageHeight	Int	False		No	The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl	String	False		No	The location of the image as a URL.
OriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
OriginalUnitPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
OriginalUnitPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
TotalDiscountSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
TotalDiscountSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
TotalDiscountSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledDiscountedTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledDiscountedTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledDiscountedTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledDiscountedTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledOriginalTotalSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledOriginalTotalSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
UnfulfilledOriginalTotalSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
UnfulfilledOriginalTotalSetShopMoneyCurrencyCode	String	False		No	Currency of the money.

Return to Top

ReturnLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ReturnId [KEY]	String	False	Returns.Id	No	A globally-unique ID.
Quantity	Int	False		No	The quantity being returned.
CustomerNote	String	False		No	A note from the customer that describes the item to be returned. Maximum length: 300 characters.
RefundableQuantity	Int	False		No	The quantity that can be refunded.
RefundedQuantity	Int	False		No	The quantity that was refunded.
ReturnReason	String	False		No	The reason for returning the item.
ReturnReasonNote	String	False		No	Additional information about the reason for the return. Maximum length: 255 characters.
TotalWeightUnit	String	False		No	The unit of measurement for `value`.
TotalWeightValue	Double	False		No	The weight value using the unit system specified with `unit`.
WithCodeDiscountedTotalPriceSetPresentmentMoneyAmount	Decimal	False		No	Decimal money amount.
WithCodeDiscountedTotalPriceSetPresentmentMoneyCurrencyCode	String	False		No	Currency of the money.
WithCodeDiscountedTotalPriceSetShopMoneyAmount	Decimal	False		No	Decimal money amount.
WithCodeDiscountedTotalPriceSetShopMoneyCurrencyCode	String	False		No	Currency of the money.
FulfillmentLineItemId	String	False		No	A globally-unique ID.

Return to Top

ReturnLineItemsUnverified

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ReturnId [KEY]	String	False	Returns.Id	No	A globally-unique ID.
CustomerNote	String	False		No	A note from the customer that describes the item to be returned. Maximum length: 300 characters.
Quantity	Int	False		No	The quantity being returned.
RefundableQuantity	Int	False		No	The quantity that can be refunded.
RefundedQuantity	Int	False		No	The quantity that was refunded.
ReturnReason	String	False		No	The reason for returning the item.
ReturnReasonNote	String	False		No	Additional information about the reason for the return. Maximum length: 255 characters.
UnitPriceAmount	Decimal	False		No	Decimal money amount.
UnitPriceCurrencyCode	String	False		No	Currency of the money.

Return to Top

Returns

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique ID.
OrdersId	String	True	Orders.Id	No	A globally-unique ID.
Name	String	True		No	The name of the return.
Status	String	True		No	The status of the return.
TotalQuantity	Int	True		No	The sum of all line item quantities for the return.
DeclineReason	String	True		No	The reason the customer's return request was declined.
DeclineNote	String	True		No	The notification message sent to the customer about their declined return request. Maximum length: 500 characters.
ReturnLineItems	String	True		No	The list of the line items in the return.

Return to Top

ScriptTags

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
LegacyResourceId	String	True	No	The ID of the corresponding resource in the REST Admin API.
Cache	Bool	False	No	Whether the Shopify CDN can cache and serve the script tag. If 'true', then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If 'false', then the script will be served as is.
Src	String	False	No	The URL to the remote script.
DisplayScope	String	False	No	The page or pages on the online store that the script should be included.
CreatedAt	Datetime	True	No	The date and time when the script tag was created.
UpdatedAt	Datetime	True	No	The date and time when the script tag was last updated.

Return to Top

SegmentFilterParameters

Name	Type	ReadOnly	FilterOnly	Description
SegmentFilterQueryName [KEY]	String	False	No	The query name of the filter.
QueryName [KEY]	String	False	No	The query name of the parameter.
ParameterType	String	False	No	The type of the parameter.
Optional	Bool	False	No	Whether the parameter is optional.
AcceptsMultipleValues	Bool	False	No	Whether the parameter accepts a list of values.
LocalizedName	String	False	No	The localized name of the parameter.
LocalizedDescription	String	False	No	The localized description of the parameter.

Return to Top

SegmentFilters

Name	Type	ReadOnly	FilterOnly	Description
QueryName [KEY]	String	False	No	The query name of the filter.
MultiValue	Bool	False	No	Whether a file can have multiple values for a single customer.
LocalizedName	String	False	No	The localized name of the filter.
ReturnValueType	String	False	No	The return value type for an event segment filter.

Return to Top

Segments

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
Name	String	False	No	The name of the segment.
Query	String	False	No	A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers.
CreationDate	Datetime	True	No	The date and time when the segment was added to the store.
LastEditDate	Datetime	True	No	The date and time when the segment was last updated.

Return to Top

SellingPlanGroups

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	A globally-unique ID.
AppId	String	False	No	The ID for app, exposed in Liquid and product JSON.
Name	String	False	No	The buyer-facing label of the selling plan group.
Description	String	False	No	The merchant-facing description of the selling plan group.
Options	String	False	No	The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values.
Position	Int	False	No	The relative position of the selling plan group for display.
Summary	String	True	No	A summary of the policies associated to the selling plan group.
MerchantCode	String	False	No	The merchant-facing label of the selling plan group.
ProductsCount	Int	True	No	A count of products associated to the selling plan group.
ProductsCountPrecision	String	True	No	The count's precision, or the exactness of the value.
CreatedAt	Datetime	True	No	The date and time when the selling plan group was created.
SellingPlansToCreate	String	False	No	List of selling plans to create.
SellingPlansToUpdate	String	False	No	List of selling plans to update.
SellingPlansToDelete	String	False	Yes	List of selling plans to delete as a simple, comma-separated list.
ProductIds	String	False	Yes	The IDs of the Products to add to the Selling Plan Group as a simple, comma-separated list.
ProductVariantIds	String	False	Yes	The IDs of the Variants to add to the Selling Plan Group as a simple, comma-separated list.

Return to Top

SellingPlanGroupSellingPlans

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
SellingPlanGroupId	String	False	SellingPlanGroups.Id	No	A globally-unique ID.
Name	String	False		No	A customer-facing description of the selling plan. If your store supports multiple currencies, then don't include country-specific pricing content, such as 'Buy monthly, get 10$ CAD off'. This field won't be converted to reflect different currencies.
Category	String	False		No	The category used to classify the selling plan for reporting purposes.
Description	String	False		No	Buyer facing string which describes the selling plan commitment.
Options	String	False		No	The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they are created by the same app, and have the same 'selling_plan_group. name' and 'selling_plan_group. options' values.
Position	Int	False		No	Relative position of the selling plan for display. A lower position will be displayed before a higher position.
CreatedAt	Datetime	False		No	The date and time when the selling plan was created.
InventoryPolicyReserve	String	False		No	When to reserve inventory for the order.
FixedBillingPolicyCheckoutChargeType	String	False		No	The charge type for the checkout charge.
FixedBillingPolicyCheckoutChargeValueAmount	Decimal	False		No	The charge value for the checkout charge. Decimal money amount.
FixedBillingPolicyCheckoutChargeValueCurrencyCode	String	False		No	The charge value for the checkout charge. Currency of the money.
FixedBillingPolicyCheckoutChargeValuePercentage	Double	False		No	The charge value for the checkout charge. The percentage value of the price used for checkout charge.
FixedBillingPolicyRemainingBalanceChargeExactTime	Datetime	False		No	The exact time when to capture the full payment.
FixedBillingPolicyRemainingBalanceChargeTimeAfterCheckout	String	False		No	The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration.
FixedBillingPolicyRemainingBalanceChargeTrigger	String	False		No	When to capture payment for amount due.
RecurringBillingPolicyAnchors	String	False		No	Specific anchor dates upon which the billing interval calculations should be made. Aggregate value.
RecurringBillingPolicyCreatedAt	Datetime	False		No	The date and time when the selling plan billing policy was created.
RecurringBillingPolicyInterval	String	False		No	The billing frequency, it can be either: day, week, month or year.
RecurringBillingPolicyIntervalCount	Int	False		No	The number of intervals between billings.
RecurringBillingPolicyMaxCycles	Int	False		No	Maximum number of billing iterations.
RecurringBillingPolicyMinCycles	Int	False		No	Minimum number of billing iterations.
FixedDeliveryPolicyAnchors	String	False		No	The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value.
FixedDeliveryPolicyCutoff	Int	False		No	A buffer period for orders to be included in next fulfillment anchor.
FixedDeliveryPolicyFulfillmentExactTime	Datetime	False		No	The date and time when the fulfillment should trigger.
FixedDeliveryPolicyFulfillmentTrigger	String	False		No	What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN.
FixedDeliveryPolicyIntent	String	False		No	Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported.
FixedDeliveryPolicyPreAnchorBehavior	String	False		No	The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP.
RecurringDeliveryPolicyAnchors	String	False		No	The specific anchor dates upon which the delivery interval calculations should be made. Aggregate value.
RecurringDeliveryPolicyCreatedAt	Datetime	False		No	The date and time when the selling plan delivery policy was created.
RecurringDeliveryPolicyCutoff	Int	False		No	Number of days which represent a buffer period for orders to be included in a cycle.
RecurringDeliveryPolicyIntent	String	False		No	Whether the delivery policy is merchant or buyer-centric. Buyer-centric delivery policies state the time when the buyer will receive the goods. Merchant-centric delivery policies state the time when the fulfillment should be started. Currently, only merchant-centric delivery policies are supported.
RecurringDeliveryPolicyInterval	String	False		No	The delivery frequency, it can be either: day, week, month or year.
RecurringDeliveryPolicyIntervalCount	Int	False		No	The number of intervals between deliveries.
RecurringDeliveryPolicyPreAnchorBehavior	String	False		No	The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is ASAP.
FixedPricingPolicies	String	False		No	Represents fixed selling plan pricing policies associated to the selling plan. Aggregate value.
RecurringPricingPolicies	String	False		No	Represents recurring selling plan pricing policies associated to the selling plan. Aggregate value.

Return to Top

Shop

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
Name	String	False	No	The shop's name.
RichTextEditorUrl	String	False	No	The URL of the rich text editor that can be used for mobile devices.
Description	String	False	No	The shop's meta description used in search engine results.
Email	String	False	No	The shop owner's email address. Shopify will use this email address to communicate with the shop owner.
Url	String	False	No	The URL of the shop's online store.
ContactEmail	String	False	No	The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.
CurrencyCode	String	False	No	The three letter code for the currency that the shop sells in.
CustomerAccounts	String	False	No	Whether customer accounts are required, optional, or disabled for the shop.
IanaTimezone	String	False	No	The shop's time zone as defined by the IANA.
MyshopifyDomain	String	False	No	The shop's . myshopify. com domain name.
PublicationsCount	Int	False	No	The number of publications for the shop.
PublicationsCountPrecision	String	False	No	The count's precision, or the exactness of the value.
SetupRequired	Bool	False	No	Whether the shop has outstanding setup steps.
TaxShipping	Bool	False	No	Whether the shop charges taxes for shipping.
TaxesIncluded	Bool	False	No	Whether applicable taxes are included in the shop's product prices.
TimezoneAbbreviation	String	False	No	The shop's time zone abbreviation.
TimezoneOffset	String	False	No	The shop's time zone offset.
UnitSystem	String	False	No	The shop's unit system for weights and measures.
WeightUnit	String	False	No	The shop's primary unit of weight for products and shipping.
CheckoutApiSupported	Bool	False	No	Specifies whether the shop supports checkouts via Checkout API.
EnabledPresentmentCurrencies	String	False	No	The presentment currencies enabled for the shop.
ShipsToCountries	String	False	No	The list of countries that the shop ships to.
TimezoneOffsetMinutes	Int	False	No	The shop's time zone offset expressed as a number of minutes.
TransactionalSmsDisabled	Bool	False	No	Whether transactional SMS sent by Shopify have been disabled for a shop.
OrderNumberFormatPrefix	String	False	No	The prefix that appears before order numbers.
OrderNumberFormatSuffix	String	False	No	The suffix that appears after order numbers.
BillingAddressId	String	False	No	A globally-unique ID.
BillingAddressCoordinatesValidated	Bool	False	No	Whether the address coordinates are valid.
BillingAddressAddress1	String	False	No	The first line of the address. Typically the street address or PO Box number.
BillingAddressAddress2	String	False	No	The second line of the address. Typically the number of the apartment, suite, or unit.
BillingAddressCity	String	False	No	The name of the city, district, village, or town.
BillingAddressCompany	String	False	No	The name of the company or organization.
BillingAddressCountry	String	False	No	The name of the country.
BillingAddressLatitude	Double	False	No	The latitude coordinate of the address.
BillingAddressLongitude	Double	False	No	The longitude coordinate of the address.
BillingAddressPhone	String	False	No	A phone number associated with the address. Formatted using E. 164 standard. For example, +16135551111.
BillingAddressProvince	String	False	No	The region of the address, such as the province, state, or district.
BillingAddressZip	String	False	No	The zip or postal code of the address.
BillingAddressFormattedArea	String	False	No	A comma-separated list of the values for city, province, and country.
BillingAddressProvinceCode	String	False	No	The two-letter code for the region. For example, ON.
BillingAddressCountryCodeV2	String	False	No	The two-letter code for the country of the address. For example, US.
CountriesInShippingZonesCountryCodes	String	False	No	The list of all the countries from all the combined shipping zones.
CountriesInShippingZonesIncludeRestOfWorld	Bool	False	No	Whether 'Rest of World' has been defined in any of the shipping zones.
CurrencyFormatsMoneyFormat	String	False	No	Money without currency in HTML.
CurrencyFormatsMoneyInEmailsFormat	String	False	No	Money without currency in emails.
CurrencyFormatsMoneyWithCurrencyFormat	String	False	No	Money with currency in HTML.
CurrencyFormatsMoneyWithCurrencyInEmailsFormat	String	False	No	Money with currency in emails.
FeaturesInternationalPriceOverrides	Bool	False	No	Whether a shop can enable international price overrides.
FeaturesBranding	String	False	No	The branding of the shop, which influences its look and feel in the Shopify admin.
FeaturesCaptcha	Bool	False	No	Whether a shop's online store can have CAPTCHA protection.
FeaturesReports	Bool	False	No	Whether a shop has access to all reporting features.
FeaturesStorefront	Bool	False	No	Whether a shop has an online store.
FeaturesAvalaraAvatax	Bool	False	No	Whether a shop has access to Avalara AvaTax.
FeaturesDynamicRemarketing	Bool	False	No	Whether a shop has access to the Google Analytics dynamic remarketing feature.
FeaturesGiftCards	Bool	False	No	Whether a shop can create gift cards.
FeaturesLiveView	Bool	False	No	Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial or don't have a storefront.
FeaturesSellsSubscriptions	Bool	False	No	Whether a shop has ever had subscription products.
FeaturesShowMetrics	Bool	False	No	Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful.
FeaturesEligibleForSubscriptions	Bool	False	No	Whether a shop is configured properly to sell subscriptions.
FeaturesHarmonizedSystemCode	Bool	False	No	Whether a shop displays Harmonized System codes on products. This is used for customs when shipping internationally.
FeaturesInternationalPriceRules	Bool	False	No	Whether a shop can enable international price rules.
FeaturesEligibleForSubscriptionMigration	Bool	False	No	Whether a shop can be migrated to use Shopify subscriptions.
FeaturesLegacySubscriptionGatewayEnabled	Bool	False	No	Whether a shop has enabled a legacy subscription gateway to handle older subscriptions.
FeaturesPaypalExpressSubscriptionGatewayStatus	String	False	No	Whether a shop is configured to sell subscriptions with PayPal Express.
PendingOrdersCount	Int	False	No	The count of elements.
PendingOrdersPrecision	String	False	No	The count's precision, or the exactness of the value.
PaymentSettingsSupportedDigitalWallets	String	False	No	List of the digital wallets which the shop supports.
PlanDisplayName	String	False	No	The name of the shop's billing plan.
PlanPartnerDevelopment	Bool	False	No	Whether the shop is a partner development shop for testing purposes.
PlanShopifyPlus	Bool	False	No	Whether the shop has a Shopify Plus subscription.
PrimaryDomainId	String	False	No	A globally-unique ID.
PrimaryDomainHost	String	False	No	The host name of the domain. For example, 'example. com'.
PrimaryDomainUrl	String	False	No	The URL of the domain (for example, 'https: //example. com').
PrimaryDomainSslEnabled	Bool	False	No	Whether SSL is enabled.
PrimaryDomainLocalizationCountry	String	False	No	The ISO code for the country assigned to the domain. For example, 'CA' or '*' for a domain set to 'Rest of world'.
PrimaryDomainLocalizationAlternateLocales	String	False	No	The ISO codes for the domain's alternate locales. For example, '['en']'.
PrimaryDomainLocalizationDefaultLocale	String	False	No	The ISO code for the domain's default locale. For example, 'en'.
PrimaryDomainMarketWebPresenceId	String	False	No	A globally-unique ID.
PrimaryDomainMarketWebPresenceAlternateLocales	String	False	No	The ISO codes for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and 'example. ca' is the market's domain, then 'example. ca/en' will load in English.
PrimaryDomainMarketWebPresenceDefaultLocale	String	False	No	The ShopLocale object for the default locale. The locale ISO code.
PrimaryDomainMarketWebPresenceDefaultLocaleMarketWebPresencesId	String	False	No	The ShopLocale object for the default locale. The market web presences that use the locale.
PrimaryDomainMarketWebPresenceDefaultLocaleName	String	False	No	The ShopLocale object for the default locale. The human-readable locale name.
PrimaryDomainMarketWebPresenceDefaultLocalePrimary	Bool	False	No	The ShopLocale object for the default locale. Whether the locale is the default locale for the shop.
PrimaryDomainMarketWebPresenceDefaultLocalePublished	Bool	False	No	The ShopLocale object for the default locale. Whether the locale is visible to buyers.
PrimaryDomainMarketWebPresenceSubfolderSuffix	String	False	No	The market-specific suffix of the subfolders defined by the web presence. Example: in '/en-us' the subfolder suffix is 'us'. This field will be null if 'domain' isn't null.
ResourceLimitsLocationLimit	Int	False	No	Maximum number of locations allowed.
ResourceLimitsMaxProductOptions	Int	False	No	Maximum number of product options allowed.
ResourceLimitsMaxProductVariants	Int	False	No	The maximum number of variants allowed per product.
ResourceLimitsRedirectLimitReached	Bool	False	No	Whether the shop has reached the limit of the number of URL redirects it can make for resources.

Return to Top

ShopifyPaymentsAccount

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
Activated	Bool	False	No	Whether the Shopify Payments setup is completed.
Country	String	False	No	The Shopify Payments account country.
Onboardable	Bool	False	No	Whether the Shopify Payments account can be onboarded.
DefaultCurrency	String	False	No	The default payout currency for the Shopify Payments account.
PayoutStatementDescriptor	String	False	No	The descriptor used for payouts. The descriptor appears on a merchant's bank statement when they receive a payout.
FraudSettingsDeclineChargeOnAvsFailure	Bool	False	No	Decline a charge if there is an AVS failure.
FraudSettingsDeclineChargeOnCvcFailure	Bool	False	No	Decline a charge if there is an CVC failure.
NotificationSettingsPayouts	Bool	False	No	Receive email notifications when new payouts are sent or payouts fail.
PayoutScheduleInterval	String	False	No	The interval at which payouts are sent to the connected bank account.
PayoutScheduleMonthlyAnchor	Int	False	No	The day of the month funds will be paid out. The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months.
PayoutScheduleWeeklyAnchor	String	False	No	The day of the week funds will be paid out. The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used.

Return to Top

ShopifyPaymentsAccountBalance

Name	Type	ReadOnly	References	FilterOnly	Description
ShopifyPaymentsAccountId	String	False	ShopifyPaymentsAccount.Id	No	A globally-unique ID.
Amount	Decimal	False		No	Decimal money amount.
CurrencyCode [KEY]	String	False		No	Currency of the money.

Return to Top

ShopifyPaymentsAccountBalanceTransactionAdjustmentsOrders

Name	Type	ReadOnly	FilterOnly	Description
Link [KEY]	String	False	No	The link to the adjustment order.
Name	String	False	No	The name of the adjustment order.
Amount	Decimal	False	No	The amount of the adjustment order. Decimal money amount.
AmountCurrencyCode	String	False	No	The amount of the adjustment order. Currency of the money.
ShopifyPaymentsAccountBalanceTransactionId [KEY]	String	False	No	A globally-unique ID.

Return to Top

ShopifyPaymentsAccountBalanceTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ShopifyPaymentsAccountId	String	False	ShopifyPaymentsAccount.Id	No	A globally-unique ID.
NetAmount	Decimal	False		No	The net amount contributing to the merchant's balance. Decimal money amount.
NetCurrencyCode	String	False		No	The net amount contributing to the merchant's balance. Currency of the money.
TransactionDate	Datetime	False		No	The date and time when the balance transaction was processed.
SourceType	String	False		No	The source type of the balance transaction.
Type	String	False		No	The type of the transaction.
Test	Bool	False		No	Whether the transaction was created in test mode.
Amount	Decimal	False		No	Decimal money amount.
AmountCurrencyCode	String	False		No	Currency of the money.
FeeAmount	Decimal	False		No	Decimal money amount.
FeeCurrencyCode	String	False		No	Currency of the money.
AssociatedOrderId	String	False		No	The ID of the associated order.
AssociatedOrderName	String	False		No	The name of the associated order.
AssociatedPayoutId	String	False		No	The ID of the payout associated with the balance transaction.
AssociatedPayoutStatus	String	False		No	The status of the payout associated with the balance transaction.

Return to Top

ShopifyPaymentsAccountBankAccounts

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ShopifyPaymentsAccountId	String	False	ShopifyPaymentsAccount.Id	No	A globally-unique ID.
BankName	String	False		No	The name of the bank.
Country	String	False		No	The country of the bank.
Currency	String	False		No	The currency of the bank account.
Status	String	False		No	The status of the bank account.
AccountNumber	String	False		No	The account number of the bank account.
RoutingNumber	String	False		No	The routing number of the bank account.
AccountNumberLastDigits	String	False		No	The last digits of the account number (the rest is redacted).
CreatedAt	Datetime	False		No	The date that the bank account was created.

Return to Top

ShopifyPaymentsAccountDisputes

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
LegacyResourceId	String	False		No	The ID of the corresponding resource in the REST Admin API.
ShopifyPaymentsAccountId	String	False	ShopifyPaymentsAccount.Id	No	A globally-unique ID.
EvidenceDueBy	Date	False		No	The deadline for evidence submission.
EvidenceSentOn	Date	False		No	The date when evidence was sent. Returns null if evidence has not yet been sent.
Status	String	False		No	The current state of the dispute.
Type	String	False		No	Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.
FinalizedOn	Date	False		No	The date when this dispute was resolved. Returns null if the dispute is not yet resolved.
InitiatedAt	Datetime	False		No	The date when this dispute was initiated.
AmountAmount	Decimal	False		No	Decimal money amount.
AmountCurrencyCode	String	False		No	Currency of the money.
OrderId	String	False		No	A globally-unique ID.
ReasonDetailsReason	String	False		No	The reason for the dispute provided by the cardholder's banks.
ReasonDetailsNetworkReasonCode	String	False		No	The raw code provided by the payment network.

Return to Top

ShopifyPaymentsAccountPayouts

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
LegacyResourceId	String	False		No	The ID of the corresponding resource in the REST Admin API.
ShopifyPaymentsAccountId	String	False	ShopifyPaymentsAccount.Id	No	A globally-unique ID.
Status	String	False		No	The transfer status of the payout.
IssuedAt	Datetime	False		No	The exact time when the payout was issued. The payout only contains balance transactions that were available at this time.
TransactionType	String	False		No	The direction of the payout.
BankAccountId	String	False		No	A globally-unique ID.
NetAmount	Decimal	False		No	Decimal money amount.
NetCurrencyCode	String	False		No	Currency of the money.
SummaryAdjustmentsFeeAmount	Decimal	False		No	Decimal money amount.
SummaryAdjustmentsFeeCurrencyCode	String	False		No	Currency of the money.
SummaryAdjustmentsGrossAmount	Decimal	False		No	Decimal money amount.
SummaryAdjustmentsGrossCurrencyCode	String	False		No	Currency of the money.
SummaryChargesFeeAmount	Decimal	False		No	Decimal money amount.
SummaryChargesFeeCurrencyCode	String	False		No	Currency of the money.
SummaryChargesGrossAmount	Decimal	False		No	Decimal money amount.
SummaryChargesGrossCurrencyCode	String	False		No	Currency of the money.
SummaryRefundsFeeAmount	Decimal	False		No	Decimal money amount.
SummaryRefundsFeeCurrencyCode	String	False		No	Currency of the money.
SummaryRefundsFeeGrossAmount	Decimal	False		No	Decimal money amount.
SummaryRefundsFeeGrossCurrencyCode	String	False		No	Currency of the money.
SummaryReservedFundsFeeAmount	Decimal	False		No	Decimal money amount.
SummaryReservedFundsFeeCurrencyCode	String	False		No	Currency of the money.
SummaryReservedFundsGrossAmount	Decimal	False		No	Decimal money amount.
SummaryReservedFundsGrossCurrencyCode	String	False		No	Currency of the money.
SummaryRetriedPayoutsFeeAmount	Decimal	False		No	Decimal money amount.
SummaryRetriedPayoutsFeeCurrencyCode	String	False		No	Currency of the money.
SummaryRetriedPayoutsGrossAmount	Decimal	False		No	Decimal money amount.
SummaryRetriedPayoutsGrossCurrencyCode	String	False		No	Currency of the money.

Return to Top

ShopifyPaymentsAccountPermittedVerificationDocuments

Name	Type	ReadOnly	References	FilterOnly	Description
ShopifyPaymentsAccountId	String	False	ShopifyPaymentsAccount.Id	No	A globally-unique ID.
Type [KEY]	String	False		No	The type of the document which can be used for verification.
BackRequired	Bool	False		No	True if the back side of the document is required.
FrontRequired	Bool	False		No	True if the front side of the document is required.

Return to Top

ShopifyPaymentsAccountVerifications

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ShopifyPaymentsAccountId	String	False	ShopifyPaymentsAccount.Id	No	A globally-unique ID.
Status	String	False		No	The status of the verification.
SubjectFamilyName	String	False		No	The family name of the individual to verify.
SubjectGivenName	String	False		No	The given name of the individual to verify.

Return to Top

StaffMembers

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	A globally-unique ID.
ShopId	String	False	Shop.Id	No	A globally-unique ID.
Name	String	False		No	The staff member's full name.
FirstName	String	False		No	The staff member's first name.
LastName	String	False		No	The staff member's last name.
Active	Bool	False		No	Whether the staff member is active.
Email	String	False		No	The staff member's email address.
Exists	Bool	False		No	Whether the staff member's account exists.
Initials	String	False		No	The staff member's initials, if available.
Locale	String	False		No	The staff member's preferred locale. Locale values use the format 'language' or 'language-COUNTRY', where 'language' is a two-letter language code, and 'COUNTRY' is a two-letter country code. For example: 'en' or 'en-US'
Phone	String	False		No	The staff member's phone number.
IsShopOwner	Bool	False		No	Whether the staff member is the shop owner.
PrivateDataAccountSettingsUrl	String	False		No	The URL to the staff member's account settings page.
PrivateDataCreatedAt	Datetime	False		No	The date and time when the staff member was created.

Return to Top

StorefrontAccessTokens

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	A globally-unique ID.
ShopId	String	True	Shop.Id	No	A globally-unique ID.
Title	String	True		No	An arbitrary title for each token determined by the developer, used for reference purposes.
AccessToken	String	True		No	The issued public access token.
CreatedAt	Datetime	True		No	The date and time when the public access token was created.
UpdatedAt	Datetime	True		No	The date and time when the storefront access token was updated.

Return to Top

TenderTransactions

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	A globally-unique ID.
Test	Bool	False	No	Whether the transaction is a test transaction.
PaymentMethod	String	False	No	Information about the payment method used for the transaction.
ProcessedAt	Datetime	False	No	Date and time when the transaction was processed.
RemoteReference	String	False	No	The remote gateway reference associated with the tender transaction.
AmountAmount	Decimal	False	No	Decimal money amount.
AmountCurrencyCode	String	False	No	Currency of the money.
TenderTransactionCreditCardDetailsCreditCardCompany	String	False	No	The name of the company that issued the customer's credit card. Example: 'Visa'.
TenderTransactionCreditCardDetailsCreditCardNumber	String	False	No	The customer's credit card number, with all digits except the last 4 redacted. Example: '???? ???? ???? 1234'
UserId	String	False	No	A globally-unique ID.(This column is available only with a ShopifyPlus subscription)

Return to Top

UrlRedirects

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	The ID of the URL redirect.
Path	String	False	No	The old path to be redirected from. When the user visits this path, they will be redirected to the target location.
Target	String	False	No	The target location where the user will be redirected to.

Return to Top