Code Assist MCP for Shopify

Build 25.0.9540

Orders

Stores order headers with customer, payment, fulfillment, pricing, and tax information across the order lifecycle.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

A unique numeric identifier for the order.

Number Long True

The sequential order number assigned by Shopify, visible to both the merchant and customer.

CustomerId Long False

Customers.Id

The unique numeric identifier for the customer who placed the order.

CustomerFirstName String False

The first name of the customer who placed the order.

CustomerLastName String False

The last name of the customer who placed the order.

Currency String False

The three-letter ISO 4217 currency code used for payment.

Email String False

The customer's email address associated with the order.

Name String True

The unique name or reference number assigned to the order.

TotalDiscounts Decimal True

The total discount amount applied to the order.

TotalOrderItemsPrice Decimal True

The combined price of all order items before taxes, shipping, and discounts.

TotalPrice Decimal True

The final order total including taxes, shipping, and discounts.

SubtotalPrice Decimal True

The subtotal of the order before taxes and shipping are added.

TotalTax Decimal False

The total tax applied to the order.

TotalWeight Int True

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

BrowserIp String True

The IP address of the browser used when the order was placed.

MerchantBusinessEntityId String True

The unique identifier of the business entity associated with the order.

BuyerAcceptsMarketing Bool False

Whether the buyer agreed to receive marketing communications from the store.

CancelReason String True

The reason the order was canceled, if applicable.

CartToken String True

A unique token identifying the cart from which the order was created.

OrderStatusUrl String True

The URL for the customer-facing order status page.

Token String True

A unique token associated with the order, used internally for API operations.

TaxesIncluded Bool False

Indicates whether taxes are included in the subtotal.

SourceName String True

The channel or system that originated the order (e.g., web, POS, app).

ReferringSite String True

The website or referral source from which the customer arrived.

Phone String False

The customer's phone number associated with the order.

Note String False

An optional note attached to the order by the merchant.

LocationId Long True

The unique numeric identifier of the location where the order was processed.

LandingSite String True

The URL where the buyer entered the store before checkout.

Tags String False

A comma-separated list of tags assigned to the order for categorization or filtering.

FulfillmentStatus String False

The fulfillment status of the order.

使用できる値は次のとおりです。shipped, partial, unshipped, any, unfulfilled, fulfilled, null, restocked

FinancialStatus String False

The financial state of the order.

使用できる値は次のとおりです。authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid

CustomerLocale String True

The locale of the customer, such as 'en', 'en-US', or 'fr-CA'.

InvoiceSentAt Datetime True

The timestamp when the invoice email was sent to the customer. Available only for draft orders.

InvoiceUrl String True

The URL of the customer invoice. Available only for draft orders.

TaxExempt Bool True

Whether taxes are exempt for this order. Applicable to draft orders.

DiscountCodes String True

A list of discount codes applied to the order.

LineAggregate String False

A JSON aggregate containing all line items associated with the order.

TaxAggregate String False

A JSON aggregate of order-level tax lines. Use line-level tax data from LineAggregate when applicable.

ShippingAggregate String False

A JSON aggregate of all shipping line items associated with the order.

NoteAttributesAggregate String False

A JSON aggregate of all note attributes attached to the order.

DiscountApplicationsAggregate String True

A JSON aggregate of applied discount applications in order of application.

BillingAddressFirstName String False

The first name on the billing address.

BillingAddressLastName String False

The last name on the billing address.

BillingAddressAddress1 String False

The first line of the billing address.

BillingAddressAddress2 String False

An additional line for the billing address.

BillingAddressPhone String False

The phone number at the billing address.

BillingAddressCity String False

The city of the billing address.

BillingAddressCompany String False

The company associated with the billing address, if applicable.

BillingAddressZip String False

The postal or ZIP code of the billing address.

BillingAddressProvince String False

The state or province of the billing address.

BillingAddressCountry String False

The country of the billing address.

BillingAddressLatitude Double False

The latitude coordinate of the billing address.

BillingAddressLongitude Double False

The longitude coordinate of the billing address.

BillingAddressName String False

The full name of the person associated with the billing address.

BillingAddressCountryCode String False

The two-letter country code for the billing address.

BillingAddressProvinceCode String False

The two-letter province or state code for the billing address.

BillingAddressDefault Bool False

Whether this is the default billing address for the customer.

ShippingAddressFirstName String False

The first name on the shipping address.

ShippingAddressLastName String False

The last name on the shipping address.

ShippingAddressAddress1 String False

The first line of the shipping address.

ShippingAddressAddress2 String False

An additional line for the shipping address.

ShippingAddressPhone String False

The phone number at the shipping address.

ShippingAddressCity String False

The city of the shipping address.

ShippingAddressCompany String False

The company associated with the shipping address, if applicable.

ShippingAddressZip String False

The postal or ZIP code of the shipping address.

ShippingAddressProvince String False

The state or province of the shipping address.

ShippingAddressCountry String False

The country of the shipping address.

ShippingAddressLatitude Double False

The latitude coordinate of the shipping address.

ShippingAddressLongitude Double False

The longitude coordinate of the shipping address.

ShippingAddressName String False

The full name of the person associated with the shipping address.

ShippingAddressCountryCode String False

The two-letter country code for the shipping address.

ShippingAddressProvinceCode String False

The two-letter province or state code for the shipping address.

ShippingAddressDefault Bool False

Whether this is the default shipping address for the customer.

AppliedDiscountTitle String False

The name of the discount applied to this order. Available only for draft orders.

AppliedDiscountDescription String False

A short description of the applied discount. Available only for draft orders.

AppliedDiscountValue Decimal False

The value of the applied discount. Available only for draft orders.

AppliedDiscountValueType String False

The type of discount value (e.g., percentage or fixed). Available only for draft orders.

AppliedDiscountAmount Decimal False

The total discount amount applied. Available only for draft orders.

PaymentTermsAmount Long True

The amount due under the defined payment terms.

PaymentTermsCurrency String True

The currency for the payment terms amount.

PaymentTermsPaymentTermsName String True

The name of the payment terms template applied to the order.

PaymentTermsPaymentTermsType String True

The type of payment terms (e.g., NET_30, FULL, or custom).

PaymentTermsDueInDays Int True

The number of days between the invoice date and payment due date.

PaymentTermsPaymentSchedules String True

A JSON array of payment schedule details defined by the payment terms.

ProcessedAt Datetime True

The timestamp when the order was imported or processed.

CreatedAt Datetime True

The timestamp when the order was created.

ClosedAt Datetime True

The timestamp when the order was closed.

CancelledAt Datetime True

The timestamp when the order was canceled.

UpdatedAt Datetime True

The timestamp when the order was last updated.

SendReceipt Bool False

Whether an order confirmation email is sent to the customer.

SendFulfillmentReceipt Bool False

Whether a fulfillment confirmation email is sent to the customer.

InventoryBehaviour String False

Determines how inventory quantities are adjusted. Possible values: default, decrement_ignoring_policy, decrement_obeying_policy.

使用できる値は次のとおりです。default, decrement_ignoring_policy, decrementobeying_policy

Operation String False

The operation applied to the order, such as Close, Open, or Cancel.

使用できる値は次のとおりです。Close, Open, Cancel

TotalShippingPriceSetShopMoneyAmount Double True

The total shipping cost in shop currency.

TotalShippingPriceSetShopMoneyCurrencyCode String True

The currency of the shop for the total shipping cost.

TotalShippingPriceSetPresentmentMoneyAmount Decimal True

The total shipping cost in presentment currency.

TotalPriceSetShopMoneyAmount Decimal True

The total price in shop currency.

TotalPriceSetPresentmentMoneyAmount Decimal True

The total price in presentment currency.

TotalTaxSetShopMoneyAmount Decimal True

The total tax in shop currency.

TotalTaxSetPresentmentMoneyAmount Decimal True

The total tax in presentment currency.

CheckoutId Long True

The unique ID of the checkout session that created the order.

CheckoutToken String True

A unique token representing the checkout associated with the order.

EstimatedTaxes Bool True

Whether taxes for this order were estimated.

Test Bool True

Indicates whether this order was created in test mode.

TotalOutstanding Decimal True

The remaining balance still owed on the order.

TotalTipReceived Decimal True

The total tip amount included in the order.

PresentmentCurrency String True

The currency used for presenting amounts to the buyer.

TotalLineItemsPriceSetShopMoneyAmount Decimal True

The total line item price in shop currency.

TotalLineItemsPriceSetPresentmentMoneyAmount Decimal True

The total line item price in presentment currency.

TotalDiscountsSetShopMoneyAmount Decimal True

The total discount amount in shop currency.

TotalDiscountsSetPresentmentMoneyAmount Decimal True

The total discount amount in presentment currency.

TotalSubtotalSetShopMoneyAmount Decimal True

The subtotal amount in shop currency.

TotalSubtotalSetPresentmentMoneyAmount Decimal True

The subtotal amount in presentment currency.

OrigTotalAdditionalFeesSetShopMoneyAmount Decimal True

The original total additional fees in shop currency.

OrigTotalAdditionalFeesSetPresentmentMoneyAmount Decimal True

The original total additional fees in presentment currency.

CurTotalDiscountsSetShopMoneyAmount Decimal True

The current total discount amount in shop currency.

CurTotalDiscountsSetPresentmentMoneyAmount Decimal True

The current total discount amount in presentment currency.

CurSubtotalPriceSetShopMoneyAmount Decimal True

The current subtotal in shop currency.

CurSubtotalPriceSetPresentmentMoneyAmount Decimal True

The current subtotal in presentment currency.

CurrentTotalTaxSetShopMoneyAmount Decimal True

The current total tax amount in shop currency.

CurrentTotalTaxSetPresentmentMoneyAmount Decimal True

The current total tax amount in presentment currency.

CurTotalAdditionalFeesSetShopMoneyAmount Decimal True

The current total additional fees in shop currency.

CurTotalAdditionalFeesSetPresentmentMoneyAmount Decimal True

The current total additional fees in presentment currency.

CurrentTotalPriceSetShopMoneyAmount Decimal True

The current total price in shop currency.

CurrentTotalPriceSetPresentmentMoneyAmount Decimal True

The current total price in presentment currency.

OriginalTotalDutiesSetShopMoneyAmount Decimal True

The original total duties in shop currency.

OriginalTotalDutiesSetPresentmentMoneyAmount Decimal True

The original total duties in presentment currency.

CurrentTotalDutiesSetShopMoneyAmount Decimal True

The current total duties in shop currency.

CurrentTotalDutiesSetPresentmentMoneyAmount Decimal True

The current total duties in presentment currency.

PaymentGatewayNames String True

A list of payment gateway names used for processing the order.

FulfillmentAggregate String True

A JSON aggregate of fulfillments associated with this order.

RefundAggregate String True

A JSON aggregate of refunds associated with this order.

ConfirmationNumber String True

A randomly generated alphanumeric identifier sometimes displayed to customers instead of the sequential order name.

Pseudo-Columns

疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。

Name Type Description
Status String

Specifies the order status filter. Possible values: open, closed, cancelled, any. Default: open.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9540