Shopify Connector Objects (REST-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
AbandonedCheckouts	Query abandoned checkouts.
AbandonedCheckoutsItems	Query abandoned checkouts items.
ApplicationCharges	Create or view Application Charges for Billing.
ApplicationCredit	Create or view Application Credit for Billing.
Articles	Create, read, update or delete articles
Assets	Create, read, update or delete assets. CUD support is no longer accessible for public apps.
AssignedFulfillmentOrders	The AssignedFulfillmentOrder resource allows you to retrieve all the fulfillment orders that are assigned to an app at the shop level.
Blogs	Create, read, update or delete blogs
CarrierServices	Returns a list of resource feedback objects..
CollectionListings	Query and delete information regarding different collects.
Collects	Query, insert, or delete information regarding different collects.
Comments	Create, read, update and delete the comments.
CustomCollections	Query, insert, update, or delete information regarding different custom collections.
CustomerAddresses	Create, update, delete, and query customer addresses.
Customers	Create, update, delete, and query customers.
DiscountApplications	Query note attributes belonging to an order or draft order.
DiscountCodes	Create, select, update, and delete information regarding discount codes.
DraftOrderItemProperties	Query order item properties.
DraftOrderItems	Query draft order items.
DraftOrderItemTaxLines	Query draft order items tax lines.
DraftOrders	Create, update, delete, and query draft orders.
Events	Retrieve events which have happened in your shop.
FulfillmentEvents	Create, delete, and query information regarding fulfillment events.
FulfillmentOrderLineItems	Query fulfillment order line items.
FulfillmentOrders	Query fulfillment orders.
Fulfillments	Create, update, and query fulfillments.
FulfillmentServices	Query, create, update, and delete information regarding different fulfillment services.
GiftCards	Create, update, delete, and query gift cards.
Locations	Retrieve information regarding store locations.
MarketingEvents	Create, update, delete, and query marketing events.
Metafields	Retrieves a list of metafields that belong to a resource.
NoteAttributes	Query note attributes belonging to an order or draft order.
OrderDiscountCodes	Query note attributes belonging to an order or draft order.
OrderItemDiscountAllocations	Query order item discount allocations.
OrderItemProperties	Query order item properties.
Orders	Create, update, delete, and query orders.
OrdersItems	Query order items.
OrderTransactions	Create and query transactions.
Pages	Create, read, update or delete pages
Payouts	Retrieves a list of all payouts ordered by payout date, with the most recent being first.
PayoutTransactions	Retrieves a list of all balance transactions ordered by processing time, with the most recent being first.
PayoutTransactionsAdjustmentOrderTransactions	Retrieves associated order transactions that resulted in a balance transaction.
PriceRules	Create, update, delete, and query price rules.
RecurringApplicationCharges	Create, update, delete, and query Recurring Application Charges.
Redirects	Create, read, update or delete redirects.
RefundAdjustments	Create and query transactions.
Refunds	Create and query refunds.
RefundsItems	Get data on OrdersItems that have been refunded.
RefundTransactions	Query transactions for Refund Object.
ResourceFeedbacks	Returns a list of resource feedback objects..
ScriptTags	Create, read, update or delete script tags.
ShippingItemDiscountAllocations	Query Shipping item discount allocations.
ShippingItems	Query order shipping.
ShippingZones	Retrieve information regarding shipping zones.
Shop	Contains general settings and information about the shop.
SmartCollections	Query, insert, update, or delete information regarding different smart collections.
TaxItems	Query order taxes.
Themes	Create, read, update or delete themes
UsageCharges	Create or view Usage Charges for Recurring Application Charges.
Users	Query Users.

AbandonedCheckouts

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	The unique numeric identifier for the order.
AbandonedCheckoutUrl	String	False		No	The full recovery URL to be sent to a customer to recover their abandoned checkout.
BuyerAcceptsMarketing	Bool	False		No	Indicates whether or not the person who placed the order would like to receive email updates from the shop.
CancelReason	String	False		No	The reason why the order was cancelled.
CartToken	String	False		No	Unique identifier for a particular cart that is attached to a particular order.
Currency	String	False		No	The three letter code (ISO 4217) for the currency used for the payment.
CustomerId	Long	False	Customers.Id	No	A unique numeric identifier for the customer.
DiscountCodes	String	False		No	Applicable discount codes that can be applied to the order.
Email	String	False		No	The customer's email address.
Note	String	False		No	The text of an optional note that a shop owner can attach to the order.
LandingSite	String	False		No	The URL for the page where the buyer landed when entering the shop.
ReferringSite	String	False		No	The website that the customer clicked on to come to the shop.
SourceName	String	False		No	Where the order originated.
SubtotalPrice	Decimal	False		No	Price of the order before shipping and taxes.
TotalDiscounts	Decimal	False		No	The total amount of the discounts to be applied to the price of the order.
TotalLineItemsPrice	Decimal	False		No	The sum of all the prices of all the items in the order.
TotalPrice	Decimal	False		No	The sum of all the prices of all the items in the order, taxes and discounts included.
TotalTax	Decimal	False		No	The sum of all the taxes applied to the order.
TotalWeight	Double	False		No	The sum of all the weights of the line items in the order, in grams.
TaxesIncluded	Bool	False		No	States whether or not taxes are included in the order subtotal.
Token	String	False		No	Unique identifier for a particular order.
BillingAddressFirstName	String	False		No	The first name of the person associated with the payment method.
BillingAddressLastName	String	False		No	The last name of the person associated with the payment method.
BillingAddressAdress1	String	False		No	The street address of the billing address.
BillingAddressAdress2	String	False		No	An optional additional field for the street address of the billing address.
BillingAddressPhone	String	False		No	The phone number at the billing address.
BillingAddressCity	String	False		No	The city of the billing address.
BillingAddressCompany	String	False		No	The company of the person associated with the billing address.
BillingAddressZip	String	False		No	The zip or postal code of the billing address.
BillingAddressProvince	String	False		No	The name of the state or province of the billing address.
BillingAddressCountry	String	False		No	The name of the country of the billing address.
BillingAddressLatitude	Double	False		No	The latitude of the billing address.
BillingAddressLongitude	Double	False		No	The longitude of the billing address.
BillingAddressName	String	False		No	The full name of the person associated with the payment method.
BillingAddressCountryCode	String	False		No	The two-letter code for the country of the billing address.
BillingAddressProvinceCode	String	False		No	The two-letter abbreviation of the state or province of the billing address.
BillingAddressDefault	Bool	False		No	Whether this address is the default one or not.
ShippingAddressFirstName	String	False		No	The first name of the person associated with the shipping address.
ShippingAddressLastName	String	False		No	The last name of the person associated with the shipping address.
ShippingAddressAdress1	String	False		No	The street address of the shipping address.
ShippingAddressAdress2	String	False		No	An optional additional field for the street address of the shipping address.
ShippingAddressPhone	String	False		No	The phone number at the shipping address.
ShippingAddressCity	String	False		No	The city of the shipping address.
ShippingAddressCompany	String	False		No	The company of the person associated with the shipping address.
ShippingAddressZip	String	False		No	The zip or postal code of the shipping address.
ShippingAddressProvince	String	False		No	The name of the state or province of the shipping address.
ShippingAddressCountry	String	False		No	The name of the country of the shipping address.
ShippingAddressLatitude	Double	False		No	The latitude of the shipping address.
ShippingAddressLongitude	Double	False		No	The longitude of the shipping address.
ShippingAddressName	String	False		No	The full name of the person associated with the shipping address.
ShippingAddressCountryCode	String	False		No	The two-letter code for the country of the shipping address.
ShippingAddressProvinceCode	String	False		No	The two-letter abbreviation of the state or province of the shipping address.
ShippingAddressDefault	Bool	False		No	Whether this address is the default one or not.
ClosedAt	Datetime	False		No	The date and time when the order was closed.
CompletedAt	Datetime	False		No	CompletedAt
CreatedAt	Datetime	False		No	The date and time when the order was created.
UpdatedAt	Datetime	False		No	The date and time when the order was last modified.

Return to Top

AbandonedCheckoutsItems

Name	Type	ReadOnly	References	FilterOnly	Description
AbandonedCheckoutId [KEY]	Long	False	AbandonedCheckouts.Id	No	The unique numeric identifier for the order.
ProductId [KEY]	Long	False		No	The product ID od the item.
ItemVariantId [KEY]	Long	False		No	The product variant ID of item.
ItemTitle	String	False		No	The title of the product.
ItemQuantity	Int	False		No	The number of products that were purchased.
ItemPrice	Decimal	False		No	The price of the item in presentment currency.
ItemGrams	Int	False		No	The weight of the item in grams.
SKU	String	False		No	A unique identifier for the item in the shop.
VariantTitle	String	False		No	The title of the product variant.
Vendor	String	False		No	The name of the item's supplier.
FulFillmentsService	String	False		No	The fulfillment service provider for the item.
CreatedAt	Datetime	False		No	The date and time when the order was created.
UpdatedAt	Datetime	False		No	The date and time when the order was last modified.

Return to Top

ApplicationCharges

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The Unique Identifier of the Application Charge
Name	String	False	No	The Order Number
ApiClientId	Long	True	No	The API Client ID
Price	Decimal	False	No	The price of the application charge
Status	String	True	No	The status of the application charge. Valid Values are: pending, active, declined, expired
ReturnUrl	String	False	No	The URL where the merchant is redirected after accepting a charge.
Test	String	False	No	Whether the application charge is a test transaction. Valid values:true,null
CreatedAt	Datetime	True	No	The date and time (ISO 8601 format) when the application charge was created.
UpdatedAt	Datetime	True	No	The date and time (ISO 8601 format) when the application charge was last updated.
ChargeType	String	True	No	The type of the application charge
DecoratedReturnUrl	String	True	No	The decorated return url

Return to Top

ApplicationCredit

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The ID of the application credit.
Amount	Decimal	False	No	The amount refunded by the application credit.
Description	String	False	No	The description of the application credit.
Test	String	False	No	Whether the application credit is a test transaction. Valid values: true,null

Return to Top

Articles

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The ID of the article.
BlogId [KEY]	Long	False	Blogs.Id	No	The ID of the blog containing the article.
AdminGraphqlApiId	String	True		No	Displays the Admin Graphql API id.
Author	String	False		No	The name of the author of the article.
BodyHtml	String	False		No	The text of the body of the article, complete with HTML markup.
CreatedAt	Datetime	True		No	The date and time (ISO 8601 format) when the article was created.
Handle	String	False		No	A human-friendly unique string for the article that's automatically generated from the article's title. The handle is used in the article's URL.
ImageAlt	String	False		No	Alternative text that describes the image.
ImageCreatedAt	Datetime	True		No	The date and time when image is created.
ImageHeight	Int	False		No	Height of the image.
ImageSrc	String	False		No	A source URL that specifies the location of the image.
ImageWidth	Int	False		No	Width of the image.
ImageAttachment	String	False		No	An image attached to article returned as Base64-encoded binary data.
PublishedAt	Datetime	False		No	The date and time (ISO 8601 format) when the article was published.
SummaryHtml	String	False		No	A summary of the article, complete with HTML markup.
Tags	String	False		No	Tags are additional short descriptors formatted as a string of comma-separated values.
TemplateSuffix	String	False		No	The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.
Title	String	False		No	The title of the article.
UpdatedAt	Datetime	True		No	The date and time (ISO 8601 format) when the article was last updated.
UserId	Long	True		No	A unique numeric identifier for the author of the article.
PublishedStatus	String	False		No	Filter articles by their publish status. Valid values are: published, unpublished and any ; default: any.

Return to Top

Assets

Name	Type	ReadOnly	References	FilterOnly	Description
Key [KEY]	String	False		No	The path to the asset within a theme.
ThemeId [KEY]	Long	True	Themes.Id	No	The ID for the theme that an asset belongs to.
Attachment	String	False		No	A base64-encoded image.
Checksum	String	True		No	The MD5 representation of the content, consisting of a string of 32 hexadecimal digits. May be null if an asset has not been updated recently.
ContentType	String	True		No	The MIME representation of the content, consisting of the type and subtype of the asset.
CreatedAt	Datetime	True		No	The date and time (ISO 8601 format) when the asset was created.
PublicUrl	String	True		No	The public-facing URL of the asset.
Size	Int	True		No	The asset size in bytes.
UpdatedAt	Datetime	True		No	The date and time (ISO 8601 format) when an asset was last updated.
Value	String	False		No	The text content of the asset, such as the HTML and Liquid markup of a template file.

Return to Top

AssignedFulfillmentOrders

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	The ID of the fulfillment order.
ShopId	Long	False	Shop.Id	No	The ID of the shop that's associated with the fulfillment order.
OrderId	Long	False	Orders.Id	No	The ID of the order that's associated with the fulfillment order.
AssignedLocationId	Long	False		No	The ID of the location that has been assigned to do the work.
FulfillmentServiceHandle	String	False		No	A unique numeric identifier for the order.
RequestStatus	String	False		No	The status of the fulfillment.
DestinationId	String	False		No	The ID of the fulfillment order 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.
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.
DestinationPhone	String	False		No	The phone number of the customer at the destination.
LineItems	String	False		No	Represents line items belonging to a fulfillment order.
Status	String	False		No	The status of the fulfillment order.
Operation	String	False		No	An operation to apply to the fulfillment. Complete, Open, or Cancel.

Return to Top

Blogs

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	A unique numeric identifier for the blog.
AdminGraphqlApiId	String	True	No	Displays the Admin Graphql API id.
Commentable	String	False	No	Indicates whether readers can post comments to the blog and if comments are moderated or not.
CreatedAt	Datetime	True	No	The date and time when the blog was created.
Feedburner	String	False	No	Feedburner is a web feed management provider and can be enabled to provide custom RSS feeds for Shopify bloggers. This property will default to blank or null unless feedburner is enabled through the shop admin.
FeedburnerLocation	String	False	No	URL to the feedburner location for blogs that have enabled feedburner through their store admin. This property will default to blank or null unless feedburner is enabled through the shop admin.
Handle	String	False	No	A human-friendly unique string for a blog automatically generated from its title.
Metafields	String	False	No	Attaches additional metadata to a store's resources.
Tags	String	False	No	Tags are additional short descriptors formatted as a string of comma-separated values.
TemplateSuffix	String	False	No	States the name of the template a blog is using if it is using an alternate template. If a blog is using the default blog.liquid template, the value returned is null.
Title	String	False	No	The title of the blog.
UpdatedAt	Datetime	True	No	The date and time when changes were last made to the blog's properties.

Return to Top

CarrierServices

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The ID of the carrier service.
Active	Bool	False	No	Whether this carrier service is active. If true, then the service will be available to serve rates in checkout.
Name	String	False	No	The name of the shipping service as seen by merchants and their customers.
CallbackUrl	String	False	No	The URL endpoint that Shopify needs to retrieve shipping rates. This must be a public URL.
Type	String	False	No	Distinguishes between API or legacy carrier services.
Format	String	False	No	The format of the data returned by the URL endpoint. json is the only valid value.
ServiceDiscovery	String	False	No	Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples.
AdminGraphqlApiId	String	False	No	The GraphQL GID for this carrier service.

Return to Top

CollectionListings

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False	CustomCollections.Id	No	The Id of the collection this listing belongs to.
Title	String	True		No	The titke of the collection listing.
BodyHtml	String	True		No	The HTML body/description for this listing.
DefaultProductImage	String	True		No	The default product image in this listing.
ImageCreatedAt	String	True		No	The date and time the image for this listing was created at.
ImageSource	String	True		No	The source/link of the image for this listing.
Handle	String	True		No	The handle of this listing.
UpdatedAt	Datetime	True		No	The date and time when the collection listing was last modified.
PublishedAt	Datetime	True		No	The date and time when the collection listing was created.

Return to Top

Collects

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the collect.
CollectionId	Long	False	CustomCollections.Id	No	The Id of the collection this collection is linked with.
ProductId	Long	False		No	The Id of the product this collection is linked with.
Position	Int	True		No	The position of this product in a manually sorted custom collection. The first position is 1. This value is applied only when the custom collection is sorted manually.
SortValue	String	True		No	This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable.
CreatedAt	Datetime	True		No	The date and time when the collect was created.
UpdatedAt	Datetime	True		No	The date and time when the collect was last modified.

Return to Top

Comments

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the comment.
BlogId	Long	False	Blogs.Id	No	A unique numeric identifier for the blog containing the article that the comment belongs to.
ArticleId	Long	False	Articles.Id	No	A unique numeric identifier for the article that the comment belongs to.
Author	String	False		No	The name of the author of the comment.
Body	String	False		No	The basic Textile markup of a comment.
BodyHtml	String	False		No	The text of the comment, complete with HTML markup.
CreatedAt	Datetime	True		No	The date and time (ISO 8601 format) when the comment was created.
Email	String	False		No	The email address of the author of the comment.
Ip	String	False		No	The IP address from which the comment was posted.
PublishedAt	String	False		No	The date and time (ISO 8601 format) when the comment was published.
Status	String	True		No	The status of the comment.
UpdatedAt	Datetime	True		No	The date and time (ISO 8601 format) when the comment was last modified.
UserAgent	String	False		No	The user agent string provided by the software used to create the comment.
PublishedStatus	String	False		No	Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any.

Return to Top

CustomCollections

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	A unique numeric identifier for the custom collection.
Title	String	False	No	The title of the custom collection.
BodyHtml	String	False	No	The body/description of the custom collection.
Image	String	False	No	A JSON aggregate with information regarding the image of custom collection.
Metafields	String	False	No	Attaches additional metadata to a shop's resources: key: An identifier for the metafield. (maximum: 30 characters), namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters), value: Information to be stored as metadata, value_type: The information type being stored. Valid values: string or integer, description (optional): Additional information about the metafield .
Handle	String	False	No	A human-friendly unique string for the custom collection automatically generated from its title.
SortOrder	String	False	No	The order in which products in the custom collection appear.
TemplateSuffix	String	False	No	The suffix of the liquid template being used.
PublishedScope	String	False	No	The sales channels in which the custom collection is visible.
UpdatedAt	Datetime	True	No	The date and time when the custom collection was last modified.
PublishedAt	Datetime	True	No	The date and time when the custom collection was published to the Online Store channel.
ProductId	String	False	No	Show custom collections that include a given product.
PublishedStatus	String	False	No	Show custom collection with a given published status: published: show only published custom collections, unpublished: show only unpublished custom collections, any: show custom collections of any published status. (default: any).

Return to Top

CustomerAddresses

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the address.
CustomerId [KEY]	Long	False	Customers.Id	No	A unique numeric identifier for the customer.
CustomerUpdatedAt	Datetime	True		No	The date and time when the customer information was last updated.
Name	String	False		No	The customer's name.
FirstName	String	False		No	The customer's first name.
LastName	String	False		No	The customer's last name.
Company	String	False		No	The customer's company.
Address1	String	False		No	The customer's mailing address.
Address2	String	False		No	An additional field for the customer's mailing address.
City	String	False		No	The customer's city.
Province	String	False		No	The customer's province or state name.
Country	String	False		No	The customer's country.
Zip	String	False		No	The customer's zip or postal code.
Phone	String	False		No	The customer's phone number for this mailing address.
ProvinceCode	String	False		No	The two-letter pcode for the customer's province or state.
CountryCode	String	False		No	The two-letter country code corresponding to the customer's country.
CountryName	String	False		No	The customer's normalized country name.
Default	Bool	True		No	Indicates whether this address is the default address for the customer.

Return to Top

Customers

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the customer.
LastOrderId	Long	True	Orders.Id	No	The id of the customer's last order.
LastOrderName	String	True		No	The name of the customer's last order.
FirstName	String	False		No	The customer's first name.
LastName	String	False		No	The customer's last name.
Email	String	False		No	The unique email address of the customer.
Phone	String	False		No	The unique phone number for this customer.
TaxExempt	Bool	False		No	Indicates whether the customer should be charged taxes when placing orders.
TotalSpent	Decimal	True		No	The total amount of money that the customer has spent at the shop.
OrdersCount	Int	True		No	The number of orders associated with this customer.
MultipassIdentifier	String	True		No	The customer's identifier used with Multipass login.
Note	String	False		No	A note about the customer.
EmailMarketingState	String	False		No	The current email marketing state for the customer.
EmailMarketingLevel	String	False		No	The marketing subscription opt-in level.
EmailMarketingUpdatedAt	Datetime	False		No	The date and time when the customer consented to receive marketing material by email.
State	String	True		No	The state of the customer's account in a shop.
Tags	String	False		No	The tags for this customer. Separate with comma for multiple tags.
VerifiedEmail	Bool	True		No	States whether or not the email address has been verified.
CreatedAt	Datetime	True		No	The date and time when the customer was created.
UpdatedAt	Datetime	True		No	The date and time when the customer information was updated.
Password	String	False		Yes	Password of the customer.
PasswordConfirmation	String	False		Yes	Password confirmation of the customer.
SendEmailWelcome	Bool	False		Yes	Whether to send a welcome email to the customer or not.
SendEmailInvite	Bool	False		Yes	Whether to send an invite email to the customer or not.

Return to Top

DiscountApplications

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	Long	False	Orders.Id	No	The id of the order.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.
Type	String	False		No	The name of the note attribute.
Title	String	False		No	The value of the note attribute.
Description	String	False		No	The value of the note attribute.
Value	String	False		No	The value of the note attribute.
ValueType	String	False		No	The value of the note attribute.
AllocationMethod	String	False		No	The value of the note attribute.
TargetSelection	String	False		No	The value of the note attribute.
TargetType	String	False		No	The value of the note attribute.

Return to Top

DiscountCodes

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the discount code.
PriceRuleId [KEY]	Long	False	PriceRules.Id	No	The Id for the price rule that this discount code belongs to.
Code	String	False		No	The case-insensitive discount code that customers use at checkout.
UsageCount	Int	True		No	The number of times that the discount code has been redeemed.
CreatedAt	Datetime	True		No	The date and time when the discount code was created.
UpdatedAt	Datetime	True		No	The date and time when the discount code was last modified.

Return to Top

DraftOrderItemProperties

Name	Type	ReadOnly	References	FilterOnly	Description
ItemId	Long	False	DraftOrderItems.ItemId	No	The id of the order item.
DraftOrderId	Long	False	DraftOrders.Id	No	The id of the draft.
Name	String	False		No	The name of the item property.
Value	String	False		No	The value of the item property.

Return to Top

DraftOrderItems

Name	Type	ReadOnly	References	FilterOnly	Description
ItemId [KEY]	Long	False		No	The id of the line item.
DraftOrderId	Long	False	DraftOrders.Id	No	The id of the draft.
ProductId	Long	False		No	The ID of the product corresponding to the line item product variant.
Custom	Bool	False		No	States whether this is a custom line item or a product variant line item
FulfillableQuantity	Int	False		No	The amount available to fulfill.
FulFillmentsService	String	False		No	Service provider responsible for fulfillment.
ItemGrams	Int	False		No	The weight of the item in grams.
ItemPrice	Decimal	False		No	The price of the item before discounts have been applied.
ItemQuantity	Int	False		No	The number of products that were purchased.
RequiresShipping	Bool	False		No	States whether or not the fulfillment requires shipping.
SKU	String	False		No	A unique identifier of the item in the fulfillment.
ItemTitle	String	False		No	The title of the product or variant.
ItemVariantId	Long	False		No	The id of the product variant.
VariantTitle	String	False		No	The title of the product variant.
Vendor	String	False		No	The name of the supplier of the item.
Name	String	False		No	The name of the product variant.
GiftCard	Bool	False		No	States whether or not the product is a gift card.
Properties	String	False		No	Shows custom properties for this order item.
Taxable	Bool	False		No	States whether or not the product was taxable.
TaxLines	String	False		No	Shows tax lines for this order item.
AppliedDiscountTitle	String	False		No	The title of the applied discount for this order. Only available for draft orders.
AppliedDiscountDescription	String	False		No	The description of the applied discount for order. Only available for draft orders.
AppliedDiscountValue	Decimal	False		No	The value of the applied discount for this order. Only available for draft orders.
AppliedDiscountValueType	String	False		No	The value type of the applied discount for order. Only available for draft orders.
AppliedDiscountAmount	Decimal	False		No	The amount of the applied discount for this order. Only available for draft orders.

Return to Top

DraftOrderItemTaxLines

Name	Type	ReadOnly	References	FilterOnly	Description
LineNumber [KEY]	Long	False		No	A unique numeric identifier for the table.
ItemId	Long	False	DraftOrderItems.ItemId	No	The id of the draft line item.
DraftOrderId	Long	False	DraftOrders.Id	No	The id of the draft.
TaxTitle	String	False		No	The name of the tax.
TaxRate	Decimal	False		No	The rate of tax to be applied.
TaxPrice	Decimal	False		No	The amount of tax to be charged.

Return to Top

DraftOrders

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the order.
CustomerId	Long	False	Customers.Id	No	A unique numeric identifier for the customer.
Currency	String	False		No	The three letter code (ISO 4217) for the currency used for the payment.
Email	String	False		No	The customer's email address.
Name	String	True		No	The customer's order name as represented by a number.
TotalPrice	Decimal	True		No	The sum of all the prices of all the items in the order, taxes and discounts included.
SubtotalPrice	Decimal	True		No	Price of the order before shipping and taxes.
TotalTax	Decimal	False		No	The sum of all the taxes applied to the order.
TaxesIncluded	Bool	False		No	States whether or not taxes are included in the order subtotal.
InvoiceSentAt	Datetime	True		No	This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders.
Note	String	False		No	The text of an optional note that a shop owner can attach to the order.
Tags	String	False		No	Additional short descriptors.
InvoiceUrl	String	True		No	The URL for the invoice. Only available for draft orders.
TaxExempt	Bool	True		No	States whether or not taxes are exempt for this order. Only available for draft orders.
Status	String	True		No	The status of the order. Valid values are: open (all open orders), invoice_sent (only closed orders), and completed (cancelled orders). Defaults to 'open'.
LineAggregate	String	False		No	A JSON aggregate of line items associated with the draft order.
BillingAddressFirstName	String	False		No	The first name of the person associated with the payment method.
BillingAddressLastName	String	False		No	The last name of the person associated with the payment method.
BillingAddressAddress1	String	False		No	The street address of the billing address.
BillingAddressAddress2	String	False		No	An optional additional field for the street address of the billing address.
BillingAddressPhone	String	False		No	The phone number at the billing address.
BillingAddressCity	String	False		No	The city of the billing address.
BillingAddressCompany	String	False		No	The company of the person associated with the billing address.
BillingAddressZip	String	False		No	The zip or postal code of the billing address.
BillingAddressProvince	String	False		No	The name of the state or province of the billing address.
BillingAddressCountry	String	False		No	The name of the country of the billing address.
BillingAddressLatitude	Double	False		No	The latitude of the billing address.
BillingAddressLongitude	Double	False		No	The longitude of the billing address.
BillingAddressName	String	False		No	The full name of the person associated with the payment method.
BillingAddressCountryCode	String	False		No	The two-letter code for the country of the billing address.
BillingAddressProvinceCode	String	False		No	The two-letter abbreviation of the state or province of the billing address.
BillingAddressDefault	Bool	False		No	Whether this address is the default one or not.
ShippingAddressFirstName	String	False		No	The first name of the person associated with the shipping method.
ShippingAddressLastName	String	False		No	The last name of the person associated with the shipping method.
ShippingAddressAddress1	String	False		No	The street address of the shipping address.
ShippingAddressAddress2	String	False		No	An optional additional field for the street address of the shipping address.
ShippingAddressPhone	String	False		No	The phone number at the shipping address.
ShippingAddressCity	String	False		No	The city of the shipping address.
ShippingAddressCompany	String	False		No	The company of the person associated with the shipping address.
ShippingAddressZip	String	False		No	The zip or postal code of the shipping address.
ShippingAddressProvince	String	False		No	The name of the state or province of the shipping address.
ShippingAddressCountry	String	False		No	The name of the country of the shipping address.
ShippingAddressLatitude	Double	False		No	The latitude of the shipping address.
ShippingAddressLongitude	Double	False		No	The longitude of the shipping address.
ShippingAddressName	String	False		No	The full name of the person associated with the shipping method.
ShippingAddressCountryCode	String	False		No	The two-letter code for the country of the shipping address.
ShippingAddressProvinceCode	String	False		No	The two-letter abbreviation of the state or province of the shipping address.
ShippingAddressDefault	Bool	False		No	Whether this address is the default one or not.
AppliedDiscountTitle	String	False		No	The title of the applied discount for this order. Only available for draft orders.
AppliedDiscountDescription	String	False		No	The description of the applied discount for order. Only available for draft orders.
AppliedDiscountValue	Decimal	False		No	The value of the applied discount for this order. Only available for draft orders.
AppliedDiscountValueType	String	False		No	The value type of the applied discount for order. Only available for draft orders.
AppliedDiscountAmount	Decimal	False		No	The amount of the applied discount for this order. Only available for draft orders.
CreatedAt	Datetime	True		No	The date and time when the order was created.
UpdatedAt	Datetime	True		No	The date and time when the order was last modified.
CompletedAt	Datetime	True		No	The date and time when the order was completed at.
UseCustomerDefaultAddress	Bool	False		Yes	Optional boolean that you can send as part of a draft order object to load customer shipping information. Valid values: true or false.

Return to Top

Events

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The ID of the event.
Description	String	False	No	A human readable description of the event.
Message	String	False	No	A human readable description of the event. Can contain some HTML formatting.
Body	String	False	No	A text field containing information about the event.
Path	String	False	No	A relative URL to the resource the event is for, if applicable.
SubjectId	Long	False	No	The ID of the resource that generated the event.
SubjectType	String	False	No	he type of the resource that generated the event. Valid values: Article, Blog, Collection, Comment, Order, Page, Product, ApiPermission.
Verb	String	False	No	The type of event that occurred. Different resources generate different types of event.
Author	String	False	No	The author of the event.
Arguments	String	False	No	Refers to a certain event and its resources.
CreatedAt	Datetime	False	No	The date and time when the event was created.
OrderId	Long	False	Yes	The ID of the Order to retrieve events from.

Return to Top

FulfillmentEvents

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A numeric unique identifier for the fulfillment event.
OrderId [KEY]	Long	False	Orders.Id	No	The id of the order the fulfillment event belongs to.
FulfillmentId [KEY]	Long	False	Fulfillments.Id	No	A numeric unique identifier for the fulfillment to which the fulfillment event belongs.
ShopId	Long	True	Shop.Id	No	A numeric unique identifier for the shop to which the fulfillment event belongs.
Status	String	False		No	The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure.
EstimatedDeliveryAt	Datetime	False		No	The status of the fulfillment event. Valid values are: confirmed, in_transit, out_for_delivery, delivered, failure.
Message	String	False		No	An arbitrary message describing the status. Can be provided by a shipping carrier.
City	String	False		No	The city in which the fulfillment event occurred.
Province	String	False		No	The province in which the fulfillment event occurred.
Zip	String	False		No	The zip code in the location in which the fulfillment event occurred.
Country	String	False		No	The country in which the fulfillment event occurred.
Address1	String	False		No	The fulfillment event's street address.
Latitude	Double	False		No	Geographic coordinate specifying the north/south location of a fulfillment event.
Longitude	Double	False		No	Geographic coordinate specifying the east/west location of a fulfillment event.
CreatedAt	Datetime	True		No	The date and time when the fulfillment event was created.
UpdatedAt	Datetime	True		No	The date and time when the fulfillment event was updated.
HappenedAt	Datetime	True		No	The date and time when the fulfillment event occurred.

Return to Top

FulfillmentOrderLineItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	The ID of the fulfillment order line item.
ShopId	Long	False	Shop.Id	No	The ID of the shop associated with the fulfillment order line item.
FulfillmentOrderId	Long	False	FulfillmentOrders.Id	No	The ID of the fulfillment order associated with this line item.
OrderId	Long	False	Orders.Id	No	The ID of the order that's associated with the fulfillment order.
LineItemId	Long	False	OrdersItems.ItemId	No	The ID of the line item associated with this fulfillment order line item.
InventoryItemId	Long	False		No	The ID of the inventory item associated with this fulfillment order line item.
Quantity	Int	False		No	The total number of units to be fulfilled.
FulfillableQuantity	Int	False		No	The number of units remaining to be fulfilled.
VariantId	Long	False		No	The ID of the variant associated with this fulfillment order line item.
FinancialSummaries	String	False		No	The financial summary data for the line item.

Return to Top

FulfillmentOrders

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	An ID for the fulfillment order.
ShopId	Long	False	Shop.Id	No	The ID of the shop that's associated with the fulfillment order.
OrderId [KEY]	Long	False	Orders.Id	No	The ID of the order that's associated with the fulfillment order.
AssignedLocationId	Long	False		No	The ID of the location that has been assigned to do the work.
DestinationId	String	False		No	The ID of the fulfillment order 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.
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.
DestinationPhone	String	False		No	The phone number of the customer at the destination.
FullfillAt	Datetime	False		No	The datetime (in UTC) when the fulfillment order is ready for fulfillment.
LineItems	String	False		No	Represents line items belonging to a fulfillment order.
RequestStatus	String	False		No	The status of the fulfillment.
Status	String	False		No	The status of the fulfillment order.
SupportedActions	String	False		No	The actions that can be performed on this fulfillment order.
MerchantRequests	String	False		No	A list of requests sent by the merchant to the fulfillment service for this fulfillment order..
FulfillmentHolds	String	False		No	Represents the fulfillment holds applied on the fulfillment order.
InternationalDuties	String	False		No	The international duties relevant to the fulfillment order.
AssignedLocationAddress1	String	False		No	The street address of the assigned location
AssignedLocationAddress2	String	False		No	An optional additional field for the street address of the assigned location.
AssignedLocationCity	String	False		No	The city of the assigned location.
AssignedLocationCountryCode	String	False		No	The two-letter code for the country of the assigned location
AssignedLocationName	String	False		No	The name of the assigned location.
AssignedLocationPhone	String	False		No	The phone number of the assigned location.

Return to Top

Fulfillments

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the fulfillment.
OrderId	Long	False	Orders.Id	No	A unique numeric identifier for the order.
LocationId [KEY]	Long	False		No	A unique numeric identifier for the Location.
NotifyCustomer	Bool	False		No	A flag indicating whether the customer should be notified
Status	String	False		No	The status of the fulfillment.
Receipt	String	True		No	Provides information about the receipt of this fulfillment.
TrackingCompany	String	False		No	The name of the tracking company.
TrackingNumbers	String	False		No	A list of comma-separated tracking numbers, provided by the shipping company.
TrackingUrls	String	False		No	The sum of all the prices of all the items in the fulfillment.
VariantInventoryManagement	String	True		No	States the name of the inventory management service.
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.
LineAggregate	String	False		No	A JSON aggregate of line items associated with the fulfillment.
OrderUpdatedAt	Datetime	True		No	The date and time when the order was last modified.
OrderCreatedAt	Datetime	True		No	The date and time when the order was last created.
FulfillmentOrderId	Long	False	FulfillmentOrders.Id	No	The ID of the fulfillment order that is associated with the fulfillments.

Return to Top

FulfillmentServices

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the fulfillment service.
LocationId	Long	True	Locations.Id	No	The unique identifier of the location tied to the fulfillment service.
ProviderId	String	True		No	A unique identifier for the fulfillment service provider.
Name	String	False		No	The name of the fulfillment service as seen by merchants and their customers.
Handle	String	True		No	A human-friendly unique string for the fulfillment service generated from its title.
ServiceName	String	True		No	The name of the fulfillment service.
Email	String	False		No	The email of the fulfillment service.
IncludePendingStock	Bool	False		No	States if the fulfillment service includes a pending stock.
RequiresShippingMethod	Bool	False		No	States if the fulfillment service requires products to be physically shipped. Valid values are 'true' and 'false'.
TrackingSupport	Bool	False		No	States if the fulfillment service provides tracking numbers for packages. Valid values are
InventoryManagement	Bool	False		No	States if the fulfillment service tracks product inventory and provides updates to Shopify. Valid values are
FulfillmentOrdersOptIn	Bool	False		No	States if the fulfillment orders is opt in.
CallbackUrl	String	False		No	States the URL endpoint that Shopify needs to retrieve inventory and tracking updates. This field is necessary if either inventory_management or tracking_support is set to
Format	String	False		No	Specifies the format of the API output. Valid values are json and xml.

Return to Top

GiftCards

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The ID of the gift card.
APIClientId	Long	True		No	The ID of the client that issued the gift card.
Balance	Decimal	True		No	The balance of the gift card.
Code	String	False		No	The gift card code, which is a string of alphanumeric characters. For security reasons, this is available only upon creation of the gift card. (minimum: 8 characters, maximum: 20 characters)
CreatedAt	Datetime	True		No	The date and time (ISO 8601 format) when the gift card was created.
Currency	String	True		No	The currency of the gift card.
CustomerId	Long	True	Customers.Id	No	The ID of the customer associated with this gift card.
DisabledAt	Datetime	True		No	The date and time (ISO 8601 format) when the gift card was disabled.
ExpiresOn	Date	False		No	The date (YYYY-MM-DD format) when the gift card expires. Returns null if the gift card doesn't have an expiration date.
InitialValue	Decimal	False		No	The initial value of the gift card when it was created.
LastCharacters	String	True		No	The last four characters of the gift card code. Because gift cards are alternative payment methods, the full code cannot be retrieved.
LineItemId	Long	True	OrdersItems.ItemId	No	The ID of the line item that initiated the creation of this gift card, if it was created by an order.
Note	String	False		No	An optional note that a merchant can attach to the gift card that isn't visible to customers.
OrderId	Long	True	Orders.Id	No	The ID of the order that initiated the creation of this gift card, if it was created by an order.
TemplateSuffix	String	False		No	The suffix of the Liquid template that's used to render the gift card online. For example, if the value is birthday, then the gift card is rendered using the template gift_card.birthday.liquid. When the value is null, the default gift_card.liquid template is used.
UserId	Long	True	Users.Id	No	The ID of the user that issued the gift card, if it was issued by a user.
UpdatedAt	Datetime	True		No	The date and time (ISO 8601 format) when the gift card was last modified.

Return to Top

Locations

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The ID for the location.
Name	String	False	No	The name of the location.
Legacy	Bool	False	No	Whether this is a fulfillment service location. If true, then the location is a fulfillment service location. If false, then the location was created by the merchant and isn't tied to a fulfillment service.
Address1	String	False	No	The first line of the address.
Address2	String	False	No	The second line of the address.
City	String	False	No	The city the location is in.
Zip	String	False	No	The zip or postal code.
Province	String	False	No	The province the location is in.
Country	String	False	No	The country the location is in.
Phone	String	False	No	The phone number of the location. This value can contain special characters like - and +.
CountryCode	String	False	No	The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in.
CountryName	String	False	No	The name of the country the location is in.
CreatedAt	Datetime	False	No	The date and time when the location was created.
UpdatedAt	Datetime	False	No	The date and time when the location was last updated.
DeletedAt	Datetime	False	No	The date and time when the location was deleted.

Return to Top

MarketingEvents

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	A unique numeric identifier for the marketing event.
RemoteId	String	False	No	An optional remote identifier for a marketing event.
BreadcrumbId	String	True	No	An optional identifier for the breadcrumb of a marketing event.
UTMCampaign	String	True	No	A unique name for the UTM campaign.
UTMSource	String	True	No	The source of the UTM campaign.
UTMMedium	String	True	No	The medium of the UTM campaign.
UTMContent	String	True	No	The content of the UTM campaign.
UTMTerm	String	True	No	The term of the UTM campaign.
EventTarget	String	True	No	The target of the event.
Description	String	True	No	A description for the marketing event.
MarketingChannel	String	False	No	A broader marketing event type that is focused only on the channel. Must be one of the allowed values (`search`, `display`, `social`, `email`, `referral`).
EventType	String	False	No	The specific type of marketing event. Must be one of the allowed values (`ad`, `post`, `message`, `retargeting`, `transactional`, `affiliate`, `loyalty`, `newsletter`, `abandoned_cart`, `receipt`).
Budget	Decimal	False	No	The budget of the ad campaign.
Paid	Bool	False	No	A boolean field to specify whether this event is paid or organic.
BudgetType	String	False	No	The type of the budget; must be either `daily` or `lifetime`.
Currency	String	False	No	The currency for the budget.
ManageUrl	String	True	No	A link to manage the marketing event, generally in the Shopify app's interface.
PreviewUrl	String	True	No	A link to view the live version of the post/ad, or to view a rendered preview of the post/ad/email in the Shopify app.
ReferringDomain	String	False	No	The destination domain of the marketing event. Required unless MarketingChannel is one of email/referral/display.
MarketedResources	String	True	No	A list of the items that were marketed in the marketing event. It's a list of dictionaries with type keys and id keys. Valid values for type are: (`product`, `collection`, `price_rule`, `page`, `article`, `homepage`). All types, other than homepage, also require an id.
StartedAt	Datetime	False	No	The timestamp when the marketing action was started, or when the email was sent, or when the Facebook post was made live, etc.
EndedAt	Datetime	False	No	For events with a duration, when the event actually ended. This may differ from ScheduledToEndAt, if the ad was stopped early, etc.
ScheduledToEndAt	Datetime	False	No	For events with a duration, when the event was supposed to end.

Return to Top

Metafields

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The unique ID of the metafield.
Namespace	String	False	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	False	No	The name of the metafield.
Value	String	False	No	The information to be stored as metadata.
Type	String	False	No	The metafield's information type.
Description	String	False	No	A description of the information that the metafield contains.
OwnerId	Long	False	No	The unique ID of the resource that the metafield is attached to.
OwnerResource	String	False	No	The type of resource that the metafield is attached to.
CreatedAt	Datetime	True	No	The date and time (ISO 8601 format) when the metafield was created.
UpdatedAt	Datetime	True	No	The date and time (ISO 8601 format) when the metafield was last updated.
AdminGraphqlApiId	String	True	No	The admin graphql api id

Return to Top

NoteAttributes

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId	Long	False	Orders.Id	No	The id of the order.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.
Name	String	False		No	The name of the note attribute.
Value	String	False		No	The value of the note attribute.

Return to Top

OrderDiscountCodes

Name	Type	ReadOnly	References	FilterOnly	Description
OrderId [KEY]	Long	False	Orders.Id	No	The id of the order.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.
Code [KEY]	String	False		No	The name of the note attribute.
Amount	String	False		No	The value of the note attribute.
Type	String	False		No	The value of the note attribute.

Return to Top

OrderItemDiscountAllocations

Name	Type	ReadOnly	References	FilterOnly	Description
LineNumber [KEY]	Long	False		No	A unique numeric identifier for the table.
ItemId	Long	False	OrdersItems.ItemId	No	The id of the order item. Only available for orders.
OrderId	Long	False	Orders.Id	No	The id of the order.
amount	String	False		No	The Amount of the item discount allocations.
ApplicationIndex	Int	False		No	The ApplicationIndex of the item discount allocations.
ShopMoneyAmount	Decimal	False		No	The ShopMoneyAmount of the item discount allocations.
ShopMoneyCurrencyCode	String	False		No	The ShopMoneyCurrencyCode of the item discount allocations.
PresentmentMoneyAmount	Decimal	False		No	The PresentmentMoneyAmount of the item discount allocations.
PresentmentMoneyCurrencyCode	String	False		No	The PresentmentMoneyCurrencyCode of the item discount allocations.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.

Return to Top

OrderItemProperties

Name	Type	ReadOnly	References	FilterOnly	Description
LineNumber [KEY]	Long	False		No	A unique numeric identifier for the table.
ItemId	Long	False	OrdersItems.ItemId	No	The id of the order item. Only available for orders.
OrderId	Long	False	Orders.Id	No	The id of the order.
Name	String	False		No	The name of the item property.
Value	String	False		No	The value of the item property.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.

Return to Top

Orders

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the order.
Number	Long	True		No	A unique identifier for the order, used by the shop owner and customer.
CustomerId	Long	False	Customers.Id	No	A unique numeric identifier for the customer.
CustomerFirstName	String	False		No	The first name of the customer.
CustomerLastName	String	False		No	The last name of the customer.
Currency	String	False		No	The three letter code (ISO 4217) for the currency used for the payment.
Email	String	False		No	The customer's email address.
Name	String	True		No	The customer's order name as represented by a number.
TotalDiscounts	Decimal	True		No	The total amount of the discounts to be applied to the price of the order.
TotalOrderItemsPrice	Decimal	True		No	The sum of all the prices of all the items in the order.
TotalPrice	Decimal	True		No	The sum of all the prices of all the items in the order, taxes and discounts included.
SubtotalPrice	Decimal	True		No	Price of the order before shipping and taxes.
TotalTax	Decimal	False		No	The sum of all the taxes applied to the order.
TotalWeight	Int	True		No	The sum of all the weights of the line items in the order, in grams.
BrowserIp	String	True		No	The IP address of the browser used by the customer when placing the order.
BuyerAcceptsMarketing	Bool	False		No	Indicates whether or not the person who placed the order would like to receive email updates from the shop.
CancelReason	String	True		No	The reason why the order was canceled.
CartToken	String	True		No	Unique identifier for a particular cart that is attached to a particular order.
OrderStatusUrl	String	True		No	The URL pointing to the order status web page.
Token	String	True		No	Unique identifier for a particular order.
TaxesIncluded	Bool	False		No	States whether or not taxes are included in the order subtotal.
SourceName	String	True		No	Where the order originated.
ReferringSite	String	True		No	The website that the customer clicked on to come to the shop.
Phone	String	False		No	The customer's phone number.
Note	String	False		No	The text of an optional note that a shop owner can attach to the order.
LocationId	Long	True		No	The unique numeric identifier for the physical location at which the order was processed.
LandingSite	String	True		No	The URL for the page where the buyer landed when entering the shop.
Tags	String	False		No	Additional short descriptors.
FulfillmentStatus	String	False		No	The fulfillment status of the order. Valid values during SELECT: shipped, partial, unshipped, any, unfulfilled. Valid values during INSERT: fulfilled, null, partial, restocked.
FinancialStatus	String	False		No	The financial status of the order. Valid values during SELECT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid. Valid values during INSERT: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded.
CustomerLocale	String	True		No	The customer locale of the order.
InvoiceSentAt	Datetime	True		No	This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders.
InvoiceUrl	String	True		No	The URL for the invoice. Only available for draft orders.
TaxExempt	Bool	True		No	States whether or not taxes are exempt for this order. Only available for draft orders.
DiscountCodes	String	True		No	Applicable discount codes that can be applied to the order.
LineAggregate	String	False		No	A JSON aggregate of line items associated with the order.
TaxAggregate	String	False		No	A JSON aggregate of tax line items associated with the order. Note, these taxes are applied on the order, not on individual items. If you want them to be applied on individual items, use them in LineAggregate. Tax lines must be associated with either order or line item but not both.
ShippingAggregate	String	False		No	A JSON aggregate of shipping line items associated with the order.
NoteAttributesAggregate	String	False		No	A JSON aggregate of note attributes associated with the order.
DiscountApplicationsAggregate	String	True		No	An ordered list of stacked discount applications.
BillingAddressFirstName	String	False		No	The first name of the person associated with the payment method.
BillingAddressLastName	String	False		No	The last name of the person associated with the payment method.
BillingAddressAddress1	String	False		No	The street address of the billing address.
BillingAddressAddress2	String	False		No	An optional additional field for the street address of the billing address.
BillingAddressPhone	String	False		No	The phone number at the billing address.
BillingAddressCity	String	False		No	The city of the billing address.
BillingAddressCompany	String	False		No	The company of the person associated with the billing address.
BillingAddressZip	String	False		No	The zip or postal code of the billing address.
BillingAddressProvince	String	False		No	The name of the state or province of the billing address.
BillingAddressCountry	String	False		No	The name of the country of the billing address.
BillingAddressLatitude	Double	False		No	The latitude of the billing address.
BillingAddressLongitude	Double	False		No	The longitude of the billing address.
BillingAddressName	String	False		No	The full name of the person associated with the payment method.
BillingAddressCountryCode	String	False		No	The two-letter code for the country of the billing address.
BillingAddressProvinceCode	String	False		No	The two-letter abbreviation of the state or province of the billing address.
BillingAddressDefault	Bool	False		No	Whether this address is the default one or not.
ShippingAddressFirstName	String	False		No	The first name of the person associated with the shipping method.
ShippingAddressLastName	String	False		No	The last name of the person associated with the shipping method.
ShippingAddressAddress1	String	False		No	The street address of the shipping address.
ShippingAddressAddress2	String	False		No	An optional additional field for the street address of the shipping address.
ShippingAddressPhone	String	False		No	The phone number at the shipping address.
ShippingAddressCity	String	False		No	The city of the shipping address.
ShippingAddressCompany	String	False		No	The company of the person associated with the shipping address.
ShippingAddressZip	String	False		No	The zip or postal code of the shipping address.
ShippingAddressProvince	String	False		No	The name of the state or province of the shipping address.
ShippingAddressCountry	String	False		No	The name of the country of the shipping address.
ShippingAddressLatitude	Double	False		No	The latitude of the shipping address.
ShippingAddressLongitude	Double	False		No	The longitude of the shipping address.
ShippingAddressName	String	False		No	The full name of the person associated with the shipping method.
ShippingAddressCountryCode	String	False		No	The two-letter code for the country of the shipping address.
ShippingAddressProvinceCode	String	False		No	The two-letter abbreviation of the state or province of the shipping address.
ShippingAddressDefault	Bool	False		No	Whether this address is the default one or not.
AppliedDiscountTitle	String	False		No	The title of the applied discount for this order. Only available for draft orders.
AppliedDiscountDescription	String	False		No	The description of the applied discount for order. Only available for draft orders.
AppliedDiscountValue	Decimal	False		No	The value of the applied discount for this order. Only available for draft orders.
AppliedDiscountValueType	String	False		No	The value type of the applied discount for order. Only available for draft orders.
AppliedDiscountAmount	Decimal	False		No	The amount of the applied discount for this order. Only available for draft orders.
PaymentTermsAmount	Long	True		No	The amount that is owed according to the payment terms.
PaymentTermsCurrency	String	True		No	The presentment currency for the payment.
PaymentTermsPaymentTermsName	String	True		No	The name of the selected payment terms template for the order.
PaymentTermsPaymentTermsType	String	True		No	The type of selected payment terms template for the order.
PaymentTermsDueInDays	Int	True		No	The number of days between the invoice date and due date that is defined in the selected payment terms template.
PaymentTermsPaymentSchedules	String	True		No	An array of schedules associated to the payment terms.
ProcessedAt	Datetime	True		No	The date and time when the order was imported, in ISO 8601 format.
CreatedAt	Datetime	True		No	The date and time when the order was created.
ClosedAt	Datetime	True		No	The date and time when the order was closed.
CancelledAt	Datetime	True		No	The date and time when the order was canceled.
UpdatedAt	Datetime	True		No	The date and time when the order was last modified.
SendReceipt	Bool	False		No	Determines whether an order confirmation will be sent to the customer.
SendFulfillmentReceipt	Bool	False		No	Determines whether a fulfillment confirmation will be sent to the customer.
InventoryBehaviour	String	False		No	Determines which inventory updating behavior is used. The following values are available: default, decrement_ignoring_policy, decrementobeying_policy
Operation	String	False		No	An operation to apply to the Order. Valid values for order: Close, Open, or Cancel.
TotalShippingPriceSetShopMoneyAmount	Double	True		No	The amount of the shop money in the total shipping price set.
TotalShippingPriceSetShopMoneyCurrencyCode	String	True		No	The currency code of the shop money in the total shipping price set.
TotalShippingPriceSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the total shipping price set.
TotalPriceSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the total price set.
TotalPriceSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the total price set.
TotalTaxSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the total tax set.
TotalTaxSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the total tax set.
CheckoutId	Long	True		No	The checkout id.
CheckoutToken	String	True		No	A unique value when referencing the checkout that's associated with the order.
EstimatedTaxes	Bool	True		No	Estimated taxes of the order.
Test	Bool	True		No	Test boolean for the order.
TotalOutstanding	Decimal	True		No	The outstanding sum of all the items in the order.
TotalTipReceived	Decimal	True		No	The total tip for the order.
PresentmentCurrency	String	True		No	The currency code of the presentment money.
TotalLineItemsPriceSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the total line items price set.
TotalLineItemsPriceSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the total line items price set.
TotalDiscountsSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the discounts set.
TotalDiscountsSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the discounts set.
TotalSubtotalSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the subtotal.
TotalSubtotalSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the subtotal.
OrigTotalAdditionalFeesSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the original total additional fees set.
OrigTotalAdditionalFeesSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the original total additional fees set.
CurTotalDiscountsSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the current total discounts set.
CurTotalDiscountsSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the current total discounts set.
CurSubtotalPriceSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the current subtotal price set.
CurSubtotalPriceSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the current subtotal price set.
CurrentTotalTaxSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the current total tax set.
CurrentTotalTaxSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the current total tax set.
CurTotalAdditionalFeesSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the current total additional fees set.
CurTotalAdditionalFeesSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the current total additional fees set.
CurrentTotalPriceSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the current total price set.
CurrentTotalPriceSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the current total price set.
OriginalTotalDutiesSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the original total duties set.
OriginalTotalDutiesSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the original total duties set.
CurrentTotalDutiesSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the current total duties set.
CurrentTotalDutiesSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the current total duties set.
PaymentGatewayNames	String	True		No	The list of payment gateway names
FulfillmentAggregate	String	True		No	A JSON aggregate of fulfillments associated with the order. Note, these fulfillments are applied on the order, not on individual items.
RefundAggregate	String	True		No	A JSON aggregate of refunds associated with the order. Note, these refunds are applied on the order, not on individual items.
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. This value isn't guaranteed to be unique.
Status	String	False		Yes	Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open.

Return to Top

OrdersItems

Name	Type	ReadOnly	References	FilterOnly	Description
ItemId [KEY]	Long	False		No	The id of the order item. Only available for orders.
OrderId	Long	False	Orders.Id	No	The id of the order.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.
ProductId	Long	False		No	The id of the of the product beloning to the order item.
ItemVariantId	Long	False		No	The id of the product variant.
ItemTitle	String	False		No	The title of the product.
Name	String	False		No	The name of the product variant.
ItemQuantity	Int	False		No	The number of products that were purchased.
ItemPrice	Decimal	False		No	The price of the item before discounts have been applied.
ItemGrams	Int	False		No	The weight of the item in grams.
SKU	String	False		No	A unique identifier of the item in the fulfillment.
VariantTitle	String	False		No	The title of the product variant.
Properties	String	False		No	Shows custom properties for this order item.
Vendor	String	False		No	The name of the supplier of the item.
FulFillmentsService	String	False		No	Service provider who is doing the fulfillment.
RequiresShipping	Bool	False		No	States whether or not the fulfillment requires shipping.
Taxable	Bool	False		No	States whether or not the product was taxable.
GiftCard	Bool	False		No	States whether or not the order item is a gift card.
CurrentQuantity	Int	False		No	The line item's current quantity after removals.
FulfillableQuantity	Int	False		No	The amount available to fulfill.
TotalDiscount	Decimal	False		No	The total discount amount applied to this order item.
FulfillmentStatus	String	False		No	How far along an order is in terms order items fulfilled.
AppliedDiscountTitle	String	False		No	The title of the applied discount for this order. Only available for draft orders.
AppliedDiscountDescription	String	False		No	The description of the applied discount for order. Only available for draft orders.
AppliedDiscountValue	Decimal	False		No	The value of the applied discount for this order. Only available for draft orders.
AppliedDiscountValueType	String	False		No	The value type of the applied discount for order. Only available for draft orders.
AppliedDiscountAmount	Decimal	False		No	The amount of the applied discount for this order. Only available for draft orders.
Type	String	False		Yes	The type of order item, can be one of the following(Order, DraftOrder, AbandonedCheckout).
Status	String	False		Yes	Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open.

Return to Top

OrderTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	A unique numeric identifier for the transaction.
OrderId	Long	False	Orders.Id	No	A unique numeric identifier for the order.
UserId	Long	True		No	The unique identifier for the user.
LocationId	Long	True		No	The ID of the physical location where the transaction was processed.
Amount	Decimal	False		No	The amount of money that the transaction was for.
Authorization	String	False		No	The authorization code associated with the transaction.
Currency	String	False		No	The three letter code (ISO 4217) for the currency used for the payment.
DeviceId	String	True		No	The unique identifier for the device.
Gateway	String	False		No	The name of the gateway the transaction was issued through.
SourceName	String	True		No	The origin of the transaction.
Kind	String	False		No	The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund.
Message	String	True		No	The message associated with this transaction.
ErrorCode	String	True		No	A standardized error code, independent of the payment provider.
Status	String	False		No	The status of the transaction.
Test	Bool	True		No	The option to use the transaction for testing purposes.
AVSResultCode	String	True		No	The Response code from the address verification system.
CreditCardBin	String	True		No	The issuer identification number (IIN).
CVVResultCode	String	True		No	The Response code from the credit card company.
CreditCardNumber	String	True		No	The customer's credit card number, with most of the leading digits redacted with Xs.
CreditCardCompany	String	True		No	The name of the company who issued the customer's credit card.
CreatedAt	Datetime	True		No	The date and time when the customer was created.
PaymentsRefundsAttributesStatus	String	True		No	The current status of the refund
PaymentsRefundsAttributesAcquirerReferenceNumber	String	True		No	A unique number associated with the transaction that can be used to track the refund.
PaymentId	String	True		No	The unique identifier for the payment.
ProcessedAt	Datetime	True		No	The date and time when the transaction was processed.
CreditCardName	String	True		No	The name on the customer's credit card.
CreditCardWallet	String	True		No	The wallet of the customer's credit card.
CreditCardExpMonth	Long	True		No	The expiration month of the customer's credit card.
CreditCardExpYear	Long	True		No	The expiration year of the customer's credit card.
Receipt	String	True		No	A JSON aggregate of the order receipt.
TotalUnsettledSetShopMoneyAmount	Decimal	True		No	The amount of the shop money in the total unsettled set.
TotalUnsettledSetPresentmentMoneyAmount	Decimal	True		No	The amount of the presentment money in the total unsettled set.
TransactionItemAmount	Decimal	False		Yes	The amount of money that the transaction was for. Use this when inserting transactions into an order or refund.
TransactionItemGateway	String	False		Yes	The name of the gateway the transaction was issued through. Use this when inserting transactions into an order or refund.
TransActionItemKind	String	False		Yes	The kind of transaction. Can be any of the following: Authorization, Capture, Sale, Void, Refund. Use this when inserting transactions into an order or refund.
TransactionItemStatus	String	False		Yes	The status of the transaction. Use this when inserting transactions into an order or refund.
TransactionItemParentId	String	False		Yes	The parent id of the transaction. Use this when inserting transactions into a refund.
TransactionItemSource	String	False		Yes	The status of the transaction.
UpdatedAt	Datetime	False		Yes	The last time the order is updated.

Return to Top

Pages

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The unique numeric identifier for the page.
AdminGraphqlApiId	String	True	No	Displays the Admin Graphql API id.
Author	String	False	No	The name of the person who created the page.
BodyHtml	String	False	No	The text content of the page, complete with HTML markup.
CreatedAt	Datetime	True	No	The date and time (ISO 8601 format) when the page was created.
Handle	String	False	No	A unique, human-friendly string for the page, generated automatically from its title. In online store themes, the Liquid templating language refers to a page by its handle.
Metafields	String	False	No	Additional information attached to the Page object.
PublishedAt	Datetime	False	No	The date and time (ISO 8601 format) when the page was published. Returns null when the page is hidden.
ShopId	Long	True	No	The ID of the shop to which the page belongs.
TemplateSuffix	String	False	No	The suffix of the Liquid template being used.
Title	String	False	No	The page's title.
UpdatedAt	Datetime	True	No	The date and time (ISO 8601 format) when the page was last updated.
PublishedStatus	String	False	No	Filter comments by their publish status. Valid values are: published, unpublished and any ; default: any.

Return to Top

Payouts

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The unique identifier of the payout.
Status	String	False	No	The transfer status of the payout.
Currency	String	False	No	The ISO 4217 currency code of the payout.
Amount	Decimal	False	No	The total amount of the payout, in a decimal formatted string.
Date	Datetime	False	No	The date the payout was issued.

Return to Top

PayoutTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	The unique identifier of the transaction.
Type	String	False		No	The type of the balance transaction.
Test	Bool	False		No	If the transaction was created for a test mode Order or payment.
PayoutId	Long	False	Payouts.Id	No	The id of the payout the transaction was paid out in.
PayoutStatus	String	False		No	The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout.
Currency	String	False		No	The ISO 4217 currency code of the transaction.
Amount	Decimal	False		No	The gross amount of the transaction, in a decimal formatted string.
Fee	Decimal	False		No	The total amount of fees deducted from the transaction amount.
Net	Decimal	False		No	The net amount of the transaction.
SourceId	Long	False		No	The id of the resource leading to the transaction.
SourceType	String	False		No	The type of the resource leading to the transaction.
SourceOrderTransactionId	String	False		No	The id of the Order Transaction that resulted in this balance transaction.
SourceOrderId	String	False		No	The id of the Order that this transaction ultimately originated from.
ProcessedAt	Datetime	False		No	The time the transaction was processed.
AdjustmentReason	String	True		No	The reason why an adjustment was made.

Return to Top

PayoutTransactionsAdjustmentOrderTransactions

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The unique identifier of the order transaction.
PayoutTransactionId	Long	False	No	The unique identifier of the transaction.
Amount	Decimal	False	No	Amount that is adjusted in this order transaction.
OrderId	Long	False	No	The order details for the order transaction. Order id.
OrderName	String	False	No	The order details for the order transaction. Order name.

Return to Top

PriceRules

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	A unique numeric identifier for the price rule.
AllocationMethod	String	False	No	The allocation method of the price rule. Valid values: each: The discount is applied to each of the entitled items. across: The calculated discount amount will be applied across the entitled items.
CustomerSelection	String	False	No	The customer selection for the price rule. Valid values: all: The price rule is valid for all customers. prerequisite: The customer must either belong to one of the customer saved searches specified by PrerequisiteSavedSearchIds.
EntitledCollectionIds	String	False	No	A list of Ids of collections whose products will be eligible to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled. It can't be used in combination with EntitledProductIds or EntitledVariantIds.
EntitledCountryIds	String	False	No	A list of Ids of shipping countries that will be entitled to the discount. It can be used only with TargetType set to shipping_line and TargetSelection set to entitled.
EntitledProductIds	String	False	No	A list of Ids of products that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled.
EntitledVariantIds	String	False	No	A list of Ids of product variants that will be entitled to the discount. It can be used only with TargetType set to line_item and TargetSelection set to entitled.
OncePerCustomer	Bool	False	No	Whether the generated discount code will be valid only for a single use per customer. This is tracked using customer Id.
PrerequisiteCustomerIds	String	False	No	A list of customer Ids which for the price rule to be applicable, the customer must match one of the specified customers. If PrerequisiteCustomerIds is populated, then PrerequisiteSavedSearchIds must be empty.
PrerequisiteQuantityRange	String	False	No	The minimum number of items for the price rule to be applicable. It has the following property: greater_than_or_equal_to: The quantity of an entitled cart item must be greater than or equal to this value.
PrerequisiteSavedSearchIds	String	False	No	A list of customer saved search Ids. For the price rule to be applicable, the customer must be in the group of customers matching a customer saved search. If PrerequisiteSavedSearchIds is populated, then PrerequisiteCustomerIds must be empty.
PrerequisiteShippingPriceRange	String	False	No	The maximum shipping price for the price rule to be applicable. It has the following property: less_than_or_equal_to: The shipping price must be less than or equal to this value.
PrerequisiteSubtotalRange	String	False	No	The minimum subtotal for the price rule to be applicable. It has the following property: greater_than_or_equal_to: The subtotal of the entitled cart items must be greater than or equal to this value for the discount to apply.
TargetSelection	String	False	No	The target selection method of the price rule. Valid values: all: The price rule applies the discount to all line items in the checkout, entitled: The price rule applies the discount to selected entitlements only.
TargetType	String	False	No	The target type that the price rule applies to. Valid values: line_item: The price rule applies to the cart's line items, shipping_line: The price rule applies to the cart's shipping lines.
UsageLimit	Int	False	No	The maximum number of times the price rule can be used, per discount code.
PrerequisiteProductIds	String	False	No	List of product ids that will be a prerequisites for a Buy X Get Y type discount. The PrerequisiteProductIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product variant is included in PrerequisiteVariantIds, then PrerequisiteProductIds can't include the ID of the product associated with that variant.
PrerequisiteVariantIds	String	False	No	List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The EntitledVariantIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Caution: If a product is included in PrerequisiteProductIds, then PrerequisiteVariantIds can't include the ID of any variants associated with that product.
PrerequisiteCollectionIds	String	False	No	List of collection ids that will be a prerequisites for a Buy X Get Y discount. The EntitledCollectionIds can be used only with: TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each and PrerequisiteToEntitlementQuantityRatio defined. Cannot be used in combination with PrerequisiteProductIds or PrerequisiteVariantIds.
Value	Decimal	False	No	The value of the price rule. If if the value of target_type is shipping_line, then only -100 is accepted. The value must be negative.
ValueType	String	False	No	The value type of the price rule. Valid values: fixed_amount: Applies a discount of value as a unit of the store's currency. For example, if value is -30 and the store's currency is USD, then $30 USD is deducted when the discount is applied, percentage: Applies a percentage discount of value. For example, if value is -30, then 30% will be deducted when the discount is applied. If TargetType is shipping_line, then only percentage is accepted.
PrerequisiteToEntitlementQuantityRatio	String	False	No	Buy/Get ratio for a Buy X Get Y discount. prerequisite_quantity defines the necessary 'buy' quantity and entitled_quantity the offered 'get' quantity. The PrerequisiteToEntitlementQuantityRatio can be used only with: ValueType set to percentage, TargetType set to line_item, TargetSelection set to entitled, AllocationMethod set to each, PrerequisiteProductIds or PrerequisiteVariantIds or PrerequisiteCollectionIds defined and EntitledProductIds or EntitledVariantIds or EntitledCollectionIds defined.
Images	String	False	No	A list of image objects.
ProductType	String	False	No	A categorization that a product can be tagged with, commonly used for filtering and searching.
Options	String	True	No	Custom product property names.
PublishedScope	String	False	No	Indicates whether the product is published to the Point of Sale channel.
Tags	String	False	No	A categorization that a product can be tagged with. Use commas to separate categories.
TemplateSuffix	String	True	No	The suffix of the liquid template being used.
Title	String	False	No	The name of the product.
Vendor	String	False	No	The name of the vendor of the product.
StartsAt	Datetime	False	No	The date and time when the price rule starts.
EndsAt	Datetime	False	No	The date and time when the price rule ends. Must be after StartsAt.
PublishedAt	Datetime	True	No	The date and time when the product was published to the Online Store channel.
CreatedAt	Datetime	True	No	The date and time when the price rule was created.
UpdatedAt	Datetime	True	No	The date and time when the price rule was last modified.
Published	Bool	False	Yes	Set to true to publish the product or to false to not publish it
MetafieldsGlobalTitleTag	String	False	Yes	The name of the product, to be used for SEO purposes.
MetafieldsGlobalDescriptionTag	String	False	Yes	The description of the product, to be used for SEO purposes.

Return to Top

RecurringApplicationCharges

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The ID of the recurring application charge.
Name	String	False	No	The name of the recurring application charge.
ApiClientId	String	False	No	The API Client Id
Price	Decimal	False	No	The price of the recurring application charge. The maximum price is 10,000.
Status	String	False	No	The status of the recurring charge
ReturnUrl	String	False	No	The URL where the merchant is redirected after accepting the charge.
BillingOn	Date	False	No	The date and time (ISO 8601 format) when the customer was billed.
Test	String	False	No	Whether the application charge is a test transaction.
CreatedAt	Datetime	False	No	The date and time (ISO 8601 format) when the recurring application charge was created.
UpdatedAt	Datetime	False	No	The date and time (ISO 8601 format) when the recurring application charge was last updated.
ActivatedOn	Datetime	False	No	The date and time (ISO 8601 format) when the customer activated the recurring application charge.
CancelledOn	Datetime	False	No	The date and time (ISO 8601 format) when the merchant canceled their recurring application charge.
TrialDays	Int	False	No	The number of days that the customer is eligible for a free trial.
TrialEndsOn	Datetime	False	No	The date and time (ISO 8601 format) when the free trial ends.
DecoratedReturnUrl	String	False	No	The decorated return url.
CappedAmount	String	False	No	The limit a customer can be charged for usage based billing. If this property is provided, then you must also provide the terms property.
ConfirmationUrl	String	False	No	The URL where the merchant accepts or declines the recurring application charge.
Terms	String	False	No	The terms and conditions of usage based billing charges. Must be present in order to create usage charges,

Return to Top

Redirects

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The ID for the redirect.
Path	String	False	No	The old path to be redirected.
Target	String	False	No	The target location where the user will be redirected.

Return to Top

RefundAdjustments

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	A unique numeric identifier for the refund adjustment.
OrderId	Long	False	Orders.Id	No	The unique identifier for the order that the order adjustment is associated with.
RefundId	Long	False	Refunds.Id	No	The unique identifier for the refund that the order adjustment is associated with.
Amount	Decimal	False		No	The value of the discrepancy between the calculated refund and the actual refund.
TaxAmount	Decimal	False		No	The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund.
Kind	String	False		No	The order adjustment type.
Reason	String	False		No	The reason for the order adjustment.
AmountShopMoney	Decimal	False		No	The amount of the order adjustment in shop.
AmountShopCurrency	String	False		No	The currency of the order adjustment in shop.
AmountPresentmentMoney	Decimal	False		No	The amount of the order adjustment in presentment.
AmountPresentmentCurrency	String	False		No	The currency of the order adjustment in presentment.
TaxAmountShopMoney	Decimal	False		No	The tax amount of the order adjustment in shop.
TaxAmountShopCurrency	String	False		No	The tax currency of the order adjustment in shop.
TaxAmountPresentmentMoney	Decimal	False		No	The tax amount of the order adjustment in presentment.
TaxAmountPresentmentCurrency	String	False		No	The tax currency of the order adjustment in presentment.

Return to Top

Refunds

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The unique identifier for the refund.
OrderId	Long	False	Orders.Id	No	The id of the order.
OrderUpdatedAt	Datetime	True	Orders.UpdatedAt	No	The date and time when the order was last modified.
Note	String	False		No	The optional note attached to a refund.
Restock	Bool	True		No	Whether or not the line items were added back to the store inventory.
UserId	Long	True		No	The unique identifier of the user who performed the refund.
CreatedAt	Datetime	True		No	The date and time when the refund was created.
ProcessedAt	Datetime	True		No	The date and time when the refund was imported.
LineAggregate	String	False		No	A JSON aggregate of line items associated with the refund.
OrderTransactionAggregate	String	False		No	A JSON aggregate of transactions associated with the refund.
Notify	Bool	False		Yes	Whether or not to send a refund notification to the customer.
DiscrepancyReason	String	False		Yes	An optional comment, used if there is a discrepancy between calculated and actual refund amounts (one of: restock, damage, customer, other)
ShippingAmount	Decimal	False		Yes	Set specific amount of shipping to refund. Takes precedence over FullRefund.
ShippingFullRefund	Bool	False		Yes	Whether or not to to refund all remaining shipping.

Return to Top

RefundsItems

Name	Type	ReadOnly	References	FilterOnly	Description
ItemId [KEY]	Long	False	OrdersItems.ItemId	No	The id of the order item. Only available for orders.
OrderID [KEY]	Long	False	Orders.Id	No	The id of the refund this refunded item belongs to.
RefundId [KEY]	Long	False	Refunds.Id	No	The id of the refund this refunded item belongs to.
LocationId	Long	False		No	The unique identifier of the location tied to the refund item
ProductId	Long	False		No	The id of the of the product beloning to the order item.
ItemVariantId	Long	False		No	The id of the product variant.
ItemTitle	String	False		No	The title of the product.
Name	String	False		No	The name of the product variant.
ItemQuantity	Int	False		No	The number of products that were purchased.
ItemPrice	Decimal	False		No	The price of the item before discounts have been applied.
ItemGrams	Int	False		No	The weight of the item in grams.
SKU	String	False		No	A unique identifier of the item in the fulfillment.
VariantTitle	String	False		No	The title of the product variant.
Properties	String	False		No	Shows custom properties for this order item.
Vendor	String	False		No	The name of the supplier of the item.
FulFillmentsService	String	False		No	Service provider who is doing the fulfillment.
RequiresShipping	Bool	False		No	States whether or not the fulfillment requires shipping.
Taxable	Bool	False		No	States whether or not the product was taxable.
GiftCard	Bool	False		No	States whether or not the order item is a gift card.
FulfillableQuantity	Int	False		No	The amount available to fulfill.
TotalDiscount	Decimal	False		No	The total discount amount applied to this order item.
FulfillmentStatus	String	False		No	How far along an order is in terms order items fulfilled.
RefundSubtotal	Decimal	False		No	The refunded amount for this item. This is calculated by multiplying ItemPrice with RefundQuantity.
RefundQuantity	Int	False		No	The quantity of the item refunded.
RefundRestockType	String	False		No	The type of the restock action.
RefundSubtotalPresentmentAmount	Decimal	False		No	The total amount of the presentment money.
RefundSubtotalPresentmentCurrencyCode	String	False		No	The currency code of the presentment money.
RefundSubtotalShopAmount	Decimal	False		No	The total amount of the shop money.
RefundSubtotalShopCurrencyCode	String	False		No	The currency code of the shop money.
RefundTotalTax	Decimal	False		No	Total tax for the refunded item.
RefundTotalTaxPresentmentAmount	Decimal	False		No	Total tax amount for the presentment money.
RefundTotalTaxPresentmentCurrencyCode	String	False		No	Currency code for the tax on presentment money.
RefundTotalTaxShopAmount	Decimal	False		No	Total tax amount for the shop money.
RefundTotalTaxShopCurrencyCode	String	False		No	Currency code for the tax on shop money.
AppliedDiscountTitle	String	False		No	The title of the applied discount for this order. Only available for draft orders.
AppliedDiscountDescription	String	False		No	The description of the applied discount for order. Only available for draft orders.
AppliedDiscountValue	Decimal	False		No	The value of the applied discount for this order. Only available for draft orders.
AppliedDiscountValueType	String	False		No	The value type of the applied discount for order. Only available for draft orders.
AppliedDiscountAmount	Decimal	False		No	The amount of the applied discount for this order. Only available for draft orders.
Status	String	False		Yes	Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open.

Return to Top

RefundTransactions

Name	Type	ReadOnly	References	FilterOnly	Description
TransactionsId [KEY]	Long	False		No	The ID for the refund transaction.
OrderId	Long	False	Orders.Id	No	The ID for the order that the transaction is associated with.
RefundId	Long	False	Refunds.Id	No	The unique identifier for the refund associated with.
Amount	Decimal	False		No	The amount of money included in the transaction.
Authorization	String	False		No	The authorization code associated with the transaction..
CreatedAt	Datetime	False		No	The date and time (ISO 8601 format) when the transaction was created.
Currency	String	False		No	The three-letter code (ISO 4217 format) for the currency used for the payment.
DeviceId	String	False		No	The ID for the device.
ErrorCode	String	False		No	A standardized error code, independent of the payment provider.
GraphqlAPIId	String	False		No	The order adjustment type.
Gateway	String	False		No	The name of the gateway the transaction was issued through.
Kind	String	False		No	The transaction's type.
LocationId	String	False		No	The ID of the physical location where the transaction was processed.
Message	String	False		No	A string generated by the payment provider with additional information about why the transaction succeeded or failed.
ParentId	Long	False		No	The ID of an associated transaction..
ProcessedAt	Datetime	False		No	The date and time (ISO 8601 format) when a transaction was processed.
Status	String	False		No	The status of the transaction.
SourceName	String	False		No	The origin of the transaction.
Test	Bool	False		No	Whether the transaction is a test transaction.
UserId	String	False		No	The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable.

Return to Top

ResourceFeedbacks

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	Unique id of the resource.
Type	String	False	No	TType of resource for which feedback is returned. eg. Shop, Product.
State	String	False	No	Indicates the state that the Shop or resource is in, from the perspective of your app. Valid values are requires_action, or success.
Messages	String	False	No	The name of the report.
CreatedAt	Datetime	False	No	DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone.
UpdatedAt	Datetime	False	No	DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone.
ResourceUpdatedAt	Datetime	False	No	The date and time (ISO 8601) when the report was last modified.
FeedbackGeneratedAt	Datetime	False	No	The time at which the payload is constructed. Used to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival. Type: ISO 8601 UTC datetime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone.

Return to Top

ScriptTags

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The ID for the script tag.
Cache	Bool	False	No	Whether the Shopify CDN can cache and serve the script tag.
CreatedAt	Datetime	True	No	The date and time (ISO 8601) when the script tag was created.
DisplayScope	String	False	No	The page or pages on the online store where the script should be included.
Event	String	False	No	The DOM event that triggers the loading of the script. Valid values: onload.
Src	String	False	No	The URL of the remote script.
UpdatedAt	Datetime	True	No	The date and time (ISO 8601) when the script tag was last updated.

Return to Top

ShippingItemDiscountAllocations

Name	Type	ReadOnly	References	FilterOnly	Description
LineNumber [KEY]	Long	False		No	A unique numeric identifier for the table.
ItemId	Long	False	ShippingItems.ItemId	No	The id of the shipping item. Only available for orders.
OrderId	Long	False	Orders.Id	No	The id of the order.
Amount	String	False		No	The Amount of the item discount allocations.
ShopMoneyAmount	Decimal	False		No	The ShopMoneyAmount of the item discount allocations.
ShopMoneyCurrencyCode	String	False		No	The ShopMoneyCurrencyCode of the item discount allocations.
PresentmentMoneyAmount	Decimal	False		No	The PresentmentMoneyAmount of the item discount allocations.
PresentmentMoneyCurrencyCode	String	False		No	The PresentmentMoneyCurrencyCode of the item discount allocations.
DiscountApplicationIndex	Int	False		No	The Discount application index for an order.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.

Return to Top

ShippingItems

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	The id of the shipping item.
OrderId [KEY]	Long	False	Orders.Id	No	The id of the order.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.
Price	Decimal	False		No	The price of this shipping method.
Code	String	False		No	A reference to the shipping method.
Title	String	False		No	The title of the shipping method.
Source	String	False		No	The source of the shipping method.
CarrierIdentifier	String	False		No	A reference to the carrier service that provided the rate.
RequestedFulfillmentServiceId	String	False		No	A reference to the fulfillment service that is being requested for the shipping method.

Return to Top

ShippingZones

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The unique numeric identifier for the shipping zone.
Name	String	False	No	The name of the shipping zone, specified by the user.
ProfileId	String	False	No	The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates.
LocationGroupId	String	False	No	The ID of the shipping zone's location group. Location groups allow merchants to create shipping rates that apply only to the specific locations in the group.
Countries	String	False	No	A list of countries that belong to the shipping zone.
CarrierShippingRateProviders	String	False	No	Information about carrier shipping providers and the rates used.
PriceBasedShippingRates	String	False	No	Information about price based shipping rates used.
WeightBasedShippingRates	String	False	No	Information about weight based shipping rates used.

Return to Top

Shop

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	A unique numeric identifier for the shop.
Name	String	False	No	The name of the shop.
Email	String	False	No	The contact email address for the shop.
Address1	String	False	No	The shop's street address.
Address2	String	False	No	The shop's additional street address (apt, suite, etc.).
City	String	False	No	The city in which the shop is located.
Country	String	False	No	The shop's country (by default equal to the two-letter country code).
CountryCode	String	False	No	The two-letter country code corresponding to the shop's country.
CountryName	String	False	No	The shop's normalized country name.
CustomerEmail	String	False	No	The customer's email.
Currency	String	False	No	The three-letter code for the currency that the shop accepts.
Domain	String	False	No	The shop's domain.
GoogleAppsDomain	String	False	No	The URL of the domain if the shop has a google apps domain.
GoogleAppsLoginEnabled	String	False	No	Indicated whether the shop has google apps login enabled.
Latitude	Double	False	No	Geographic coordinate specifying the north/south location of a shop.
Longitude	Double	False	No	Geographic coordinate specifying the east/west location of a shop.
MoneyFormat	String	False	No	A string representing the way currency is formatted when the currency isn't specified.
MoneyWithCurrencyFormat	String	False	No	A string representing the way currency is formatted when the currency is specified.
WeightUnit	String	False	No	A string representing the default unit of weight measurement for the shop.
MyshopifyDomain	String	False	No	The shop's 'myshopify.com' domain.
PlanName	String	False	No	The name of the Shopify plan the shop is on.
HasDiscounts	Bool	False	No	Indicates if any active discounts exist for the shop.
HasGiftCards	Bool	False	No	Indicates if any active gift cards exist for the shop.
PlanDisplayName	String	False	No	The display name of the Shopify plan the shop is on.
PasswordEnabled	Bool	False	No	Indicates whether the Storefront password protection is enabled.
Phone	String	False	No	The contact phone number for the shop.
PrimaryLocale	String	False	No	The shop's primary locale.
Province	String	False	No	The shop's normalized province or state name.
ProvinceCode	String	False	No	The two-letter code for the shop's province or state.
ShopOwner	String	False	No	The username of the shop owner.
Source	String	False	No	Source
TaxShipping	Bool	False	No	Specifies whether or not taxes were charged for shipping.
TaxesIncluding	Bool	False	No	The setting for whether applicable taxes are included in product prices.
CountryTaxes	Bool	False	No	The setting for whether the shop is applying taxes on a per-county basis or not (US-only).
Timezone	String	False	No	The name of the timezone the shop is in.
IANATimezone	String	False	No	The named timezone assigned by the IANA.
Zip	String	False	No	The zip or postal code of the shop's address.
HasStorefront	Bool	False	No	Indicates whether the shop has web-based storefront or not.
CreatedAt	Datetime	False	No	The date and time when the shop was created.
UpdatedAt	Datetime	False	No	The date and time when the shop was last updated.
SetupRequired	Bool	False	No	Indicates whether the shop has any outstanding setup steps or not.

Return to Top

SmartCollections

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The ID of the smart collection.
Title	String	False	No	The name of the smart collection. Maximum length: 255 characters.
BodyHtml	String	False	No	The description of the smart collection. Includes HTML markup. Many shop themes display this on the smart collection page.
Image	String	False	No	A JSON aggregate with information regarding the image of smart collection.
Rules	String	False	No	A JSON aggregate with the list of rules that define what products go into the smart collection. Valid values for each rule field: column: tag, title, type, vendor, variant_price, variant_compare_at_price, variant_weight, variant_inventory, variant_title; relation: equals, greater_than, less_than, starts_with, ends_with, contains; condition: any string
Handle	String	False	No	A human-friendly unique string for the smart collection. Automatically generated from the title. Used in shop themes by the Liquid templating language to refer to the smart collection. (maximum: 255 characters)
Disjunctive	Bool	False	No	Whether the product must match all the rules to be included in the smart collection. Valid values: true: products only need to match one or more of the rules to be included in the smart collection, false: products must match all of the rules to be included in the smart collection.
SortOrder	String	False	No	The order in which products in the smart collection appear.
TemplateSuffix	String	False	No	The suffix of the Liquid template that the shop uses. By default, the original template is called product.liquid, and additional templates are called product.suffix.liquid.
PublishedScope	String	False	No	Whether the smart collection is published to Point of Sale. Valid values: web: The smart collection is published to the shop's online channels and not published to the Point of Sale channel, global: The smart collection is published to both the online channels and the Point of Sale channel.
UpdatedAt	Datetime	True	No	The date and time when the smart collection was last modified.
PublishedAt	Datetime	True	No	The date and time when the smart collection was published. Returns null when the collection is hidden.
ProductId	String	True	No	Show smart collections that include a given product.
PublishedStatus	String	True	No	Show smart collection with a given published status: published: show only published smart collections, unpublished: show only unpublished smart collections, any: show all smart collections. (default: any).

Return to Top

TaxItems

Name	Type	ReadOnly	References	FilterOnly	Description
LineNumber [KEY]	Long	False		No	A unique numeric identifier for the table.
OrderId	Long	False	Orders.Id	No	The id of the order.
OrderUpdatedAt	Datetime	False		No	The date and time when the order was last modified.
ChannelLiable	Bool	False		No	Whether the channel that submitted the tax line is liable for remitting.
TaxItemPrice	Decimal	False		No	The amount of tax to be charged.
TaxItemRate	Decimal	False		No	The rate of tax to be applied.
TaxItemTitle	String	False		No	The name of the tax.

Return to Top

Themes

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	A unique numeric identifier for the theme.
AdminGraphqlApiId	String	True	No	Displays the Admin Graphql API id.
CreatedAt	Datetime	True	No	The date and time (ISO 8601 format) when the theme was created.
Name	String	False	No	The name of the theme.
Previewable	Bool	True	No	Whether the theme can currently be previewed.
Processing	Bool	True	No	Whether files are still being copied into place for this theme.
Role	String	False	No	Specifies how the theme is being used within the shop.
ThemeStoreId	Long	True	No	A unique identifier applied to Shopify-made themes that are installed from the Shopify Theme Store Theme Store.
UpdatedAt	Datetime	True	No	The date and time ( ISO 8601 format) when the theme was last updated.

Return to Top

UsageCharges

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	The ID of the usage charge.
Description	String	False		No	The name of the usage charge.
Price	Decimal	False		No	The price of the usage charge.
CreatedAt	Datetime	False		No	The date and time (ISO 8601 format) when the usage charge was created.
BalanceUsed	Decimal	False		No	The used balance
BalanceRemaining	Decimal	False		No	The remaining balance
RiskLevel	Int	False		No	The risk Level
RecurringApplicationId	Long	False	RecurringApplicationCharges.Id	No	The Id of the RecurringApplication Charge

Return to Top

Users

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The ID of the user.
FirstName	String	False	No	The first name of the user.
Email	String	False	No	The email of the user.
Url	String	False	No	The url of the user.
IM	String	False	No	The IM of the user.
ScreenName	String	False	No	The screen name of the user.
Phone	String	False	No	The phone number of the of the user.
LastName	String	False	No	The last name of the user.
AccountOwner	Bool	False	No	If the user is the account owner.
ReceiveAnnouncements	Bool	False	No	If the user receives announcements.
Bio	String	False	No	The bio of the user.
Permissions	String	False	No	The list of permissions of the user.
Locale	String	False	No	The Locale of the user.
UserType	String	False	No	The type of the user.
AdminGraphQLAPIId	String	False	No	The Admin GraphQL API Id of the user.
TFAEnabled	Bool	False	No	If TFA is enabled.

Return to Top