Name

The unique identifier for an order, combining the sequential order number with any prefix or suffix set in store settings. Used for order tracking and display.

Alphanumeric string

450789469

Send Receipt

Indicates whether an order receipt email should be sent to the customer upon order creation. Controls automated communication for purchase confirmation

Boolean (true or false)Default: false

FALSE

Inventory Behaviour

Defines the behavior to use when updating inventory during order creation.

bypass: Do not claim / inventory.decrement_ignoring_policy: Ignore the product’s inventory policy and claim all amounts / regardless.decrement_obeying_policy: Obey the product’s inventory policy when claiming inventory. [ Default: bypass ]

bypass

Number

Represents the unique identifier assigned to an order, If an order has multiple rows, all rows for that order should share the same number and be positioned next to each other.

Integer

1001

Phone

Represents the customer's phone number associated with the order. This can be used for order confirmations, shipping updates, or customer communication.

String

0123 245 666

Email

Represents the customer's email address associated with the order. This is used for order confirmations, notifications, and customer communicatio

String (valid email format

customer@example.com

Note

A custom note or message attached to the order, typically used for internal comments, special instructions, or additional customer details.

String

Please pack as a gif

Tags

A list of keywords or labels associated with the order, used for categorization, filtering, or internal organization

String (comma-separated values).

VIP, Holiday Sale, Priority Shipping

Cancelled At

Indicates the timestamp when an order was canceled. If the order is not canceled, this field remains empty.

String (ISO 8601 datetime format).

2024-02-28T14:30:00Z

Cancel: Reason

Specifies the reason why the order was canceled. This helps track cancellations for reporting and customer service purposes.

String

Customer requested cancellation

Cancel: Send Receipt

Indicates whether a cancellation email should be sent to the customer when an order is canceled.

Boolean (true / false)

TRUE

Cancel: Refund

Indicates whether the order should be refunded when canceled. If set to true, a refund process will be triggered along with the cancellation.

Boolean (true / false).

TRUE

Processed At

Indicates the timestamp when the order was processed. This typically refers to the time the order was completed or confirmed in the system.

String (ISO 8601 datetime format).

2024-02-28T14:30:00Z

Closed At

Indicates the timestamp when the order was closed. An order is considered closed when no further actions (such as fulfillment or payment processing) are required.

String (ISO 8601 datetime format).

2024-02-28T14:30:00Z"

Currency

Specifies the currency used for the order, typically represented in the ISO 4217 three-letter currency code format.

String (ISO 4217 currency code).

USD

Source

Indicates the platform, channel, or method through which the order was created. This helps track the origin of orders for reporting and analytics.

String

Online Store

Source Identifier

A unique identifier for the specific source or channel through which the order was created. This is useful for tracking orders from different integrations or sales channels.

String

facebook_shop_12345

Source URL

The URL of the source where the order was placed. This helps track the exact webpage or referral link from which the order originated.

String

https://example.com/landing-page

Weight Total

The total weight of all items in the order, typically used for shipping calculations and logistics.

Decimal

2.5

Tax 1: Title

The name or title of the first tax applied to the order. This helps identify the type of tax being charged.

String

VAT

Tax 1: Rate

The tax rate applied to the first tax on the order, expressed as a decimal. This represents the percentage of tax charged on applicable items.

Decimal

0.05

Tax 1: Price

The total tax amount charged for the first tax applied to the order. This is calculated based on the tax rate and taxable item prices.

Decimal

02.05

Tax 2: Title

The name or title of the second tax applied to the order. This helps identify an additional tax type being charged.

String

State Tax

Tax 2: Rate

The tax rate applied to the second tax on the order, expressed as a decimal. This represents the percentage of tax charged on applicable items.

Decimal

0.07

Tax 2: Price

The total tax amount charged for the second tax applied to the order. This is calculated based on the tax rate and taxable item prices.

Decimal

3.75

Tax 3: Title

The name or title of the third tax applied to the order. This helps identify an additional tax type being charged

String

Local Tax

Tax 3: Rate

The tax rate applied to the third tax on the order, expressed as a decimal. This represents the percentage of tax charged on applicable items.

Decimal

25

Tax 3: Price

The total tax amount charged for the third tax applied to the order. This is calculated based on the tax rate and taxable item prices.

Decimal

1.25

Tax: Included

Indicates whether taxes are included in the order's total price. If set to true, the product prices already include taxes; if false, taxes are added separately.

Boolean (true / false).

TRUE

Tax: Total

The total amount of tax charged for the entire order, summing all applicable taxes.

Decimal

7.50

Fulfillment

Indicates the current status of the payment for the order. This helps track whether the payment has been completed, is pendiCreated Atng, or has failed.

String

paid

Additional Details

Stores any extra payment-related details or metadata associated with the order. This can include transaction-specific information such as payment method details, authorization codes, or additional notes from the payment gateway

String

Paid via PayPal, Transaction ID: 123456789"

Customer: ID

The unique identifier assigned to the customer who placed the order. This lineID is used to track customer details, order history, and related transactions.

String or Integer (depending on the platform's ID format)

123456

Customer: Email

The email address associated with the customer who placed the order. This is used for communication, order confirmations, and customer records.

String (valid email format).

customer@example.com

Customer: Phone

The phone number associated with the customer who placed the order. This can be used for contact purposes, order updates, and support.

String (valid phone number format, may include country code).

-5244

Customer: First Name

The first name of the customer who placed the order. This is used for personalization, billing, and customer records.

String

John

Customer: Last Name

The last name of the customer who placed the order. This is used for personalization, billing, and customer records.

String

Doe

Customer: Note

A note or special instruction associated with the customer. This can include preferences, internal remarks, or additional details relevant to the order.

String

VIP customer - handle with priority

Customer: State

The state, province, or region associated with the customer's billing address. This helps determine tax calculations, shipping rates, and location-based services.

String

California

Customer: Tags

A set of labels or keywords associated with the customer. These tags help categorize customers for segmentation, marketing campaigns, or internal management.

String (comma-separated values for multiple tags)

VIP, Repeat Customer, Wholesale

Billing: First Name

The first name of the person associated with the billing address. This is used for invoicing, payment processing, and customer records.

String

John

Billing: Last Name

The last name of the person associated with the billing address. This is used for invoicing, payment processing, and customer records.

String

Doe

Billing: Name

The full name of the person associated with the billing address. This is used for invoicing, payment processing, and customer records.

String

John Doe

Billing: Company

The company name associated with the billing address. This is typically used for business orders, invoicing, and tax documentation.

String

Acme Corporation

Billing: Phone

The phone number associated with the billing address. This is used for customer support, invoicing, and order verification.

String (valid phone number format, may include country code).

-5244

Billing: Address 1

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

String

123 Main St

Billing: Address 2

The second line of the billing address, typically used for apartment, suite, unit number, or additional address details.

String

Apt 4B

Billing: Zip

The postal or ZIP code associated with the billing address. This is used for tax calculations, shipping, and address verification.

String

10001

Billing: City

The city associated with the billing address. This is used for invoicing, tax calculations, and address verification

String

New York

Billing: Province

The state, province, or region associated with the billing address. This is used for tax calculations, invoicing, and address verification.

String

California

Billing: Province Code

The standardized code for the state, province, or region associated with the billing address. This is typically an abbreviation used for tax calculations, invoicing, and address verification

String (ISO 3166-2 or country-specific format).

CA

Billing: Country

The country associated with the billing address. This is used for tax calculations, shipping, and address verification.

String (ISO 3166-1 alpha-2 country code or full country name).

"United States" or "US"

Shipping: First Name

The first name of the person associated with the shipping address. This is used for order fulfillment and shipping notifications.

String

Jane

Shipping: Last Name

The last name of the person associated with the shipping address. This is used for order fulfillment and shipping notifications.

String

Smith

Shipping: Name

The full name of the person associated with the shipping address. This is typically a combination of the first and last name and is used for order fulfillment and shipping notifications.

String

Jane Smith

Shipping: Company

The company name associated with the shipping address. This is used for business orders and deliveries to commercial addresses.

String

Acme Corp

Shipping: Phone

The phone number associated with the shipping address. This is used for delivery-related communications and notifications.

String

#ERROR!

Shipping: Address 1

The primary street address for the shipping location. This is used for delivery and logistics purposes.

String

123 Main St

Shipping: Address 2

The second line of the shipping address, typically used for apartment numbers, suite numbers, or additional address details.

String

Apt 4B

Shipping: Zip

The postal or ZIP code associated with the shipping address. This is used for delivery, tax calculations, and address verification.

String

10001

Shipping: City

The city associated with the shipping address. This is used for delivery, tax calculations, and address verification.

String

New York

Shipping: Province

The province, state, or region associated with the shipping address. This is used for delivery, tax calculations, and address verification.

String

New York

Shipping: Province Code

The standardized code for the province, state, or region associated with the shipping address. This is typically an abbreviation used for shipping, tax calculations, and address verification.

String (ISO 3166-2 or country-specific state/province codes).

NY

Shipping: Country

The country associated with the shipping address. This is used for delivery, tax calculations, and address verification.

String

United States

Shipping: Country Code

The standardized two-letter country code (ISO 3166-1 alpha-2) associated with the shipping address. This is used for shipping, tax calculations, and address verification.

String (ISO 3166-1 alpha-2).

US

Line: Type

Indicates the type of line item in the order. This helps differentiate between products, discounts, shipping charges, and other order components

String

product

Line: Product ID

The unique identifier of the product associated with a line item in the order. This helps link the line item to a specific product in the store's catalog.

String or Integer (depending on the platform).

123456789

Line: Product Handle

The unique, human-readable identifier (slug) for the product associated with a line item in the order. This is often used in URLs and product lookups.

String

classic-t-shirt

Line: Title

The name or title of the product associated with a line item in the order. This is typically displayed in the order summary and invoices.

String

Classic T-Shirt

Line: Name

The full name of the line item, often including product options or variants. This is typically displayed in the order summary and invoices.

String

Classic T-Shirt - Red / Medium

Line: Variant ID

The unique identifier of the product variant associated with a line item in the order. This helps distinguish between different versions of a product, such as size or color variations.

String or Integer (depending on the platform).

987654321

Line: Variant Title

The title or description of the product variant associated with a line item in the order. This typically includes attributes such as size, color, or material.

String

Red / Medium

Line: SKU

The Stock Keeping Unit (SKU) of the product variant associated with a line item in the order. This is a unique identifier assigned by the seller for inventory tracking.

String

TSHIRT-RED-M

Line: Quantity

The number of units of the product purchased in the line item.

Integer

2

Line: Price

The price of a single unit of the product in the line item, before discounts and taxes.

Decimal

19.99

Line: Discount

The total discount applied to the line item, representing any price reductions due to promotions, coupons, or manual discounts.

Decimal

19.99

Line: Grams

The weight of a single unit of the product in grams. This is used for shipping calculations.

Integer

200

Line: Requires Shipping

Indicates whether the product in the line item requires shipping. This is used to determine if shipping charges should be applied to the order.

Boolean (true / false).

TRUE

Line: Vendor

The name of the supplier or brand associated with the product in the line item.

String

Nike

Line: Properties

A set of custom properties or metadata attached to the line item. These properties provide additional details about the product, such as personalization options or special instructions.

Line: Gift Card

Indicates whether the line item is a gift card. Used to differentiate gift cards from regular products in an order.

Boolean (true or false).

FALSE

Line: Force Gift Card

Determines whether the line item should be explicitly treated as a gift card, overriding any default product settings.

Boolean (true or false).

FALSE

Line: Taxable

Indicates whether the line item is subject to tax calculations based on store tax settings.

Boolean (true or false).

FALSE

Line: Tax 1 Title

Specifies the name of the first tax applied to the line item. This helps identify different tax components in an order.

Text

VAT

Line: Tax 1 Rate

Defines the percentage rate of the first tax applied to the line item. This determines the tax amount calculated for the item.

Decimal (e.g., 0.10 for 10%).

0.10

Line: Tax 1 Price

Specifies the monetary value of the first tax applied to the line item. This value represents the actual tax amount charged.

Decimal

2.50

Line: Tax 2 Title

Specifies the name of the second tax applied to the line item. This helps identify different tax types, such as VAT or sales tax.

Text

State Tax

Line: Tax 2 Rate

Specifies the percentage rate of the second tax applied to the line item.

Decimal

0.05

Line: Tax 2 Price

Specifies the monetary value of the second tax applied to the line item.

Decimal

2.50

Line: Tax 3 Title

Specifies the name of the third tax applied to the line item.

Text

Local Tax

Line: Tax 3 Rate

Defines the rate of the third tax applied to the line item.

Decimal

0.05

Line: Tax 3 Price

Specifies the monetary amount of the third tax applied to the line item.

Decimal

2.50

Line: Fulfillment Service

Defines the fulfillment service handling the line item, indicating whether Shopify, a third-party service, or manual fulfillment is used.

Text (e.g., "manual", "shipwire", "amazon", "shopify")

manual

Line: Variant Barcode

Stores the barcode (UPC, EAN, or ISBN) associated with the product variant. This helps with inventory tracking and scanning during fulfillment.

Text

123456789012

Refund: ID

Represents the unique identifier for a refund transaction associated with an order. It is used to track and reference refunds.

Numeric

987654321

Refund: Created At

The timestamp indicating when the refund was created. This helps track refund processing time.

DateTime (ISO 8601 format, e.g., "2024-02-28T14:30:00Z").

2024-02-28T14:30:00Z

Refund: Note

A note or comment associated with the refund, providing additional context or details about the refund reason.

Text

Refund issued due to delayed delivery

Refund: Restock

Indicates whether the refunded items should be restocked in inventory.

Boolean (true or false).

TRUE

Refund: Restock Type

Specifies how the refunded items should be restocked in inventory.

String

return

Refund: Restock Location

Specifies the location where refunded items should be restocked.

String (Location ID or Name).

Main Warehouse

Refund: Send Receipt

Indicates whether a receipt should be sent to the customer after the refund is processed.

Boolean (true or false).

TRUE

Refund: Generate Transaction

Determines whether a transaction should be generated for the refund.

Boolean (true or false).

TRUE

Transaction: Kind

Specifies the type of transaction, indicating whether it is a sale, refund, or authorization.

Text (authorization, capture, sale, void, refund).

refund

Transaction: Processed At

Indicates the date and time when the transaction was processed.

DateTime (ISO 8601 format, e.g., YYYY-MM-DDTHH:MM:SSZ).

2024-02-28T14:30:00Z

Transaction: Amount

Specifies the monetary value of the transaction.

Decimal

49.99

Transaction: Currency

Specifies the currency used for the transaction

String (ISO 4217 currency code, e.g., "USD", "EUR")

USD

Transaction: Status

Indicates the current state of the transaction, such as whether it is pending, completed, or failed.

Stringsuccesspendingfailureerrorvoidedrefunded

success

Transaction: Gateway

The payment provider used to process the transaction, such as PayPal, Stripe, or Shopify Payments. This field identifies the source of payment processing.

Text

shopify_payments

Transaction: Force Gateway

Determines whether the specified payment gateway should be enforced for the transaction, overriding the default gateway selection.

Boolean (true or false).

TRUE

Transaction: Test

Indicates whether the transaction is a test transaction, meaning it was processed in a test environment and does not affect real payments.

Boolean (true or false).

FALSE

Transaction: Authorization

The authorization code or reference number provided by the payment gateway for the transaction.

Text

AUTH123456

Transaction: Parent ID

The unique identifier of the parent transaction, used to link related transactions such as refunds or captures to the original payment.

Numeric or Text

123456789

Fulfillment: ID

The unique identifier of a fulfillment, used to track and reference a specific fulfillment event for an order.

Numeric or Text

987654321

Fulfillment: Status

The current status of a fulfillment, indicating its progress in the order fulfillment process.

Text (e.g., "pending", "success", "cancelled").Possible values are varied by platform

success

Fulfillment: Processed At

The timestamp indicating when the fulfillment was processed. This marks the moment when the fulfillment status was updated to reflect progress or completion.

ISO 8601 datetime format (e.g., 2024-02-28T14:30:00Z).

2024-02-28T14:30:00Z

Fulfillment: Tracking Company

The name of the shipping carrier responsible for delivering the fulfillment.

Text

DHL

Fulfillment: Location

The location from which the order fulfillment is processed.

Text

Main Warehouse

Fulfillment: Shipment Status

Indicates the shipment status of the fulfillment, such as pending, shipped, or delivered.

Text

Text

Fulfillment: Tracking Number

Represents the tracking number assigned to a shipment for order fulfillment. This allows users to track the delivery status of the package.

Text

1Z999AA10123456784

Fulfillment: Tracking URL

Represents the URL that customers can use to track their shipment status online.

Text

https://www.ups.com/track?loc=en_US&tracknum=1Z999AA10123456784

Fulfillment: Send Receipt

Indicates whether a shipping confirmation receipt should be sent to the customer upon fulfillment.

Boolean (true or false).

TRUE