Orders

Retrieves a list of orders.

Table-Specific Information

Select

The driver uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The driver processes other filters client-side within the driver.

Id supports the '=, IN' comparison operators.
Number supports the '=, !=' comparison operators.
Name supports the '=, !=' comparison operators.
Email supports the '=, !=' comparison operators.
Test supports the '=, !=' comparison operators.
ConfirmationNumber supports the '=, !=' comparison operators.
DiscountCode supports the '=, !=' comparison operators.
ProcessedAt supports the '=, !=, <, >, >=, <=' comparison operators.
CurrentSubtotalLineItemsQuantity supports the '=, !=' comparison operators.
CreatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
CustomerId supports the '=, !=' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM Orders WHERE Id = 'Val1'
  SELECT * FROM Orders WHERE Number = 'Val1'
  SELECT * FROM Orders WHERE Name = 'Val1'
  SELECT * FROM Orders WHERE Email = 'Val1'
  SELECT * FROM Orders WHERE Test = true
  SELECT * FROM Orders WHERE ConfirmationNumber = 'Val1'
  SELECT * FROM Orders WHERE DiscountCode = 'Val1'
  SELECT * FROM Orders WHERE ProcessedAt = '2023-01-01 11:10:00'
  SELECT * FROM Orders WHERE CurrentSubtotalLineItemsQuantity = 123
  SELECT * FROM Orders WHERE CreatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Orders WHERE UpdatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Orders WHERE CustomerId = 'Val1'

Insert

The following columns can be used to create a new record:

Number, SourceIdentifier, SourceName, Name, Email, Note, Phone, Tags, Test, ClosedAt, CurrencyCode, ProcessedAt, TaxesIncluded, CustomerAcceptsMarketing, DisplayFinancialStatus, DisplayFulfillmentStatus, PresentmentCurrencyCode, CustomerId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressPhone, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressPhone, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2

The following pseudo-columns can be used to create a new record:

PurchasingEntityCompanyLocationId, ReferringSite, SourceUrl, UserId, DiscountCodeFreeShipping, DiscountCodeFixed, DiscountCodeFixedAmountSetPresentmentMoneyAmount, DiscountCodeFixedAmountSetPresentmentMoneyCurrencyCode, DiscountCodeFixedAmountSetShopMoneyAmount, DiscountCodeFixedAmountSetShopMoneyCurrencyCode, DiscountCodePercentage, DiscountCodePercentageValue, FulfillmentLocationId, FulfillmentNotifyCustomer, FulfillmentTrackingInfoNumber, FulfillmentTrackingInfoCompany, FulfillmentShipmentStatus, FulfillmentOriginAddressAddress1, FulfillmentOriginAddressAddress2, FulfillmentOriginAddressCity, FulfillmentOriginAddressCountryCode, FulfillmentOriginAddressProvinceCode, FulfillmentOriginAddressZip, OrderLineItems (references OrderLineItems), OrderShippingLines (references OrderShippingLines), OrderTaxLines (references OrderTaxLines), OrderTransactions (references OrderTransactions), OrderCustomAttributes (references OrderCustomAttributes), Metafields (references Metafields), OptionsInventoryBehaviour, OptionsSendFulfillmentRequest, OptionsSendReceipt

OrderLineItems Temporary Table Columns


Column Name	Type	Description
Title	String	The title of the product at time of order creation.
VariantTitle	String	The title of the variant at time of order creation.
VariantId	String	A globally-unique ID.
ProductId	String	A globally-unique ID.
Quantity	Int	The number of variant units ordered.
Sku	String	The variant SKU number.
Taxable	Bool	Whether the variant is taxable.
Vendor	String	The name of the vendor who made the variant.
RequiresShipping	Bool	Whether physical shipping is required for the variant.
IsGiftCard	Bool	Whether the line item represents the purchase of a gift card.
OriginalUnitPriceSetPresentmentMoneyAmount	Decimal	Decimal money amount.
OriginalUnitPriceSetPresentmentMoneyCurrencyCode	String	Currency of the money.
OriginalUnitPriceSetShopMoneyAmount	Decimal	Decimal money amount.
OriginalUnitPriceSetShopMoneyCurrencyCode	String	Currency of the money.
FulfillmentService	String	The handle of a fulfillment service that stocks the product variant belonging to a line item.
OrderLineItemCustomAttributes (references OrderLineItemCustomAttributes)	String	An array of custom information for the item that has been added to the cart. Often used to provide product customization options.
OrderLineItemTaxLines (references OrderLineItemTaxLines)	String	A list of tax line objects, each of which details a tax applied to the item.

OrderShippingLines Temporary Table Columns


Column Name	Type	Description
Title	String	Returns the title of the shipping line.
Code	String	A reference to the shipping method.
Source	String	Returns the rate source for the shipping line.
OriginalPriceSetPresentmentMoneyAmount	Decimal	Decimal money amount.
OriginalPriceSetPresentmentMoneyCurrencyCode	String	Currency of the money.
OriginalPriceSetShopMoneyAmount	Decimal	Decimal money amount.
OriginalPriceSetShopMoneyCurrencyCode	String	Currency of the money.
TaxLines	String	A list of tax line objects, each of which details a tax applicable to this shipping line.

OrderTaxLines Temporary Table Columns


Column Name	Type	Description
Title	String	The name of the tax.
Rate	Double	The proportion of the line item price that the tax represents as a decimal.
ChannelLiable	Bool	Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentage	Double	The proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmount	Decimal	Decimal money amount.
PriceSetPresentmentMoneyCurrencyCode	String	Currency of the money.
PriceSetShopMoneyAmount	Decimal	Decimal money amount.
PriceSetShopMoneyCurrencyCode	String	Currency of the money.

OrderTransactions Temporary Table Columns


Column Name	Type	Description
AmountSetPresentmentMoneyAmount	Decimal	Decimal money amount.
AmountSetPresentmentMoneyCurrencyCode	String	Currency of the money.
AmountSetShopMoneyAmount	Decimal	Decimal money amount.
AmountSetShopMoneyCurrencyCode	String	Currency of the money.
AuthorizationCode	String	Authorization code associated with the transaction.
DeviceId	String	The ID of the device used to process the transaction.
GiftCardDetailsId	String	The ID of the gift card used for this transaction.
Kind	String	The kind of transaction.
LocationId	String	The ID of the location where the transaction was processed.
ProcessedAt	Datetime	Date and time when the transaction was processed.
ReceiptJson	String	The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction.
Status	String	The status of this transaction.
Test	Bool	Whether the transaction is a test transaction.
UserId	String	Staff member who was logged into the Shopify POS device when the transaction was processed. (This column is available only with a ShopifyPlus subscription)

OrderCustomAttributes Temporary Table Columns


Column Name	Type	Description
Key	String	Key or name of the attribute.
Value	String	Value of the attribute.

Metafields Temporary Table Columns


Column Name	Type	Description
Id	String	The unique ID of the metafield.
Namespace	String	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	The name of the metafield.
Value	String	The information to be stored as metadata.
Type	String	The metafield's information type.

OrderLineItemCustomAttributes Temporary Table Columns


Column Name	Type	Description
Key	String	Key or name of the attribute.
Value	String	Value of the attribute.

OrderLineItemTaxLines Temporary Table Columns


Column Name	Type	Description
Title	String	The name of the tax.
Rate	Double	The proportion of the line item price that the tax represents as a decimal.
ChannelLiable	Bool	Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentage	Double	The proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmount	Decimal	Decimal money amount.
PriceSetPresentmentMoneyCurrencyCode	String	Currency of the money.
PriceSetShopMoneyAmount	Decimal	Decimal money amount.
PriceSetShopMoneyCurrencyCode	String	Currency of the money.

Update

The following columns can be updated:

Number, Email, Note, Tags, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2

The following pseudo-column can be used to update a record:

OrderCustomAttributes (references OrderCustomAttributes)

OrderCustomAttributes Temporary Table Columns


Column Name	Type	Description
Key	String	Key or name of the attribute.
Value	String	Value of the attribute.

Delete

You can delete entries by specifying the following column:

Columns


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

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.


Name	Type	Description
PurchasingEntityCompanyLocationId	String	The ID of the purchasing company's location for the order.
ReferringSite	String	The website where the customer clicked a link to the shop.
SourceUrl	String	A valid URL to the original order on the originating surface. This URL is displayed to merchants on the Order Details page. If the URL is invalid, then it won't be displayed.
UserId	String	The ID of the user logged into Shopify POS who processed the order, if applicable.
DiscountCodeFreeShipping	String	A free shipping discount code applied to the shipping on an order.
DiscountCodeFixed	String	A fixed amount discount code applied to the line items on the order.
DiscountCodeFixedAmountSetPresentmentMoneyAmount	Decimal	Decimal money amount.
DiscountCodeFixedAmountSetPresentmentMoneyCurrencyCode	String	Currency of the money.
DiscountCodeFixedAmountSetShopMoneyAmount	Decimal	Decimal money amount.
DiscountCodeFixedAmountSetShopMoneyCurrencyCode	String	Currency of the money.
DiscountCodePercentage	String	A percentage discount code applied to the line items on the order.
DiscountCodePercentageValue	Double	The amount that's deducted from the order total. When you create an order, this value is the percentage to deduct.
FulfillmentLocationId	String	The ID of the location to fulfill the order from.
FulfillmentNotifyCustomer	Bool	Whether the customer should be notified of changes with the fulfillment.
FulfillmentTrackingInfoNumber	String	The tracking number of the fulfillment.
FulfillmentTrackingInfoCompany	String	The name of the tracking company.
FulfillmentShipmentStatus	String	The status of the shipment.
FulfillmentOriginAddressAddress1	String	The street address of the fulfillment location.
FulfillmentOriginAddressAddress2	String	The second line of the address. Typically the number of the apartment, suite, or unit.
FulfillmentOriginAddressCity	String	The city in which the fulfillment location is located.
FulfillmentOriginAddressCountryCode	String	The country of the fulfillment location.
FulfillmentOriginAddressProvinceCode	String	The province of the fulfillment location.
FulfillmentOriginAddressZip	String	The zip code of the fulfillment location.
OrderLineItems	String	The line items to create for the order.
OrderShippingLines	String	A list of objects, each of which details a shipping method used.
OrderTaxLines	String	A list of tax line objects, each of which details a tax applicable to the order. When creating an order through the API, tax lines can be specified on the order or the line items but not both. Tax lines specified on the order are split across the taxable line items in the created order.
OrderTransactions	String	The payment transactions to create for the order.
OrderCustomAttributes	String	A list of extra information that's added to the order. Appears in the Additional details section of an order details page.
Metafields	String	A list of metafields to add to the order.
OptionsInventoryBehaviour	String	The behaviour to use when updating inventory. The allowed values are BYPASS, DECREMENT_IGNORING_POLICY, DECREMENT_OBEYING_POLICY.
OptionsSendFulfillmentRequest	Bool	Whether to send a shipping confirmation to the customer.
OptionsSendReceipt	Bool	Whether to send an order confirmation to the customer.

JDBC Driver for Shopify

Orders

Table-Specific Information

Select

Insert

OrderLineItems Temporary Table Columns

OrderShippingLines Temporary Table Columns

OrderTaxLines Temporary Table Columns

OrderTransactions Temporary Table Columns

OrderCustomAttributes Temporary Table Columns

Metafields Temporary Table Columns

OrderLineItemCustomAttributes Temporary Table Columns

OrderLineItemTaxLines Temporary Table Columns

Update

OrderCustomAttributes Temporary Table Columns

Delete

Columns

Pseudo-Columns