Objects

Details of All Available Objects

Definition


Canonical Type ThirdParty Objects Name ThirdParty
Description Prestashop 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
Creation date_add  DATETIME Creation
Last modification date_upd  DATETIME Last modification
Splash Id splash_id  VARCHAR Splash Id
Email address email  EMAIL Email address
First name firstname  VARCHAR First name
Last name lastname  VARCHAR Last name
Social title gender_name  VARCHAR Social title
Social title (ID) gender_type  INT Social title ; 0 => Male // 1 => Female // 2 => Neutral
Company company  VARCHAR Company
SIRET siret  VARCHAR SIRET
APE ape  VARCHAR APE
Website website  URL Website
Address address1  VARCHAR Address
Address (2) address2  VARCHAR Address (2)
Zip/Postal Code postcode  VARCHAR Zip/Postal Code
City city  VARCHAR City
State state  VARCHAR State
State (Code) id_state  ISO STATE State (Code)
Country country  VARCHAR Country
Country (Code) id_country  ISO COUNTRY Country (Code)
Home phone phone  PHONE Home phone
Mobile phone phone_mobile  PHONE Mobile phone
VAT Number vat_number  VARCHAR VAT Number
Address address@contacts  >   Address Address
Enabled active  BOOL Enabled
Newsletter newsletter  BOOL Newsletter
Opt-in optin  BOOL Opt-in

Definition


Canonical Type Product Objects Name Product
Description Prestashop 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
Creation date_add  DATETIME Creation
Last modification date_upd  DATETIME Last modification
Splash Id splash_id  VARCHAR Splash Id
Reference ref  VARCHAR Your internal reference code for this product.
Type type  VARCHAR Internal product Type
Package weight weight  DOUBLE Package weight
Package height height  DOUBLE Package height
Package depth depth  DOUBLE Package depth
Package width width  DOUBLE Package width
Surface surface  DOUBLE Surface
Volume volume  DOUBLE Volume
Supplier reference supplier_reference  VARCHAR Supplier reference
UPC Code upc  INT UPC Code
EAN Code ean13  INT EAN Code
ISBN Code isbn  INT ISBN Code
Product Name without Options name  VARCHAR Product Name without Options
Product Name with Options fullname  VARCHAR Product Name with Options
description description  TEXT description
Short Description description_short  VARCHAR Short Description
Product Name without Options name_en_US  VARCHAR Product Name without Options
Product Name with Options fullname_en_US  VARCHAR Product Name with Options
description description_en_US  TEXT description
Short Description description_short_en_US  VARCHAR Short Description
Stock stock  INT Stock
This product is out of stock outofstock  BOOL This product is out of stock
Minimum quantity minimal_quantity  INT The minimum quantity to buy this product (set to 1 to disable this feature).
Price (tax excl.) (€) price  PRICE Price (tax excl.) (€)
Price (tax excl.) Base (€) price-base  PRICE Price (tax excl.) Base (€)
Wholesale price Base (€) price-wholesale  PRICE Wholesale price Base (€)
Images image@images  >   IMG Images
Position position@images  >   INT Position
Cover cover@images  >   BOOL Cover
Visible visible@images  >   BOOL Visible
Enabled active  BOOL Enabled
Available for order available_for_order  BOOL Available for order
On Sale on_sale  BOOL On Sale
Online Only online_only  BOOL Online Only
Online Only Ref. online_ref  VARCHAR Online Only Ref.
Online Only Title. online_name  VARCHAR Online Only Title.
Is default variant default_on  BOOL Is default variant
Default Variant default_id  Product Default Variant
Parent parent_id  VARCHAR Parent
Parent SKU parent_ref  VARCHAR Parent SKU
Variants id@variants  >   Product Variants
Variant SKU sku@variants  >   VARCHAR Variant SKU
Code code@attributes  >   VARCHAR Code
Name public_name@attributes  >   VARCHAR Name
Value name@attributes  >   VARCHAR Value
Name public_name_en_US@attributes  >   VARCHAR Name
Value name_en_US@attributes  >   VARCHAR Value
Md5 md5  VARCHAR Unik Md5 Object Checksum
Md5 Debug md5-debug  VARCHAR Unik Checksum String fro Debug
Meta description meta_description  VARCHAR Information Meta description
Meta title meta_title  VARCHAR Information Meta title
Meta keywords meta_keywords  VARCHAR Information Meta keywords
Friendly URL link_rewrite  VARCHAR Information Friendly URL
Meta description meta_description_en_US  VARCHAR Information Meta description
Meta title meta_title_en_US  VARCHAR Information Meta title
Meta keywords meta_keywords_en_US  VARCHAR Information Meta keywords
Friendly URL link_rewrite_en_US  VARCHAR Information Friendly URL

Definition


Canonical Type Order Objects Name Customer Order
Description Prestashop 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
Creation date_add  DATETIME Creation
Last modification date_upd  DATETIME Last modification
Splash Id splash_id  VARCHAR Splash Id
Customer ID id_customer  ThirdParty Customer ID
Email address email  EMAIL Email address
Reference reference  VARCHAR Reference
Date order_date  DATE Date
Total (Tax excl.) (€) total_paid_tax_excl  DOUBLE Total (Tax excl.) (€)
Total (Tax incl.) (€) total_paid_tax_incl  DOUBLE Total (Tax incl.) (€)
Billing Address ID id_address_invoice  Address Billing Address ID
Shipping Address ID id_address_delivery  Address Shipping Address ID
Company company  VARCHAR Company
Contact Name fullname  VARCHAR Contact Name
Address address1  VARCHAR Address
Address (2) address2  VARCHAR Address (2)
Zip/Postal Code postcode  VARCHAR Zip/Postal Code
City city  VARCHAR City
State state  VARCHAR State
State (Code) id_state  ISO STATE State (Code)
Other other  VARCHAR Other: Remarks, Relay Point Code, more...
Country country  VARCHAR Country
Country (Code) id_country  ISO COUNTRY Country (Code)
Home phone phone  PHONE Home phone
Mobile phone phone_mobile  PHONE Mobile phone
Short description product_name@lines  >   VARCHAR Short description
Product ID product_id@lines  >   Product Product ID
Quantity product_quantity@lines  >   INT Quantity
Discount (%) reduction_percent@lines  >   DOUBLE Discount (%)
Price unit_price@lines  >   PRICE Price
Tax Name tax_name@lines  >   VARCHAR Tax Name
Payment method mode@payments  >   VARCHAR Payment method
Date date@payments  >   DATE Date
Transaction ID number@payments  >   VARCHAR Transaction ID
Amount amount@payments  >   DOUBLE Amount
Shipping Method carrier_name  VARCHAR Shipping Method
Carrier Code carrier_code  VARCHAR Carrier Code
Tracking Number track_number  VARCHAR Tracking Number
Tracking Url track_url  URL Tracking Url
Order status status  VARCHAR Status of the order
Order status Canceled isCanceled  BOOL Order status Canceled
Order status Valid isValidated  BOOL Order status Valid
Order status Processing isProcessing  BOOL Order status Processing
Order status Closed isClosed  BOOL Order status Closed
Order status Paid isPaid  BOOL Order status Paid

Definition


Canonical Type Invoice Objects Name Customer Invoice
Description Prestashop 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
Creation date_add  DATETIME Creation
Last modification date_upd  DATETIME Last modification
Splash Id splash_id  VARCHAR Splash Id
Customer ID id_customer  ThirdParty Customer ID
Email address email  EMAIL Email address
Reference reference  VARCHAR Reference
Date order_date  DATE Date
Total (Tax excl.) (€) total_paid_tax_excl  DOUBLE Total (Tax excl.) (€)
Total (Tax incl.) (€) total_paid_tax_incl  DOUBLE Total (Tax incl.) (€)
Billing Address ID id_address_invoice  Address Billing Address ID
Shipping Address ID id_address_delivery  Address Shipping Address ID
Short description product_name@lines  >   VARCHAR Short description
Product ID product_id@lines  >   Product Product ID
Quantity product_quantity@lines  >   INT Quantity
Discount (%) reduction_percent@lines  >   DOUBLE Discount (%)
Price unit_price@lines  >   PRICE Price
Tax Name tax_name@lines  >   VARCHAR Tax Name
Payment method mode@payments  >   VARCHAR Payment method
Date date@payments  >   DATE Date
Transaction ID number@payments  >   VARCHAR Transaction ID
Amount amount@payments  >   DOUBLE Amount
Order id_order  Order Order
Invoice number number  VARCHAR Invoice number
Status status  VARCHAR Status
Status Canceled isCanceled  BOOL Status Canceled
Status Valid isValidated  BOOL Status Valid
Status Paid isPaid  BOOL Status Paid

Definition


Canonical Type Address Objects Name Address
Description Prestashop 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
Creation date_add  DATETIME Creation
Last modification date_upd  DATETIME Last modification
Splash Id splash_id  VARCHAR Splash Id
Address alias alias  VARCHAR Address alias
Customer ID id_customer  ThirdParty Customer ID
Company company  VARCHAR Company
First name firstname  VARCHAR First name
Last name lastname  VARCHAR Last name
Address address1  VARCHAR Address
Address (2) address2  VARCHAR Address (2)
Zip/Postal Code postcode  VARCHAR Zip/Postal Code
City city  VARCHAR City
State state  VARCHAR State
State (Code) id_state  ISO STATE State (Code)
Country country  VARCHAR Country
Country (Code) id_country  ISO COUNTRY Country (Code)
Home phone phone  PHONE Home phone
Mobile phone phone_mobile  PHONE Mobile phone
Company ID Number dni  VARCHAR Company ID Number
VAT number vat_number  VARCHAR VAT number
Note other  VARCHAR Note