Power BI Connector for Shopify

Build 25.0.9454

Orders

Stores comprehensive order data including totals, customer info, fulfillment, payment, and channel sources.

Table-Specific Information

Select

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

  • 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 NameTypeDescription
TitleStringThe title of the product at time of order creation.
VariantTitleStringThe title of the variant at time of order creation.
VariantIdStringA globally-unique ID.
ProductIdStringA globally-unique ID.
QuantityIntThe number of variant units ordered.
SkuStringThe variant SKU number.
TaxableBoolWhether the variant is taxable.
VendorStringThe name of the vendor who made the variant.
RequiresShippingBoolWhether physical shipping is required for the variant.
IsGiftCardBoolWhether the line item represents the purchase of a gift card.
OriginalUnitPriceSetPresentmentMoneyAmountDecimalDecimal money amount.
OriginalUnitPriceSetPresentmentMoneyCurrencyCodeStringCurrency of the money.
OriginalUnitPriceSetShopMoneyAmountDecimalDecimal money amount.
OriginalUnitPriceSetShopMoneyCurrencyCodeStringCurrency of the money.
FulfillmentServiceStringThe handle of a fulfillment service that stocks the product variant belonging to a line item.
OrderLineItemCustomAttributes (references OrderLineItemCustomAttributes)StringAn array of custom information for the item that has been added to the cart. Often used to provide product customization options.
OrderLineItemTaxLines (references OrderLineItemTaxLines)StringA list of tax line objects, each of which details a tax applied to the item.

OrderShippingLines Temporary Table Columns

Column NameTypeDescription
TitleStringReturns the title of the shipping line.
CodeStringA reference to the shipping method.
SourceStringReturns the rate source for the shipping line.
OriginalPriceSetPresentmentMoneyAmountDecimalDecimal money amount.
OriginalPriceSetPresentmentMoneyCurrencyCodeStringCurrency of the money.
OriginalPriceSetShopMoneyAmountDecimalDecimal money amount.
OriginalPriceSetShopMoneyCurrencyCodeStringCurrency of the money.
TaxLinesStringA list of tax line objects, each of which details a tax applicable to this shipping line.

OrderTaxLines Temporary Table Columns

Column NameTypeDescription
TitleStringThe name of the tax.
RateDoubleThe proportion of the line item price that the tax represents as a decimal.
ChannelLiableBoolWhether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentageDoubleThe proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmountDecimalDecimal money amount.
PriceSetPresentmentMoneyCurrencyCodeStringCurrency of the money.
PriceSetShopMoneyAmountDecimalDecimal money amount.
PriceSetShopMoneyCurrencyCodeStringCurrency of the money.

OrderTransactions Temporary Table Columns

Column NameTypeDescription
AmountSetPresentmentMoneyAmountDecimalDecimal money amount.
AmountSetPresentmentMoneyCurrencyCodeStringCurrency of the money.
AmountSetShopMoneyAmountDecimalDecimal money amount.
AmountSetShopMoneyCurrencyCodeStringCurrency of the money.
AuthorizationCodeStringAuthorization code associated with the transaction.
DeviceIdStringThe ID of the device used to process the transaction.
GiftCardDetailsIdStringThe ID of the gift card used for this transaction.
KindStringThe kind of transaction.
LocationIdStringThe ID of the location where the transaction was processed.
ProcessedAtDatetimeDate and time when the transaction was processed.
ReceiptJsonStringThe transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction.
StatusStringThe status of this transaction.
TestBoolWhether the transaction is a test transaction.
UserIdStringStaff 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 NameTypeDescription
KeyStringKey or name of the attribute.
ValueStringValue of the attribute.

Metafields Temporary Table Columns

Column NameTypeDescription
IdStringThe unique ID of the metafield.
NamespaceStringA 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.
KeyStringThe name of the metafield.
ValueStringThe information to be stored as metadata.
TypeStringThe metafield's information type.

OrderLineItemCustomAttributes Temporary Table Columns

Column NameTypeDescription
KeyStringKey or name of the attribute.
ValueStringValue of the attribute.

OrderLineItemTaxLines Temporary Table Columns

Column NameTypeDescription
TitleStringThe name of the tax.
RateDoubleThe proportion of the line item price that the tax represents as a decimal.
ChannelLiableBoolWhether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.
RatePercentageDoubleThe proportion of the line item price that the tax represents as a percentage.
PriceSetPresentmentMoneyAmountDecimalDecimal money amount.
PriceSetPresentmentMoneyCurrencyCodeStringCurrency of the money.
PriceSetShopMoneyAmountDecimalDecimal money amount.
PriceSetShopMoneyCurrencyCodeStringCurrency 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 NameTypeDescription
KeyStringKey or name of the attribute.
ValueStringValue of the attribute.

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the order within Shopify.

Number String True

The purchase order number assigned to this order.

Unpaid Bool True

Indicates whether no payments have yet been made for the order.

FullyPaid Bool True

Indicates whether the order has been completely paid in full.

SourceIdentifier String True

A unique identifier for the order from a point-of-sale or external system. Examples include '1234-12-1000' or '111-98567-54'. The 'receipt_number' field for POS orders is derived from this value.

SourceName String True

The name of the system or channel where the order originated, such as an online store, app, or POS location.

LegacyResourceId String True

The identifier of the corresponding order resource in the REST Admin API.

CanMarkAsPaid Bool True

Indicates whether the order can be manually marked as paid by a merchant.

Name String True

The order's display identifier shown in the Shopify Admin and on customer status pages. Examples include '#1001', 'EN1001', or '1001-A'. This value may not be unique across multiple stores.

PaymentGatewayNames String True

A comma-separated list of all payment gateways used for this order. Examples include 'Shopify Payments' or 'Cash on Delivery (COD)'.

Capturable Bool True

Indicates whether payment for the order can still be captured.

Closed Bool True

Indicates whether the order has been closed.

Confirmed Bool True

Indicates whether inventory has been successfully reserved for the order.

Edited Bool True

Indicates whether any modifications have been applied to the order after creation.

Email String False

The email address associated with the customer who placed the order.

Fulfillable Bool True

Indicates whether there are any line items that remain eligible for fulfillment. Returns 'false' when no items are fulfillable. For item-level fulfillment details, refer to the line item object.

Note String False

Any merchant-entered note or comment associated with the order.

Phone String True

The phone number associated with the customer who placed the order.

Refundable Bool True

Indicates whether the order is eligible to be refunded.

Restockable Bool True

Indicates whether any line item from the order can be restocked if returned or refunded.

Tags String True

A comma-separated list of tags assigned to the order. Updating this field overwrites any existing tags. To add new tags without overwriting existing ones, use the appropriate mutation endpoint.

Test Bool True

Indicates whether the order is a test transaction created using the Shopify Bogus Gateway or a payment provider in test mode. Test orders cannot be converted to real orders and vice versa.

CancelReason String True

The reason provided for canceling the order. Returns 'null' if the order was not canceled.

CancelledAt Datetime True

The date and time when the order was canceled. Returns 'null' if the order remains active.

ClientIp String True

The IP address of the client or API request that created the order.

ClosedAt Datetime True

The date and time when the order was closed. Returns 'null' if the order is still open.

ConfirmationNumber String True

A randomly generated alphanumeric code that may be shown to the customer instead of the sequential order number. Examples include 'XPAV284CT' or '35PKUN0UJ'. This value is not guaranteed to be unique.

CurrencyCode String True

The shop's currency code at the time the order was placed, expressed as an ISO 4217 currency code (for example, USD).

CustomerLocale String True

A two-letter or three-letter language code, optionally followed by a region modifier, that identifies the customer's locale.

DiscountCode String True

The discount code applied to the order, if only one was used.

DiscountCodes String True

A list of all discount codes applied to the order, if multiple codes were used.

EstimatedTaxes Bool True

Indicates whether the taxes on the order are estimated. Returns 'false' when the taxes are finalized and not subject to change.

MerchantEditable Bool True

Indicates whether the order can be edited by the merchant. For example, canceled orders cannot be edited.

ProcessedAt Datetime True

The date and time when the order was processed by Shopify. This may differ from the order creation time.

RequiresShipping Bool True

Indicates whether the order includes any items or lines that require shipping.

RiskRecommendation String True

A recommendation based on fraud risk assessment results, suggesting the appropriate merchant action (for example, 'accept', 'investigate', or 'cancel').

ReturnStatus String True

The overall return status of the order, used for display or reporting purposes.

TaxesIncluded Bool True

Indicates whether taxes were included in the order's subtotal price.

DutiesIncluded Bool True

Indicates whether duties were included in the order's subtotal price.

TotalWeight String True

The total weight of all items in the order before returns, measured in grams.

CanNotifyCustomer Bool True

Indicates whether the customer has a valid email address on file that allows Shopify to send order notifications.

CurrentTotalWeight String True

The total weight of all items in the order after accounting for returns, measured in grams.

CustomerAcceptsMarketing Bool True

Indicates whether the customer agreed to receive marketing emails or promotional communications.

DisplayFinancialStatus String True

A summarized representation of the order's financial status, suitable for display in merchant-facing views. This field does not reflect all financial details of the order.

DisplayFulfillmentStatus String True

A summarized representation of the order's fulfillment status, suitable for merchant display. For detailed fulfillment tracking, use the fulfillment objects associated with the order.

FulfillmentsCount Int True

The total number of fulfillments created for the order, including any canceled fulfillments.

FulfillmentsCountPrecision String True

Indicates the precision level of the fulfillment count, showing whether the value is exact or approximate.

HasTimelineComment Bool True

Indicates whether a merchant-added timeline comment exists for the order in Shopify Admin.

MerchantEditableErrors String True

A list of validation or business logic reasons preventing the order from being edited. For example, 'Canceled orders can't be edited.'

PresentmentCurrencyCode String True

The ISO currency code representing the customer's payment currency for the order, which may differ from the shop's base currency.

RegisteredSourceUrl String True

The URL identifying the original source where the order originated, if available in the domain registry.

StatusPageUrl String True

The public URL where the customer can view the current status and tracking details of the order.

SubtotalLineItemsQuantity Int True

The total quantity of all line items that contribute to the order's subtotal price, before discounts and taxes.

BillingAddressMatchesShippingAddress Bool True

Indicates whether the billing address and shipping address provided for the order are identical.

CurrentSubtotalLineItemsQuantity Int True

The total quantity of all line items contributing to the order's current subtotal price, after accounting for any returns or edits.

CreatedAt Datetime True

The date and time when the order was originally created in Shopify.

UpdatedAt Datetime True

The date and time when the order was last modified in Shopify.

StaffMemberId String True

The unique identifier of the staff member associated with the order. This field is available only for Shopify Plus stores.

AppId String True

The unique identifier of the application that created or processed the order.

MerchantOfRecordAppId String True

The unique identifier of the application serving as the merchant of record for the order's payment processing.

MerchantBusinessEntityId String True

The unique identifier of the merchant's business entity associated with this order.

PhysicalLocationId String True

The unique identifier of the physical store or location where the order originated or was processed.

ChannelInformationId String True

The unique identifier of the channel information record linked to the order.

ChannelInformationChannelId String True

The unique identifier of the channel where the order was placed, such as an online store, app, or marketplace.

ChannelInformationAppId String True

The unique identifier of the application powering the sales channel where the order was created.

PublicationId String True

The unique identifier of the publication or sales listing through which the order was made.

PurchasingEntityCustomerId String True

The unique identifier of the customer entity that placed the order.

PurchasingEntityCompanyId String True

The unique identifier of the company entity that placed the order, if applicable.

CustomerId String True

The unique identifier of the customer record linked to the order.

CustomerFirstName String True

The first name of the customer who placed the order.

CustomerLastName String True

The last name of the customer who placed the order.

CustomerJourneySummaryReady Bool True

Indicates whether the order's attributed sessions and customer journey data have been fully generated.

CustomerJourneySummaryMomentsCount Int True

The total number of customer engagement moments associated with the order. Returns null if attribution is still processing.

CustomerJourneySummaryMomentsCountPrecision String True

Indicates the precision level of the customer journey moments count, showing whether the value is exact or estimated.

CustomerJourneySummaryCustomerOrderIndex Int True

Indicates the sequence number of this order within the customer's order history. Test orders are excluded from this count.

CustomerJourneySummaryDaysToConversion Int True

The number of days between the customer's first recorded session and the order creation date. The first session is determined by the last order date or a 30-day attribution window, whichever is shorter.

CustomerJourneySummaryFirstVisitId String True

The unique identifier of the customer's first visit session associated with this order.

CustomerJourneySummaryFirstVisitSource String True

The originating source of the customer's first visit, such as a platform (Facebook, Google), direct entry, or marketing channel.

CustomerJourneySummaryFirstVisitLandingPage String True

The URL of the first page that the customer visited during the session that led to the order.

CustomerJourneySummaryFirstVisitOccurredAt Datetime True

The date and time when the customer's first visit session occurred.

CustomerJourneySummaryFirstVisitReferralCode String True

The marketing referral code included in the first visit URL, derived from query parameters such as ref, source, or r.

CustomerJourneySummaryFirstVisitReferrerUrl String True

The URL of the external webpage or app where the customer clicked a link to reach the store, such as 'https://randomblog.com/page1' or 'android-app://com.google.android.gm'.

CustomerJourneySummaryFirstVisitSourceDescription String True

A detailed text description of the customer's first visit source, specifying the platform, campaign, or medium.

CustomerJourneySummaryFirstVisitSourceType String True

The type of marketing tactic used for the first visit, such as email, paid search, or referral.

CustomerJourneySummaryFirstVisitLandingPageHtml String True

The first landing page information rendered as an HTML hyperlink. For example, the URL of the first page visited by the customer.

CustomerJourneySummaryFirstVisitReferralInfoHtml String True

Referral information presented as HTML with clickable URLs that reference the original referral sources.

CustomerJourneySummaryLastVisitId String True

The unique identifier of the customer's last visit session associated with this order.

CustomerJourneySummaryLastVisitSource String True

The originating source of the customer's most recent visit before placing the order, such as an advertising platform, email campaign, or direct link.

CustomerJourneySummaryLastVisitLandingPage String True

The URL of the first page visited during the customer's most recent session prior to placing the order.

CustomerJourneySummaryLastVisitOccurredAt Datetime True

The date and time when the customer's most recent session occurred.

CustomerJourneySummaryLastVisitReferralCode String True

The marketing referral code associated with the customer's last visit session, extracted from parameters such as ref, source, or r.

CustomerJourneySummaryLastVisitReferrerUrl String True

The referring webpage or app that directed the customer to the online store for the last session.

CustomerJourneySummaryLastVisitSourceDescription String True

A descriptive label explaining the source of the last visit session, such as campaign name or advertising channel.

CustomerJourneySummaryLastVisitSourceType String True

The type of marketing channel used in the last visit session, for example, email, paid ad, or organic search.

CustomerJourneySummaryLastVisitLandingPageHtml String True

The last session's landing page represented as an HTML hyperlink, showing the first page viewed by the customer.

CustomerJourneySummaryLastVisitReferralInfoHtml String True

Referral details for the last session, rendered in HTML format with linked URLs to the referring source.

DisplayAddressId String True

The unique identifier for the display address associated with the order.

DisplayAddressCoordinatesValidated Bool True

Indicates whether the geographic coordinates for the display address have been validated.

DisplayAddressValidationResultSummary String True

The validation status result returned by Shopify's address validation feature for the display address.

DisplayAddressName String True

The customer's full name as displayed, derived from the first and last name fields.

DisplayAddressFirstName String True

The customer's first name as displayed in the order summary.

DisplayAddressLastName String True

The customer's last name as displayed in the order summary.

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 an apartment, suite, or unit number.

DisplayAddressCity String True

The name of the city, district, village, or town for the display address.

DisplayAddressCompany String True

The company or organization name associated with the display address.

DisplayAddressCountry String True

The country name for the display address.

DisplayAddressLatitude Double True

The latitude coordinate of the display address location.

DisplayAddressLongitude Double True

The longitude coordinate of the display address location.

DisplayAddressPhone String True

The customer's phone number associated with the display address, formatted using the E.164 international standard (for example, +16135551111).

DisplayAddressProvince String True

The region, province, or state of the display address.

DisplayAddressZip String True

The postal or ZIP code of the display address.

DisplayAddressFormattedArea String True

A comma-separated string combining city, province, and country for display formatting.

DisplayAddressProvinceCode String True

The two-letter province or region code, such as ON or CA.

DisplayAddressCountryCodeV2 String True

The two-letter ISO country code representing the country for the display address, such as US or CA.

BillingAddressId String True

The unique identifier for the billing address associated with the order.

BillingAddressCoordinatesValidated Bool True

Indicates whether the geographic coordinates for the billing address have been validated.

BillingAddressValidationResultSummary String True

The validation result from Shopify's address verification service for the billing address.

BillingAddressName String True

The customer's full name on the billing address, derived from first and last name fields.

BillingAddressFirstName String True

The first name of the customer on the billing address.

BillingAddressLastName String True

The last name of the customer on the billing address.

BillingAddressAddress1 String True

The first line of the billing address, typically the street address or PO Box number.

BillingAddressAddress2 String True

The second line of the billing address, typically an apartment, suite, or unit number.

BillingAddressCity String True

The name of the city, district, village, or town for the billing address.

BillingAddressCompany String True

The company or organization name associated with the billing address.

BillingAddressCountry String True

The country name for the billing address.

BillingAddressLatitude Double True

The latitude coordinate of the billing address location.

BillingAddressLongitude Double True

The longitude coordinate of the billing address location.

BillingAddressPhone String True

The customer's phone number for the billing address, formatted in E.164 standard format (for example, +16135551111).

BillingAddressProvince String True

The region, province, or state of the billing address.

BillingAddressZip String True

The postal or ZIP code of the billing address.

BillingAddressFormattedArea String True

A comma-separated list combining city, province, and country values for the billing address.

BillingAddressProvinceCode String True

The two-letter province or region code for the billing address, such as ON.

BillingAddressCountryCodeV2 String True

The two-letter ISO country code for the billing address, such as US or CA.

ShippingAddressId String False

The unique identifier for the shipping address associated with the order.

ShippingAddressCoordinatesValidated Bool True

Indicates whether the geographic coordinates for the shipping address have been validated.

ShippingAddressValidationResultSummary String True

The validation result from Shopify's address verification service for the shipping address.

ShippingAddressName String True

The customer's full name on the shipping address, derived from first and last name fields.

ShippingAddressFirstName String False

The first name of the customer on the shipping address.

ShippingAddressLastName String False

The last name of the customer on the shipping address.

ShippingAddressAddress1 String False

The first line of the shipping address, typically the street address or PO Box number.

ShippingAddressAddress2 String False

The second line of the shipping address, typically an apartment, suite, or unit number.

ShippingAddressCity String False

The name of the city, district, village, or town for the shipping address.

ShippingAddressCompany String False

The company or organization name associated with the shipping address.

ShippingAddressCountry String False

The country name for the shipping address.

ShippingAddressLatitude Double True

The latitude coordinate of the shipping address location.

ShippingAddressLongitude Double True

The longitude coordinate of the shipping address location.

ShippingAddressPhone String False

The customer's phone number for the shipping address, formatted in E.164 standard format (for example, +16135551111).

ShippingAddressProvince String False

The region, province, or state of the shipping address.

ShippingAddressZip String False

The postal or ZIP code of the shipping address.

ShippingAddressFormattedArea String True

A comma-separated list combining city, province, and country values for the shipping address.

ShippingAddressProvinceCode String False

The two-letter province or region code for the shipping address, such as ON.

ShippingAddressCountryCodeV2 String False

The two-letter ISO country code for the shipping address, such as US or CA.

ShippingLineId String True

The unique identifier of the shipping line associated with the order.

ShippingLineCarrierIdentifier String True

A reference identifier for the carrier service that provided the shipping rate. Present only when the rate was calculated by a third-party carrier.

ShippingLineTitle String True

The title or name of the selected shipping method shown to the customer at checkout.

ShippingLineCode String True

A code reference for the shipping method used, typically corresponding to a specific carrier rate or custom delivery option.

ShippingLineCustom Bool True

Indicates whether the shipping line was manually defined as a custom shipping method rather than being automatically calculated.

ShippingLinePhone String True

The phone number associated with the shipping address for this shipping line.

ShippingLineSource String True

Identifies the rate source for the shipping line, such as a carrier, fulfillment service, or manual entry.

ShippingLineDeliveryCategory String True

Describes the general classification of the delivery method, such as standard, express, or same-day.

ShippingLineShippingRateHandle String True

A unique internal identifier for the shipping rate used to calculate the charge. The format may vary and is not intended for display.

ShippingLineRequestedFulfillmentServiceId String True

The unique identifier of the fulfillment service requested to handle this shipping line.

PaymentTermsId String True

The unique identifier for the payment terms record associated with the order.

PaymentTermsTranslatedName String True

The localized name of the payment terms, translated into the shop administrator's preferred language.

PaymentTermsPaymentTermsName String True

The name of the payment terms template used to define the payment schedule or due date.

PaymentTermsOverdue Bool True

Indicates whether any scheduled payment under the order's payment terms is overdue.

PaymentTermsDueInDays Int True

The number of days from the invoice or order creation date until the payment is due, as defined by the payment terms template.

PaymentTermsPaymentTermsType String True

The type of payment terms template applied to the order, such as 'Net 30', 'Upon Receipt', or 'Installments'.

PaymentTermsDraftOrderId String True

The unique identifier of the draft order associated with the payment terms, if applicable.

CartDiscountAmountSetPresentmentMoneyAmount Decimal True

The total discount amount applied to the cart, expressed in the buyer's presentment currency as a decimal value.

CartDiscountAmountSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the cart discount amount.

CartDiscountAmountSetShopMoneyAmount Decimal True

The total discount amount applied to the cart, expressed in the shop's base currency as a decimal value.

CartDiscountAmountSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the cart discount amount.

ChannelInformationChannelDefinitionId String True

The unique identifier of the channel definition record, representing the sales channel through which the order was placed.

CurrentCartDiscountAmountSetPresentmentMoneyAmount Decimal True

The current total cart-level discount amount, expressed in the buyer's presentment currency as a decimal value.

CurrentCartDiscountAmountSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the current cart-level discount amount.

CurrentCartDiscountAmountSetShopMoneyAmount Decimal True

The current total cart-level discount amount, expressed in the shop's base currency as a decimal value.

CurrentCartDiscountAmountSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the current cart-level discount amount.

CurrentSubtotalPriceSetPresentmentMoneyAmount Decimal True

The current subtotal price of the order, expressed in the buyer's presentment currency as a decimal value.

CurrentSubtotalPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the current subtotal price.

CurrentSubtotalPriceSetShopMoneyAmount Decimal True

The current subtotal price of the order, expressed in the shop's base currency as a decimal value.

CurrentSubtotalPriceSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the current subtotal price.

CurrentTotalAdditionalFeesSetPresentmentMoneyAmount Decimal True

The current total of all additional fees applied to the order, expressed in the buyer's presentment currency as a decimal value.

CurrentTotalAdditionalFeesSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for additional fees.

CurrentTotalAdditionalFeesSetShopMoneyAmount Decimal True

The current total of all additional fees applied to the order, expressed in the shop's base currency as a decimal value.

CurrentTotalAdditionalFeesSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for additional fees.

CurrentTotalDiscountsSetPresentmentMoneyAmount Decimal True

The current total discount amount for the order, expressed in the buyer's presentment currency as a decimal value.

CurrentTotalDiscountsSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for current total discounts.

CurrentTotalDiscountsSetShopMoneyAmount Decimal True

The current total discount amount for the order, expressed in the shop's base currency as a decimal value.

CurrentTotalDiscountsSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for current total discounts.

CurrentTotalDutiesSetPresentmentMoneyAmount Decimal True

The current total duties applied to the order, expressed in the buyer's presentment currency as a decimal value.

CurrentTotalDutiesSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for duties.

CurrentTotalDutiesSetShopMoneyAmount Decimal True

The current total duties applied to the order, expressed in the shop's base currency as a decimal value.

CurrentTotalDutiesSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for duties.

CurrentTotalPriceSetPresentmentMoneyAmount Decimal True

The current total price of the order after taxes, discounts, and fees, expressed in the buyer's presentment currency as a decimal value.

CurrentTotalPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the current total price.

CurrentTotalPriceSetShopMoneyAmount Decimal True

The current total price of the order after taxes, discounts, and fees, expressed in the shop's base currency as a decimal value.

CurrentTotalPriceSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the current total price.

CurrentTotalTaxSetPresentmentMoneyAmount Decimal True

The current total tax amount applied to the order, expressed in the buyer's presentment currency as a decimal value.

CurrentTotalTaxSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the current total tax amount.

CurrentTotalTaxSetShopMoneyAmount Decimal True

The current total tax amount applied to the order, expressed in the shop's base currency as a decimal value.

CurrentTotalTaxSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the current total tax amount.

NetPaymentSetPresentmentMoneyAmount Decimal True

The net total payment amount for the order, expressed in the buyer's presentment currency as a decimal value.

NetPaymentSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the net payment amount.

NetPaymentSetShopMoneyAmount Decimal True

The net total payment amount for the order, expressed in the shop's base currency as a decimal value.

NetPaymentSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the net payment amount.

OriginalTotalAdditionalFeesSetPresentmentMoneyAmount Decimal True

The original total of all additional fees at the time the order was placed, expressed in the buyer's presentment currency as a decimal value.

OriginalTotalAdditionalFeesSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the original additional fees.

OriginalTotalAdditionalFeesSetShopMoneyAmount Decimal True

The original total of all additional fees at the time the order was placed, expressed in the shop's base currency as a decimal value.

OriginalTotalAdditionalFeesSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the original additional fees.

OriginalTotalDutiesSetPresentmentMoneyAmount Decimal True

The original total duties applied to the order at the time of placement, expressed in the buyer's presentment currency as a decimal value.

OriginalTotalDutiesSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the original duties amount.

OriginalTotalDutiesSetShopMoneyAmount Decimal True

The original total duties applied to the order at the time of placement, expressed in the shop's base currency as a decimal value.

OriginalTotalDutiesSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the original duties amount.

OriginalTotalPriceSetPresentmentMoneyAmount Decimal True

The original total order price, including taxes and discounts, expressed in the buyer's presentment currency as a decimal value.

OriginalTotalPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the original total order price.

OriginalTotalPriceSetShopMoneyAmount Decimal True

The original total order price, including taxes and discounts, expressed in the shop's base currency as a decimal value.

OriginalTotalPriceSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the original total order price.

PaymentCollectionDetailsAdditionalPaymentCollectionUrl String True

The URL used to collect an additional payment on the order if the original amount was insufficient.

RefundDiscrepancySetPresentmentMoneyAmount Decimal True

The discrepancy amount between the total refunded and the expected refund, expressed in the buyer's presentment currency as a decimal value.

RefundDiscrepancySetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the refund discrepancy amount.

RefundDiscrepancySetShopMoneyAmount Decimal True

The discrepancy amount between the total refunded and the expected refund, expressed in the shop's base currency as a decimal value.

RefundDiscrepancySetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the refund discrepancy amount.

SubtotalPriceSetPresentmentMoneyAmount Decimal True

The subtotal amount of the order before taxes and discounts, expressed in the buyer's presentment currency as a decimal value.

SubtotalPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the order subtotal.

SubtotalPriceSetShopMoneyAmount Decimal True

The subtotal amount of the order before taxes and discounts, expressed in the shop's base currency as a decimal value.

SubtotalPriceSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the order subtotal.

TotalCapturableSetPresentmentMoneyAmount Decimal True

The total amount still eligible for payment capture, expressed in the buyer's presentment currency as a decimal value.

TotalCapturableSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the capturable amount.

TotalCapturableSetShopMoneyAmount Decimal True

The total amount still eligible for payment capture, expressed in the shop's base currency as a decimal value.

TotalCapturableSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the capturable amount.

TotalDiscountsSetPresentmentMoneyAmount Decimal True

The total value of all discounts applied to the order, expressed in the buyer's presentment currency as a decimal value.

TotalDiscountsSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the total discount value.

TotalDiscountsSetShopMoneyAmount Decimal True

The total value of all discounts applied to the order, expressed in the shop's base currency as a decimal value.

TotalDiscountsSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the total discount value.

TotalOutstandingSetPresentmentMoneyAmount Decimal True

The total outstanding amount still due on the order, expressed in the buyer's presentment currency as a decimal value.

TotalOutstandingSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the outstanding order balance.

TotalOutstandingSetShopMoneyAmount Decimal True

The total outstanding amount still due on the order, expressed in the shop's base currency as a decimal value.

TotalOutstandingSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the outstanding order balance.

TotalPriceSetPresentmentMoneyAmount Decimal True

The total price of the order, including taxes, duties, and discounts, expressed in the buyer's presentment currency as a decimal value.

TotalPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the total order price.

TotalPriceSetShopMoneyAmount Decimal True

The total price of the order, including taxes, duties, and discounts, expressed in the shop's base currency as a decimal value.

TotalPriceSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the total order price.

TotalReceivedSetPresentmentMoneyAmount Decimal True

The total amount received for the order, expressed in the buyer's presentment currency as a decimal value.

TotalReceivedSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the total received amount.

TotalReceivedSetShopMoneyAmount Decimal True

The total amount received for the order, expressed in the shop's base currency as a decimal value.

TotalReceivedSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the total received amount.

TotalRefundedSetPresentmentMoneyAmount Decimal True

The total amount refunded for the order, expressed in the buyer's presentment currency as a decimal value.

TotalRefundedSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the total refunded amount.

TotalRefundedSetShopMoneyAmount Decimal True

The total amount refunded for the order, expressed in the shop's base currency as a decimal value.

TotalRefundedSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the total refunded amount.

TotalRefundedShippingSetPresentmentMoneyAmount Decimal True

The total amount refunded specifically for shipping charges, expressed in the buyer's presentment currency as a decimal value.

TotalRefundedShippingSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the refunded shipping amount.

TotalRefundedShippingSetShopMoneyAmount Decimal True

The total amount refunded specifically for shipping charges, expressed in the shop's base currency as a decimal value.

TotalRefundedShippingSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the refunded shipping amount.

TotalShippingPriceSetPresentmentMoneyAmount Decimal True

The total shipping cost for the order, expressed in the buyer's presentment currency as a decimal value.

TotalShippingPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the total shipping cost.

TotalShippingPriceSetShopMoneyAmount Decimal True

The total shipping cost for the order, expressed in the shop's base currency as a decimal value.

TotalShippingPriceSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the total shipping cost.

TotalTaxSetPresentmentMoneyAmount Decimal True

The total tax amount applied to the order, expressed in the buyer's presentment currency as a decimal value.

TotalTaxSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the total tax amount.

TotalTaxSetShopMoneyAmount Decimal True

The total tax amount applied to the order, expressed in the shop's base currency as a decimal value.

TotalTaxSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the total tax amount.

TotalTipReceivedSetPresentmentMoneyAmount Decimal True

The total value of all tips received for the order, expressed in the buyer's presentment currency as a decimal value.

TotalTipReceivedSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the total tips received.

TotalTipReceivedSetShopMoneyAmount Decimal True

The total value of all tips received for the order, expressed in the shop's base currency as a decimal value.

TotalTipReceivedSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the total tips received.

TotalCashRoundingAdjustmentPaymentSetPresentmentMoneyAmount Decimal True

The payment-side rounding adjustment amount, expressed in the buyer's presentment currency as a decimal value. Used to reconcile cash rounding differences.

TotalCashRoundingAdjustmentPaymentSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the payment-side rounding adjustment amount.

TotalCashRoundingAdjustmentPaymentSetShopMoneyAmount Decimal True

The payment-side rounding adjustment amount, expressed in the shop's base currency as a decimal value. Used to reconcile cash rounding differences.

TotalCashRoundingAdjustmentPaymentSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the payment-side rounding adjustment amount.

TotalCashRoundingAdjustmentRefundSetPresentmentMoneyAmount Decimal True

The refund-side rounding adjustment amount, expressed in the buyer's presentment currency as a decimal value. Used to reconcile cash rounding differences when issuing refunds.

TotalCashRoundingAdjustmentRefundSetPresentmentMoneyCurrencyCode String True

The ISO currency code representing the presentment currency for the refund-side rounding adjustment amount.

TotalCashRoundingAdjustmentRefundSetShopMoneyAmount Decimal True

The refund-side rounding adjustment amount, expressed in the shop's base currency as a decimal value. Used to reconcile cash rounding differences when issuing refunds.

TotalCashRoundingAdjustmentRefundSetShopMoneyCurrencyCode String True

The ISO currency code representing the shop's base currency for the refund-side rounding adjustment amount.

RetailLocationId String True

The unique identifier of the retail location associated with the order, if applicable.

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 unique identifier of the purchasing company's location tied to the order, when the order originates from a business customer account.

ReferringSite String

The external website or domain where the customer clicked a link that directed them to the shop.

SourceUrl String

The original source URL for the order on the originating platform. Displayed to merchants on the Order Details page when valid.

UserId String

The unique identifier of the user logged into Shopify POS who processed the order, if applicable.

DiscountCodeFreeShipping String

A discount code providing free shipping applied to the order's shipping charges.

DiscountCodeFixed String

A discount code applying a fixed monetary amount off the order's line items.

DiscountCodeFixedAmountSetPresentmentMoneyAmount Decimal

The fixed discount amount applied to the order, expressed in the buyer's presentment currency as a decimal value.

DiscountCodeFixedAmountSetPresentmentMoneyCurrencyCode String

The ISO currency code representing the presentment currency for the fixed discount amount.

DiscountCodeFixedAmountSetShopMoneyAmount Decimal

The fixed discount amount applied to the order, expressed in the shop's base currency as a decimal value.

DiscountCodeFixedAmountSetShopMoneyCurrencyCode String

The ISO currency code representing the shop's base currency for the fixed discount amount.

DiscountCodePercentage String

A discount code applying a percentage-based discount to the order's line items.

DiscountCodePercentageValue Double

The percentage value deducted from the order total when using a percentage-based discount code.

FulfillmentLocationId String

The unique identifier of the location from which the order is fulfilled.

FulfillmentNotifyCustomer Bool

Indicates whether the customer should be notified when fulfillment updates occur.

FulfillmentTrackingInfoNumber String

The tracking number associated with the order's fulfillment shipment.

FulfillmentTrackingInfoCompany String

The name of the shipping or courier company managing the fulfillment.

FulfillmentShipmentStatus String

The current status of the shipment, such as 'in_transit', 'delivered', or 'pending'.

FulfillmentOriginAddressAddress1 String

The first line of the fulfillment origin address, typically representing the street or warehouse location.

FulfillmentOriginAddressAddress2 String

The second line of the fulfillment origin address, often representing a suite, unit, or floor number.

FulfillmentOriginAddressCity String

The city or municipality where the fulfillment origin is located.

FulfillmentOriginAddressCountryCode String

The two-letter ISO country code representing the country of the fulfillment origin address.

FulfillmentOriginAddressProvinceCode String

The two-letter province or state code representing the region of the fulfillment origin address.

FulfillmentOriginAddressZip String

The postal or ZIP code for the fulfillment origin address.

OrderLineItems String

A collection of line item objects defining the products and quantities included in the order.

OrderShippingLines String

A list of shipping line objects detailing the shipping methods and rates applied to the order.

OrderTaxLines String

A list of tax line objects detailing all taxes applied to the order. Taxes can be defined at the order level or line-item level, but not both.

OrderTransactions String

A list of payment transaction objects recorded for the order, including captures, authorizations, and refunds.

OrderCustomAttributes String

A list of custom attributes or metadata attached to the order, visible under the 'Additional details' section in Shopify Admin.

Metafields String

A list of metafield objects used to store custom data or extensions related to the order.

OptionsInventoryBehaviour String

Specifies how inventory quantities are handled when updating the order. For example, 'decrement_obeying_policy'.

The allowed values are BYPASS, DECREMENT_IGNORING_POLICY, DECREMENT_OBEYING_POLICY.

OptionsSendFulfillmentRequest Bool

Indicates whether a fulfillment request should be sent to the fulfillment service provider when the order is processed.

OptionsSendReceipt Bool

Indicates whether an order confirmation email or receipt should be automatically sent to the customer after purchase.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454