Objects

Details of All Available Objects

Definition


Canonical Type ThirdParty Objects Name ThirdParty
Description Magento 2 Customer 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
Website website  VARCHAR Website
Website Id website_id  INT Website Id
Store store  VARCHAR Store
Store Id store_id  INT Store Id
Social title gender  INT Social title ; 0 => Male // 1 => Female // 2 => Neutral
Full Name fullname  VARCHAR Customer Full Name for Incoices
[A] Company address_company  VARCHAR [A] Company
[A] Contact Name address_contact_name  VARCHAR [A] Contact Name
[A] Street 1 address_street_1  VARCHAR [A] Street 1
[A] Street 2 address_street_2  VARCHAR [A] Street 2
[A] Zip/Postal Code address_postcode  VARCHAR [A] Zip/Postal Code
[A] City address_city  VARCHAR [A] City
[A] Country ISO address_country_id  ISO COUNTRY [A] Country ISO
[A] Telephone address_telephone  PHONE [A] Telephone
[A] Relay Code address_relay_code  VARCHAR Relay Point Code
Is Confirmed confirmation  TEXT [EAV][S] Is Confirmed
Created At created_at  DATETIME [EAV][S] Created At
Created From created_in  TEXT [EAV][S] Created From
Name Prefix prefix  TEXT [EAV][S] Name Prefix
First Name firstname  TEXT [EAV][S] First Name
Middle Name/Initial middlename  TEXT [EAV][S] Middle Name/Initial
Last Name lastname  TEXT [EAV][S] Last Name
Name Suffix suffix  TEXT [EAV][S] Name Suffix
Email email  EMAIL [EAV][S] Email
Updated At updated_at  DATETIME [EAV][S] Updated At
Date of Birth dob  DATE [EAV][S] Date of Birth
Tax/VAT Number taxvat  TEXT [EAV][S] Tax/VAT Number

Definition


Canonical Type Product Objects Name Product
Description Magento 2 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
Reference - SKU sku  VARCHAR Reference - SKU
Product Name without Options name  VARCHAR Product Name without Options
Description description  TEXT Description
Short Description short_description  VARCHAR Short Description
SEO Meta description meta_description  VARCHAR SEO Meta description
SEO Meta title meta_title  VARCHAR SEO Meta title
SEO Friendly URL url_key  VARCHAR SEO Friendly URL
Weight weight  DOUBLE Weight
Package height ts_dimensions_height  DOUBLE Package height
Package depth ts_dimensions_length  DOUBLE Package depth
Package width ts_dimensions_width  DOUBLE Package width
[Default] Stock quantity_and_stock_status  INT [Default] Stock
This product is out of stock is_in_stock  BOOL This product is out of stock
Selling Price (EUR) price  PRICE Selling Price (EUR)
Cost Price (EUR) cost  PRICE Cost Price (EUR)
MSRP Price (EUR) msrp  PRICE Manufacturer's Suggested Retail Price
Minimal Price (EUR) minimal_price  PRICE Minimal Price
Images image@images  >   IMG Images
Img. Position position@images  >   INT Img. Position
Img. Cover cover@images  >   BOOL Img. Cover
Img. Visible visible@images  >   BOOL Img. Visible
Enable Product status  BOOL Enable Product
Type type_id  VARCHAR Internal Type
Parent parent_id  VARCHAR Parent
Parent SKU parent_sku  VARCHAR Parent SKU
Variants id@variants  >   Product Variants
Variant SKU sku@variants  >   VARCHAR Variant SKU
Attr. Code attribute_code@attributes  >   VARCHAR Attr. Code
Attr. Label frontend_label@attributes  >   VARCHAR Attr. Label
Attr. Value value@attributes  >   VARCHAR Attr. Value
Attribute Set Id attribute_set_id  INT [EAV][S] Attribute Set Id
Url Path url_path  TEXT [EAV][S] Url Path
Created At created_at  DATETIME [EAV][S] Created At
Updated At updated_at  DATETIME [EAV][S] Updated At
Tax Class tax_class_id  VARCHAR [EAV][S] Tax Class
Categories category_ids  TEXT [EAV][S] Categories
Visibility visibility  VARCHAR [EAV][S] Visibility
Set Product as New from Date news_from_date  DATE [EAV][S] Set Product as New from Date
Set Product as New to Date news_to_date  DATE [EAV][S] Set Product as New to Date
Country of Manufacture country_of_manufacture  VARCHAR [EAV][S] Country of Manufacture
Base image  IMG [EAV][S] Base
Thumbnail thumbnail  IMG [EAV][S] Thumbnail
Swatch swatch_image  IMG [EAV][S] Swatch
Image Gallery gallery  VARCHAR [EAV][S] Image Gallery
Meta Keywords meta_keyword  TEXT [EAV][S] Meta Keywords
Special Price special_price  DOUBLE [EAV][S] Special Price
Special Price From Date special_from_date  DATE [EAV][S] Special Price From Date
Special Price To Date special_to_date  DATE [EAV][S] Special Price To Date
Layout page_layout  VARCHAR [EAV][S] Layout
Layout Update XML custom_layout_update  TEXT [EAV][S] Layout Update XML
Custom Layout Update custom_layout_update_file  VARCHAR [EAV][S] Custom Layout Update
Active From custom_design_from  DATE [EAV][S] Active From
Active To custom_design_to  DATE [EAV][S] Active To
New Theme custom_design  VARCHAR [EAV][S] New Theme
New Layout custom_layout  VARCHAR [EAV][S] New Layout

Definition


Canonical Type Order Objects Name Customer Order
Description Magento 2 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
Website website  VARCHAR Website
Website Id website_id  INT Website Id
Store store  VARCHAR Store
Store Id store_id  INT Store Id
Reference increment_id  VARCHAR Reference
Customer customer_id  ThirdParty Customer
Email du contact customer_email  EMAIL Email du contact
Shipping Method shipping_method  VARCHAR Shipping Method
Shipping Description shipping_description  VARCHAR Shipping Description
Date created_at  DATETIME Date
Total (tax excl.) (EUR) grand_total_excl_tax  DOUBLE Total (tax excl.) (EUR)
Total (tax incl.) (EUR) grand_total  DOUBLE Total (tax incl.) (EUR)
Currency order_currency_code  ISO CURRENCY Currency
Currency Rate base_to_order_rate  DOUBLE Currency Rate
Billing Address ID billing_address_id  Address Billing Address ID
Shipping Address ID shipping_address_id  Address Shipping Address ID
Quantity qty_ordered@lines  >   INT Quantity
Label sku@lines  >   VARCHAR Label
Description name@lines  >   VARCHAR Description
Product ID product_id@lines  >   Product Product ID
Discount (%) discount_percent@lines  >   DOUBLE Discount (%)
Price unit_price@lines  >   PRICE Price
Status state  VARCHAR Status
Is Valid isValidated  BOOL Is Valid
Is Processing isProcessing  BOOL Is Processing
Is Closed isClosed  BOOL Is Closed
Is Canceled isCanceled  BOOL Is Canceled
Shippment ID increment_id@shipping  >   VARCHAR Shippment ID
Total Qty total_qty@shipping  >   INT Total Qty of Items Shipped
Total Weight total_weight@shipping  >   INT Total Weight of Items Shipped
Tracking Codes tracking_codes@shipping  >    Tracking Codes
Tracking Titles tracking_titles@shipping  >    Tracking Titles
Tracking Numbers tracking_numbers@shipping  >    Tracking Numbers
Shipping Method Name title  VARCHAR Shipping Method Name
Carrier Code carrier_code  VARCHAR Carrier Code
Tracking Number track_number  VARCHAR Tracking Number
Tracking Url url_tracking  URL Tracking Url
Shipment increment_id@tracking  >   VARCHAR Shipment
Method title@tracking  >   VARCHAR Method
Carrier Code carrier_code@tracking  >   VARCHAR Carrier Code
Number track_number@tracking  >   VARCHAR Number
[A] Company address_company  VARCHAR [A] Company
[A] Contact Name address_contact_name  VARCHAR [A] Contact Name
[A] Street 1 address_street_1  VARCHAR [A] Street 1
[A] Street 2 address_street_2  VARCHAR [A] Street 2
[A] Zip/Postal Code address_postcode  VARCHAR [A] Zip/Postal Code
[A] City address_city  VARCHAR [A] City
[A] Country ISO address_country_id  ISO COUNTRY [A] Country ISO
[A] Telephone address_telephone  PHONE [A] Telephone
[A] Relay Code address_relay_code  VARCHAR Relay Point Code

Definition


Canonical Type Invoice Objects Name Customer Invoice
Description Magento 2 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
Website website  VARCHAR Website
Website Id website_id  INT Website Id
Store store  VARCHAR Store
Store Id store_id  INT Store Id
Reference increment_id  VARCHAR Reference
Customer customer_id  ThirdParty Customer
Email du contact customer_email  EMAIL Email du contact
Date created_at  DATETIME Date
Total (tax excl.) (EUR) grand_total_excl_tax  DOUBLE Total (tax excl.) (EUR)
Total (tax incl.) (EUR) grand_total  DOUBLE Total (tax incl.) (EUR)
Currency order_currency_code  ISO CURRENCY Currency
Currency Rate base_to_order_rate  DOUBLE Currency Rate
Billing Address ID billing_address_id  Address Billing Address ID
Shipping Address ID shipping_address_id  Address Shipping Address ID
Quantity qty@lines  >   INT Quantity
Label sku@lines  >   VARCHAR Label
Description name@lines  >   VARCHAR Description
Product ID product_id@lines  >   Product Product ID
Discount (%) discount_percent@lines  >   DOUBLE Discount (%)
Price unit_price@lines  >   PRICE Price
Status state  VARCHAR Status
Is Valid isValidated  BOOL Is Valid
Is Paid isPaid  BOOL Is Paid
Is Canceled isCanceled  BOOL Is Canceled
[A] Company address_company  VARCHAR [A] Company
[A] Contact Name address_contact_name  VARCHAR [A] Contact Name
[A] Street 1 address_street_1  VARCHAR [A] Street 1
[A] Street 2 address_street_2  VARCHAR [A] Street 2
[A] Zip/Postal Code address_postcode  VARCHAR [A] Zip/Postal Code
[A] City address_city  VARCHAR [A] City
[A] Country ISO address_country_id  ISO COUNTRY [A] Country ISO
[A] Telephone address_telephone  PHONE [A] Telephone
[A] Relay Code address_relay_code  VARCHAR Relay Point Code

Definition


Canonical Type Address Objects Name Address
Description Magento 1 Customers Address 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
Customer customer_id  ThirdParty Customer
Country ISO (Code) country_iso  ISO COUNTRY Country ISO (Code)
Street 1 street_1  VARCHAR Street 1
Street 2 street_2  VARCHAR Street 2
Street 3 street_3  VARCHAR Street 3
Name Prefix prefix  TEXT [EAV][S] Name Prefix
First Name firstname  TEXT [EAV][S] First Name
Middle Name/Initial middlename  TEXT [EAV][S] Middle Name/Initial
Last Name lastname  TEXT [EAV][S] Last Name
Name Suffix suffix  TEXT [EAV][S] Name Suffix
Company company  TEXT [EAV][S] Company
Country country_id  VARCHAR [EAV][S] Country
City city  TEXT [EAV][S] City
Zip/Postal Code postcode  TEXT [EAV][S] Zip/Postal Code
Phone Number telephone  TEXT [EAV][S] Phone Number
Fax fax  TEXT [EAV][S] Fax
VAT Number vat_id  TEXT [EAV][S] VAT Number