Power BI Connector for Shopify

Build 25.0.9454

DraftOrders

Stores draft order records created by merchants, allowing manual invoice creation and checkout completion.

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.
  • Status 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 DraftOrders WHERE Id = 'Val1'
  SELECT * FROM DraftOrders WHERE Status = 'Val1'
  SELECT * FROM DraftOrders WHERE CreatedAt = '2023-01-01 11:10:00'
  SELECT * FROM DraftOrders WHERE UpdatedAt = '2023-01-01 11:10:00'
  SELECT * FROM DraftOrders WHERE CustomerId = 'Val1'

Insert

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

Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems (references DraftOrderLineItems), DiscountCodes, AcceptAutomaticDiscounts, AllowDiscountCodesInCheckout

DraftOrderLineItems Temporary Table Columns

Column NameTypeDescription
TitleStringThe title of the product or variant. This field only applies to custom line items.
QuantityIntThe number of product variants that are requested in the draft order.
SkuStringThe SKU number of the product variant.
TaxableBoolWhether the variant is taxable.
RequiresShippingBoolWhether physical shipping is required for the variant.
AppliedDiscountTitleStringName of the order-level discount.
AppliedDiscountDescriptionStringDescription of the order-level discount.
AppliedDiscountValueDoubleThe order level discount amount. If 'valueType' is 'percentage', then 'value' is the percentage discount.
AppliedDiscountValueTypeStringType of the order-level discount.
AppliedDiscountAmountV2AmountDecimalDecimal money amount.
VariantIdStringA globally-unique ID.
WeightValueDoubleThe weight value using the unit system specified with 'unit'.
WeightUnitStringThe unit of measurement for 'value'.

Update

The following columns can be updated:

Email, CustomerId, BillingAddressId, BillingAddressFirstName, BillingAddressLastName, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressProvinceCode, BillingAddressCountryCodeV2, ShippingAddressId, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressProvinceCode, ShippingAddressCountryCodeV2, AppliedDiscountTitle, AppliedDiscountDescription, AppliedDiscountValue, AppliedDiscountValueType, AppliedDiscountAmountV2Amount, DraftOrderLineItems (references DraftOrderLineItems), DiscountCodes, AcceptAutomaticDiscounts, AllowDiscountCodesInCheckout

DraftOrderLineItems Temporary Table Columns

Column NameTypeDescription
TitleStringThe title of the product or variant. This field only applies to custom line items.
QuantityIntThe number of product variants that are requested in the draft order.
SkuStringThe SKU number of the product variant.
TaxableBoolWhether the variant is taxable.
RequiresShippingBoolWhether physical shipping is required for the variant.
AppliedDiscountTitleStringName of the order-level discount.
AppliedDiscountDescriptionStringDescription of the order-level discount.
AppliedDiscountValueDoubleThe order level discount amount. If 'valueType' is 'percentage', then 'value' is the percentage discount.
AppliedDiscountValueTypeStringType of the order-level discount.
AppliedDiscountAmountV2AmountDecimalDecimal money amount.
VariantIdStringA globally-unique ID.
WeightValueDoubleThe weight value using the unit system specified with 'unit'.
WeightUnitStringThe unit of measurement for 'value'.

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally unique identifier for the draft order.

LegacyResourceId String True

The corresponding resource ID for this draft order in the REST Admin API.

Name String True

A unique name or identifier for the draft order, such as '#D1223', used to reference it within the store.

MarketName String True

The name of the market associated with the draft order, indicating which market settings and currency apply.

Email String False

The customer's email address used for sending notifications or invoices related to the draft order.

Note2 String True

An optional note or comment attached to the draft order, typically used by staff for internal context.

Phone String True

The phone number associated with the draft order, usually belonging to the customer or billing contact.

Ready Bool True

Indicates whether the draft order is finalized and ready to be completed. Some asynchronous operations must complete before it can be marked ready.

Status String True

The current processing state of the draft order, such as open, completed, or invoice sent.

Tags String True

A comma-separated list of tags applied to the draft order. Updating this field overwrites existing tags; to add new tags without overwriting, use a mutation.

CompletedAt Datetime True

The date and time when the draft order was converted into a completed order.

CurrencyCode String True

The three-letter ISO code representing the currency of the store at the time of the last update.

DefaultCursor String True

A default pagination cursor that retrieves the next draft order record when sorted ascending by ID.

InvoiceUrl String True

The URL for the draft order checkout page, included in the invoice email sent to the customer.

TaxExempt Bool True

Indicates whether the draft order is exempt from tax calculation.

TaxesIncluded Bool True

Indicates whether line item prices already include taxes.

TotalWeight String True

The combined total weight of all items in the draft order, measured in grams.

HasTimelineComment Bool True

Whether any timeline comments have been added by a merchant to the draft order.

InvoiceSentAt Datetime True

The date and time when the invoice email was last sent to the customer.

PresentmentCurrencyCode String True

The customer's currency used for payment on the draft order.

ReserveInventoryUntil Datetime True

The date and time until which the inventory for this draft order is reserved before being automatically restocked.

VisibleToCustomer Bool True

Whether the draft order is visible to the customer in their self-service portal.

InvoiceEmailTemplateSubject String True

The subject line used for the invoice email sent to the customer.

MarketRegionCountryCode String True

The two-letter country code of the market region associated with this draft order.

BillingAddressMatchesShippingAddress Bool True

Indicates whether the billing and shipping addresses are identical.

CreatedAt Datetime True

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

UpdatedAt Datetime True

The date and time of the most recent update to the draft order.

OrderId String True

The unique identifier of the order created from this draft order, if applicable.

PurchasingEntityCustomerId String True

The unique ID of the customer entity associated with the draft order.

PurchasingEntityCompanyCompanyId String True

The unique ID of the company associated with the purchasing entity.

CustomerId String False

Customers.Id

The unique ID of the customer who will receive the draft order invoice.

BillingAddressId String False

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

BillingAddressCoordinatesValidated Bool True

Indicates whether the billing address coordinates were successfully validated.

BillingAddressValidationResultSummary String True

A brief summary of the billing address validation result from Shopify Admin's address validation feature.

BillingAddressName String True

The customer's full name as listed in the billing address.

BillingAddressFirstName String False

The customer's first name as listed in the billing address.

BillingAddressLastName String False

The customer's last name as listed in the billing address.

BillingAddressAddress1 String False

The first line of the billing address, typically the street address or P.O. Box.

BillingAddressAddress2 String False

The second line of the billing address, such as apartment, suite, or unit number.

BillingAddressCity String False

The city or town listed on the billing address.

BillingAddressCompany String False

The company name associated with the billing address, if provided.

BillingAddressCountry String False

The full name of the billing address country.

BillingAddressLatitude Double True

The latitude coordinate for the billing address location.

BillingAddressLongitude Double True

The longitude coordinate for the billing address location.

BillingAddressPhone String False

The billing contact's phone number, formatted per the E.164 standard (for example, +16135551111).

BillingAddressProvince String False

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

BillingAddressZip String False

The postal or ZIP code for the billing address.

BillingAddressFormattedArea String True

A formatted combination of city, province, and country for the billing address.

BillingAddressProvinceCode String False

The two-letter code representing the province or state (for example, ON).

BillingAddressCountryCodeV2 String False

The two-letter ISO code for the billing address country (for example, US).

ShippingAddressId String False

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

ShippingAddressCoordinatesValidated Bool True

Indicates whether the shipping address coordinates were successfully validated.

ShippingAddressValidationResultSummary String True

A summary of the shipping address validation result from Shopify Admin's validation feature.

ShippingAddressName String True

The customer's full name as listed in the shipping address.

ShippingAddressFirstName String False

The customer's first name as listed in the shipping address.

ShippingAddressLastName String False

The customer's last name as listed in the shipping address.

ShippingAddressAddress1 String False

The first line of the shipping address, typically the street address or P.O. Box.

ShippingAddressAddress2 String False

The second line of the shipping address, such as apartment, suite, or unit number.

ShippingAddressCity String False

The city or town listed on the shipping address.

ShippingAddressCompany String False

The company name associated with the shipping address, if provided.

ShippingAddressCountry String False

The full name of the shipping address country.

ShippingAddressLatitude Double True

The latitude coordinate for the shipping address location.

ShippingAddressLongitude Double True

The longitude coordinate for the shipping address location.

ShippingAddressPhone String False

The shipping contact's phone number, formatted per the E.164 standard (for example, +16135551111).

ShippingAddressProvince String False

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

ShippingAddressZip String False

The postal or ZIP code for the shipping address.

ShippingAddressFormattedArea String True

A formatted combination of city, province, and country for the shipping address.

ShippingAddressProvinceCode String False

The two-letter code representing the province or state (for example, ON).

ShippingAddressCountryCodeV2 String False

The two-letter ISO code for the shipping address country (for example, US).

ShippingLineId String True

The unique identifier for the shipping line associated with this draft order.

ShippingLineCarrierIdentifier String True

A reference to the carrier service that provided the shipping rate, if it was computed by a third-party carrier.

ShippingLineTitle String True

The title or display name of the selected shipping method.

ShippingLineCode String True

An internal reference code for the shipping method.

ShippingLineCustom Bool True

Indicates whether the shipping line was manually entered rather than generated automatically.

ShippingLinePhone String True

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

ShippingLineSource String True

The origin of the shipping rate, indicating how it was generated or selected.

ShippingLineDeliveryCategory String True

A high-level classification of the delivery method, such as standard or express.

ShippingLineShippingRateHandle String True

A system-generated unique identifier for the shipping rate, used internally by Shopify.

ShippingLineRequestedFulfillmentServiceId String True

The unique identifier of the fulfillment service responsible for fulfilling this shipping line.

AppliedDiscountTitle String False

The name or label of the applied discount at the order level.

AppliedDiscountDescription String False

A brief explanation of the applied discount.

AppliedDiscountValue Double False

The numeric value of the order-level discount. If the value type is percentage, this represents the percentage value.

AppliedDiscountValueType String False

Specifies the type of discount value, such as fixed amount or percentage.

PaymentTermsId String True

The unique identifier for the payment terms associated with this draft order.

PaymentTermsTranslatedName String True

The translated name of the payment terms as shown in the shop admin's preferred language.

PaymentTermsPaymentTermsName String True

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

PaymentTermsOverdue Bool True

Whether the payment terms are past due based on the template's schedule.

PaymentTermsDueInDays Int True

The number of days between the invoice issue date and due date, based on the applied payment terms.

PaymentTermsPaymentTermsType String True

The type of payment terms used for this draft order, such as net or fixed-date.

PaymentTermsOrderId String True

The unique identifier of the order associated with the payment terms.

AppliedDiscountAmountV2Amount Decimal False

The monetary amount of the applied discount in the store's currency.

AppliedDiscountAmountV2CurrencyCode String True

The ISO currency code for the applied discount amount.

LineItemsSubtotalPricePresentmentMoneyAmount Decimal True

The subtotal price of all line items in the customer's currency before discounts or taxes.

LineItemsSubtotalPricePresentmentMoneyCurrencyCode String True

The ISO currency code of the subtotal in the customer's presentment currency.

LineItemsSubtotalPriceShopMoneyAmount Decimal True

The subtotal price of all line items in the shop's primary currency before discounts or taxes.

LineItemsSubtotalPriceShopMoneyCurrencyCode String True

The ISO currency code of the subtotal in the shop's currency.

SubtotalPriceSetPresentmentMoneyAmount Decimal True

The total price of the draft order's items before taxes and discounts, in the customer's currency.

SubtotalPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code for the subtotal in the customer's presentment currency.

SubtotalPriceSetShopMoneyAmount Decimal True

The total price of the draft order's items before taxes and discounts, in the shop's currency.

SubtotalPriceSetShopMoneyCurrencyCode String True

The ISO currency code for the subtotal in the shop's currency.

TotalDiscountsSetPresentmentMoneyAmount Decimal True

The total discount amount in the customer's currency.

TotalDiscountsSetPresentmentMoneyCurrencyCode String True

The ISO currency code for total discounts in the customer's currency.

TotalDiscountsSetShopMoneyAmount Decimal True

The total discount amount in the shop's currency.

TotalDiscountsSetShopMoneyCurrencyCode String True

The ISO currency code for total discounts in the shop's currency.

TotalLineItemsPriceSetPresentmentMoneyAmount Decimal True

The total price of all line items before tax, in the customer's currency.

TotalLineItemsPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code for line item totals in the customer's currency.

TotalLineItemsPriceSetShopMoneyAmount Decimal True

The total price of all line items before tax, in the shop's currency.

TotalLineItemsPriceSetShopMoneyCurrencyCode String True

The ISO currency code for line item totals in the shop's currency.

TotalPriceSetPresentmentMoneyAmount Decimal True

The overall total for the draft order, including taxes and shipping, in the customer's currency.

TotalPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code for the total price in the customer's currency.

TotalPriceSetShopMoneyAmount Decimal True

The overall total for the draft order, including taxes and shipping, in the shop's currency.

TotalPriceSetShopMoneyCurrencyCode String True

The ISO currency code for the total price in the shop's currency.

TotalShippingPriceSetPresentmentMoneyAmount Decimal True

The total shipping cost in the customer's currency.

TotalShippingPriceSetPresentmentMoneyCurrencyCode String True

The ISO currency code for the shipping cost in the customer's currency.

TotalShippingPriceSetShopMoneyAmount Decimal True

The total shipping cost in the shop's currency.

TotalShippingPriceSetShopMoneyCurrencyCode String True

The ISO currency code for the shipping cost in the shop's currency.

TotalTaxSetPresentmentMoneyAmount Decimal True

The total tax amount in the customer's currency.

TotalTaxSetPresentmentMoneyCurrencyCode String True

The ISO currency code for the tax total in the customer's currency.

TotalTaxSetShopMoneyAmount Decimal True

The total tax amount in the shop's currency.

TotalTaxSetShopMoneyCurrencyCode String True

The ISO currency code for the tax total in the shop's currency.

DraftOrderLineItems String False

A list of all product line items included in the draft order.

DiscountCodes String False

A list of discount codes applied to the draft order.

AcceptAutomaticDiscounts Bool False

Indicates whether automatic discounts should be applied when calculating totals.

AllowDiscountCodesInCheckout Bool False

Whether customers can use discount codes during checkout for this draft order.

Warnings String True

A list of any warnings or validation messages generated during draft order calculation.

PlatformDiscountIds String True

A list of platform-level discount identifiers applied to this draft order.

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