Power BI Connector for Shopify

Build 25.0.9454

Orders

Lists orders with customer, payment, fulfillment, duty, and tax details.

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.
  • Namespace supports the '=, IN' comparison operators.
  • Key supports the '=, IN' comparison operators.
  • Value supports the '=, IN' 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'
  SELECT * FROM Orders WHERE Namespace = 'Val1'
  SELECT * FROM Orders WHERE Key = 'Val1'
  SELECT * FROM Orders WHERE Value = '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

A globally unique Id.

Number String True

The purchase order number associated with this order.

Unpaid Bool True

Indicates whether no payments have been made for the order.

FullyPaid Bool True

Indicates 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 identifier shown 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

Indicates whether payment for the order can be captured.

Closed Bool True

Indicates whether the order is closed.

Confirmed Bool True

Indicates whether inventory has been reserved for the order.

Edited Bool True

Indicates whether the order has had any edits applied.

Email String False

The email address associated with the customer.

Fulfillable Bool True

Indicates whether there are line items that can be fulfilled. 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

Indicates whether the order can be refunded.

Restockable Bool True

Indicates 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 previously added to the order. To add new tags without overwriting existing tags, use the mutation.

Test Bool True

Indicates 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 alphanumeric identifier for the order that might be shown to the customer instead of the sequential order name. For example, XPAV284CT, R50KELTJP, or 35PKUN0UJ. This value is not 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

Indicates whether taxes on the order are estimated. Returns 'false' when taxes on the order are finalized and aren't 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. This might not match the date and time when the order was created.

RequiresShipping Bool True

Indicates whether the order has shipping lines or at least one line item that requires shipping.

RiskRecommendation String True

The recommendation for the order based on the results of the risk assessments (suggested merchant action regarding fraud risk).

ReturnStatus String True

The order's aggregated return status for display purposes.

TaxesIncluded Bool True

Indicates whether taxes are included in the subtotal price of the order.

DutiesIncluded Bool True

Indicates 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

Indicates whether a customer email exists for the order.

CurrentTotalWeight String True

The total weight of the order after returns, in grams.

CustomerAcceptsMarketing Bool True

Indicates whether the customer agreed to receive marketing materials.

DisplayFinancialStatus String True

The financial status of the order that can be shown to the merchant. Use only for display summary.

DisplayFulfillmentStatus String True

The fulfillment status of the order that can be shown to the merchant. Use only for display summary. For granular details, refer to the object.

FulfillmentsCount Int True

The count of fulfillments, including canceled fulfillments.

FulfillmentsCountPrecision String True

The count's precision, or the exactness of the value.

HasTimelineComment Bool True

Indicates whether the merchant added a timeline comment to the order.

MerchantEditableErrors String True

A list of reasons why the order cannot be edited. For example, 'Canceled orders cannot be edited'.

PresentmentCurrencyCode String True

The customer's payment currency code 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 quantities for all line items that contribute to the order's subtotal price.

BillingAddressMatchesShippingAddress Bool True

Indicates whether the billing address matches the shipping address.

CurrentSubtotalLineItemsQuantity Int True

The sum of quantities for all line items that contribute to the order's current subtotal price.

CreatedAt Datetime True

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

UpdatedAt Datetime True

The date and time when the order was last modified.

StaffMemberId String True

The staff member associated with the order. (Available only with a Shopify Plus subscription.)

AppId String True

The application Id.

MerchantOfRecordAppId String True

The unique identifier for the app designated as the merchant of record.

MerchantBusinessEntityId String True

The unique identifier for the merchant's business entity record in Shopify.

PhysicalLocationId String True

The unique identifier for a physical location (such as a retail store, warehouse, or fulfillment center).

ChannelInformationId String True

The unique identifier for the channel information object that links sales activity to a channel.

ChannelInformationChannelId String True

The unique identifier for the sales channel (for example, Online Store, POS, or a third-party channel).

ChannelInformationAppId String True

The unique identifier for the app associated with the sales channel.

PublicationId String True

The unique identifier for a publication that makes products available to a sales channel.

PurchasingEntityCustomerId String True

The unique identifier for the customer who is acting as the purchasing entity.

PurchasingEntityCompanyId String True

The unique identifier for the company that is acting as the purchasing entity (business-to-business).

CustomerId String True

The unique identifier for a customer record in Shopify.

CustomerFirstName String True

The customer's first name.

CustomerLastName String True

The customer's last name.

CustomerJourneySummaryReady Bool True

Indicates 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 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 is since the last order, or the first within the 30-day attribution window.

CustomerJourneySummaryFirstVisitId String True

A globally unique Id.

CustomerJourneySummaryFirstVisitSource String True

The source from which the customer visited the store (for example, a platform such as Facebook or Google, email, direct, domain, QR code, or unknown).

CustomerJourneySummaryFirstVisitLandingPage String True

The 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 URL attributes: ref, source, or r.

CustomerJourneySummaryFirstVisitReferrerUrl String True

The webpage where the customer clicked a link that sent them to the online store.

CustomerJourneySummaryFirstVisitSourceDescription String True

A description that explicitly names the source for the first or last session.

CustomerJourneySummaryFirstVisitSourceType String True

The type of marketing tactic.

CustomerJourneySummaryFirstVisitLandingPageHtml String True

Landing page information with URL linked in HTML.

CustomerJourneySummaryFirstVisitReferralInfoHtml String True

Referral information with URLs linked in HTML.

CustomerJourneySummaryLastVisitId String True

A globally unique Id.

CustomerJourneySummaryLastVisitSource String True

The source from which the customer visited the store (for example, Facebook, Google, email, direct, domain, QR code, or unknown).

CustomerJourneySummaryLastVisitLandingPage String True

The 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 URL attributes: ref, source, or r.

CustomerJourneySummaryLastVisitReferrerUrl String True

The webpage where the customer clicked a link that sent them to the online store.

CustomerJourneySummaryLastVisitSourceDescription String True

A description that explicitly names the source for the first or last session.

CustomerJourneySummaryLastVisitSourceType String True

The type of marketing tactic.

CustomerJourneySummaryLastVisitLandingPageHtml String True

Landing page information with URL linked in HTML.

CustomerJourneySummaryLastVisitReferralInfoHtml String True

Referral information with URLs linked in HTML.

DisplayAddressId String True

A globally unique Id.

DisplayAddressCoordinatesValidated Bool True

Indicates whether the address coordinates are valid.

DisplayAddressValidationResultSummary String True

The validation status 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 customer's first name.

DisplayAddressLastName String True

The customer's last name.

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).

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 the 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 city, province, and country.

DisplayAddressProvinceCode String True

The two-letter region code (for example, ON).

DisplayAddressCountryCodeV2 String True

The two-letter country code (for example, US).

BillingAddressId String True

A globally unique Id.

BillingAddressCoordinatesValidated Bool True

Indicates whether the address coordinates are valid.

BillingAddressValidationResultSummary String True

The validation status 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 customer's first name.

BillingAddressLastName String True

The customer's last name.

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 an 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 the 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 city, province, and country.

BillingAddressProvinceCode String True

The two-letter region code (for example, ON).

BillingAddressCountryCodeV2 String True

The two-letter country code (for example, US).

ShippingAddressId String False

A globally unique Id.

ShippingAddressCoordinatesValidated Bool True

Indicates whether the address coordinates are valid.

ShippingAddressValidationResultSummary String True

The validation status 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 customer's first name.

ShippingAddressLastName String False

The customer's last name.

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 an 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 the 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 city, province, and country.

ShippingAddressProvinceCode String False

The two-letter region code (for example, ON).

ShippingAddressCountryCodeV2 String False

The two-letter country code (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

The title of the shipping line.

ShippingLineCode String True

A reference to the shipping method.

ShippingLineCustom Bool True

Indicates whether the shipping line is custom.

ShippingLinePhone String True

The phone number at the shipping address.

ShippingLineSource String True

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 isn't 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

Indicates whether the payment terms have overdue payment schedules.

PaymentTermsDueInDays Int True

The duration of the payment terms in days based on the template used.

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 collect 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.

Namespace String True

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Key String True

The key for the metafield.

Value String True

The value of the metafield.

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. Displayed to merchants on the Order Details page. Invalid URLs aren't shown.

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 shipping on an order.

DiscountCodeFixed String

A fixed-amount discount code applied to 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 line items on the order.

DiscountCodePercentageValue Double

The amount deducted from the order total. When creating an order, this value is the percentage to deduct.

FulfillmentLocationId String

The Id of the location to fulfill the order from.

FulfillmentNotifyCustomer Bool

Indicates whether the customer should be notified of fulfillment changes.

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 (apartment, suite, or unit).

FulfillmentOriginAddressCity String

The city of the fulfillment location.

FulfillmentOriginAddressCountryCode String

The country of the fulfillment location.

FulfillmentOriginAddressProvinceCode String

The province of the fulfillment location.

FulfillmentOriginAddressZip String

The ZIP/postal code of the fulfillment location.

OrderLineItems String

The line items to create for the order.

OrderShippingLines String

A list of shipping method objects used for the order.

OrderTaxLines String

A list of tax line objects for 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.

OrderTransactions String

The payment transactions to create for the order.

OrderCustomAttributes String

A list of extra information added to the order. Appears in the Additional details section of the order details page.

Metafields String

A list of metafields to add to the order.

OptionsInventoryBehaviour String

The behavior to use when updating inventory.

The allowed values are BYPASS, DECREMENT_IGNORING_POLICY, DECREMENT_OBEYING_POLICY.

OptionsSendFulfillmentRequest Bool

Indicates whether to send a shipping confirmation to the customer.

OptionsSendReceipt Bool

Indicates whether to send an order confirmation to the customer.

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