Articles in this section

Available Magento 2 DI objects

Naga Sri Hari Gonaboyina
Updated

The following objects are available when using Magento as a source in Celigo Data Integration (DI).

Primary key: Magento DI objects do not share a single primary key. Catalog- and customer-style objects key on a top-level id (Cart, Category, Customer, Customer group, Product). Sales documents key on entity_id (Credit memo, Invoice, Order, Return, Shipment). A few objects use their own identifier: Coupon uses coupon_id, Transaction uses transaction_id, and Source items use sku.

Note

Magento's search endpoints return only currently-existing records. Magento does not expose a deleted-records feed for these objects, so records that are hard-deleted through the API (for example, products or customers removed via a DELETE call) simply stop appearing in subsequent search results rather than being returned with a deleted flag.

Object API endpoint Available extract modes Delta field
Cart APIs Search cart by criteria Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Category APIs List categories Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Coupon APIs Search coupon Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Creditmemo APIs Search creditmemo Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Customer APIs Search customer Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Customer group APIs Customer group search Full —
Invoice APIs Search invoices Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Order APIs Search sales order Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Product APIs Product search Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Return APIs Search returns Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Shipment APIs Search shipment Full, Incremental searchCriteria[filter_groups][0][filters][0][value]
Source APIs List source items Full —
Transaction APIs Search transaction Full, Incremental searchCriteria[filter_groups][0][filters][0][value]

Response schemas

Click an object below to view its response fields and delta configuration.

Cart APIs — Search cart by criteria

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
id number (Primary key)
created_at string
updated_at string
is_active boolean
is_virtual boolean
items_count number
items_qty number
customer_is_guest boolean
customer_email string (PII)
store_id number
Category APIs — List categories

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
id number (Primary key)
parent_id number
name string (PII)
is_active boolean
position number
level number
path string
created_at string
updated_at string
include_in_menu boolean
custom_attributes objectarray
Coupon APIs — Search coupon

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = created_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
coupon_id number (Primary key)
rule_id number
code string
usage_limit number
usage_per_customer number
times_used number
is_primary boolean
type number
created_at string
Creditmemo APIs — Search creditmemo

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
entity_id number (Primary key)
increment_id string
order_id number
state number
grand_total number
subtotal number
discount_amount number
store_id number
created_at string
updated_at string
items objectarray
items.entity_id number
items.parent_id number
items.sku string
items.name string
items.qty number
items.price number
items.order_item_id number
items.product_id number
Customer APIs — Search customer

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
id number (Primary key)
group_id number
default_billing string
default_shipping string
created_at string
updated_at string
created_in string
email string (PII)
firstname string (PII)
lastname string (PII)
prefix string (PII)
middlename string (PII)
gender number
store_id number
website_id number
disable_auto_group_change number
addresses objectarray
addresses.id number (Primary key)
addresses.customer_id number
addresses.region_id number
addresses.country_id string (PII)
addresses.street stringarray (PII)
addresses.company string
addresses.telephone string (PII)
addresses.postcode string
addresses.city string (PII)
addresses.firstname string (PII)
addresses.lastname string (PII)
addresses.prefix string (PII)
addresses.suffix string
addresses.default_billing boolean
addresses.default_shipping boolean
addresses.region object
addresses.region.region_code string (PII)
addresses.region.region string (PII)
addresses.region.region_id number
extension_attributes object
extension_attributes.is_subscribed boolean
Customer group APIs — Customer group search

Response schema:

Field Type
id number (Primary key)
code string
tax_class_id number
tax_class_name string
Invoice APIs — Search invoices

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
entity_id number (Primary key)
increment_id string
order_id number
state number
grand_total number
subtotal number
total_qty number
store_id number
created_at string
updated_at string
items objectarray
items.entity_id number
items.parent_id number
items.sku string
items.name string
items.qty number
items.price number
items.order_item_id number
items.product_id number
Order APIs — Search sales order

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
entity_id number (Primary key)
increment_id string
status string
state string
customer_id number
customer_email string (PII)
customer_firstname string (PII)
customer_lastname string (PII)
grand_total number
subtotal number
total_paid number
total_due number
store_id number
created_at string
updated_at string
items objectarray
items.item_id number
items.order_id number
items.product_id number
items.sku string
items.name string
items.qty_ordered number
items.price number
items.row_total number
items.created_at string
items.updated_at string
Product APIs — Product search

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
id number (Primary key)
sku string
name string (PII)
attribute_set_id number
price number
status number
visibility number
type_id string
weight number
created_at string
updated_at string
extension_attributes object
product_links objectarray
product_links.sku string
product_links.link_type string
product_links.linked_product_sku string
product_links.linked_product_type string
product_links.position number
media_gallery_entries objectarray
media_gallery_entries.id number
media_gallery_entries.media_type string
media_gallery_entries.label string
media_gallery_entries.position number
media_gallery_entries.disabled boolean
media_gallery_entries.file string
media_gallery_entries.types stringarray
tier_prices objectarray
tier_prices.customer_group_id number
tier_prices.qty number
tier_prices.value number
custom_attributes objectarray
Return APIs — Search returns

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
entity_id number (Primary key)
increment_id string
order_id number
order_increment_id string
store_id number
customer_id number
date_requested string
status string
updated_at string
items objectarray
items.entity_id number
items.rma_entity_id number
items.order_item_id number
items.qty_requested number
items.qty_authorized number
items.qty_approved number
items.qty_returned number
items.reason string
items.condition string
items.resolution string
items.status string
Shipment APIs — Search shipment

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = updated_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
entity_id number (Primary key)
increment_id string
order_id number
customer_id number
store_id number
total_qty number
created_at string
updated_at string
items objectarray
items.entity_id number
items.parent_id number
items.sku string
items.name string
items.qty number
items.price number
items.order_item_id number
items.product_id number
tracks objectarray
tracks.entity_id number
tracks.track_number string
tracks.title string
tracks.carrier_code string
tracks.created_at string
tracks.updated_at string
Source APIs — List source items

Response schema:

Field Type
sku string (Primary key)
source_code string
quantity number
status number
Transaction APIs — Search transaction

Delta configuration: use it to request incremental data.

Setting Value
Delta filter searchCriteria[filter_groups][0][filters][0][value] = {{{lastExportDateTime}}}
Additional parameters searchCriteria[filter_groups][0][filters][0][field] = created_at
searchCriteria[filter_groups][0][filters][0][condition_type] = gt
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
transaction_id number (Primary key)
order_id number
payment_id number
txn_id string
parent_txn_id string
txn_type string
is_closed number
created_at string
child_transactions objectarray