Objects

Details of All Available Objects

Definition


Canonical Type ThirdParty Objects Name Customer
Description Shopify Customer
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Date Created created_at  DATETIME Date Created
Last modification updated_at  DATETIME Last modification
Email email  EMAIL Email
Firstname first_name  VARCHAR Firstname
Lastname last_name  VARCHAR Lastname
Company Name company  VARCHAR Company Name
Phone phone  PHONE Phone
Note note  VARCHAR Note
Status status  BOOL Status
Uses VAT tax_exempt  BOOL Uses VAT
Accepts Marketing accepts_marketing  BOOL Accepts Marketing
Street 1 address1  VARCHAR Street 1
Street 2 address2  VARCHAR Street 2
Zip zip  VARCHAR Zip
Town city  VARCHAR Town
Country country_name  VARCHAR Country
Country Code country_code  ISO COUNTRY Country Code
State province  VARCHAR State
State Code province_code  ISO STATE State Code

Definition


Canonical Type Address Objects Name Customer Address
Description Shopify Customer Address
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Customer customer_id  ThirdParty Customer
Firstname first_name  VARCHAR Firstname
Lastname last_name  VARCHAR Lastname
Street 1 address1  VARCHAR Street 1
Street 2 address2  VARCHAR Street 2
Zip zip  VARCHAR Zip
Town city  VARCHAR Town
Country country_name  VARCHAR Country
Country Code country_code  ISO COUNTRY Country Code
State province  VARCHAR State
State Code province_code  ISO STATE State Code

Definition


Canonical Type Product Objects Name Product
Description Shopify Product Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Date Created created_at  DATETIME Date Created
Last modification updated_at  DATETIME Last modification
Title title  VARCHAR Title
Is Published published  BOOL Is Published
Description body_html  VARCHAR A description of the product. Supports HTML formatting.
Friendly URL handle  VARCHAR A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects.
Image image@images  >   IMG Image
Position position@images  >   INT Image Order for this Product Variant
Is Cover cover@images  >   BOOL Is Cover
Visible visible@images  >   BOOL Image is visible for this Product Variant
Parent Product id  VARCHAR Parent Product
Variants id@variants  >   Product Variants
SKU sku@variants  >   VARCHAR SKU
Options options@variants  >   VARCHAR Options
Code code@attributes  >   VARCHAR Code
Name name@attributes  >   VARCHAR Name
Value value@attributes  >   VARCHAR Value
Product SKU sku  VARCHAR A unique identifier for the product variant in the shop.
Title with Options variant_title  VARCHAR Title with Options
Price (tax excl.) price  PRICE Price (tax excl.)
Product weight (Kg) grams  DOUBLE Product weight (Kg)
UPC | ISBN BarCode barcode  INT UPC | ISBN BarCode
Stock inventory_quantity  INT Stock
Out of stock outofstock  BOOL Out of stock

Definition


Canonical Type Order Objects Name Customer Order
Description Shopify Customers Order Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Date Created created_at  DATETIME Date Created
Last modification updated_at  DATETIME Last modification
Customer customer  ThirdParty Customer
Customer Email email  EMAIL Customer Email
Reference name  VARCHAR Reference
Order Date processed_at  DATE Order Date
Closed Date closed_at  DATE Closed Date
Total Price total_price  DOUBLE Total Price
Total Tax Excl. total_tax_excl  DOUBLE Total Tax Excl.
Order is Draft isdraft  BOOL Order is Draft
Order is Canceled iscanceled  BOOL Order is Canceled
Order is Validated isvalidated  BOOL Order is Validated
Order is Closed isclosed  BOOL Order is Closed
Order is Paid financial_status  BOOL Order is Paid
Order Status status  VARCHAR Order Status
Description title@lines  >   VARCHAR Description
Product product_id@lines  >   Product Product
Quantity quantity@lines  >   INT Quantity
Discount % discount@lines  >   DOUBLE Discount %
Unit Price price@lines  >   PRICE Unit Price
VAT Tax Code tax_name@lines  >   VARCHAR VAT Tax Code

Definition


Canonical Type Invoice Objects Name Customer Invoice
Description Shopify Customers Invoice Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Date Created created_at  DATETIME Date Created
Last modification updated_at  DATETIME Last modification
Customer customer  ThirdParty Customer
Customer Email email  EMAIL Customer Email
Reference name  VARCHAR Reference
Order Date processed_at  DATE Order Date
Closed Date closed_at  DATE Closed Date
Total Price total_price  DOUBLE Total Price
Total Tax Excl. total_tax_excl  DOUBLE Total Tax Excl.
Order is Draft isdraft  BOOL Order is Draft
Order is Canceled iscanceled  BOOL Order is Canceled
Order is Validated isvalidated  BOOL Order is Validated
Order is Closed isclosed  BOOL Order is Closed
Order is Paid financial_status  BOOL Order is Paid
Order Status status  VARCHAR Order Status
Description title@lines  >   VARCHAR Description
Product product_id@lines  >   Product Product
Quantity quantity@lines  >   INT Quantity
Discount % discount@lines  >   DOUBLE Discount %
Unit Price price@lines  >   PRICE Unit Price
VAT Tax Code tax_name@lines  >   VARCHAR VAT Tax Code
Payment method mode@payments  >   VARCHAR Payment method
Date date@payments  >   DATE Date
Transaction ID number@payments  >   VARCHAR Transaction ID
Amount amount@payments  >   DOUBLE Amount