What is an Entity?

Created by Nicolas Wussler, Modified on Tue, 16 Aug 2022 at 08:19 AM by Igor Galic

Chances are you have encountered the term "Entity" at the beginning of your SyncSpider journey. 

 

The purpose of this article is for you to be able to understand what they are, how to use them, and how to tell if an Integration is able to send or receive a certain Entity. 

 

General Information


Entities can be defined as a type of Data certain Integration can either Import or Export.

 

When dealing with Rest API calls, other platforms call them endpoints. 

 

They will vary from Integration to Integration.

 

E.G. Our eBay Integration is able to send Orders and Products, and receive Refunds, Products, and Order Status. 

 

This means that the Entities eBay has are: 

 

• Order and Product as a Source Integration.

• Refund, Product, and Order Status as a Target Integration.

 

Let's look at another example - our Ecwid Integration can send Customers, Orders, and Products and receive  Customers, Orders, and Products.

 

This means that the Entities Amazon EU has are:

 

• Customer, Order, and Product as a Source Integration.

• Customer, Order, and Product as a Target Integration.

 

When creating a Task, it is highly recommended to choose Integrations with compatible Entities.

 

NOTE: Every business is different, so we allow you to match any entity with any other entity even though it might not make any sense at first :)

 

This means that if we wanted to connect eBay with Ecwid, we could easily do the following:

 

• Send Order Entity from eBay to Ecwid as a Customer Entity. This allows you to use the eBay order information (buyer info) and create them as a customer in Ecwid.

  


Usage

You will be asked to choose the Entity you wish to send when setting up your Source Integration, and the Entity you wish to receive when setting up your Target Integration, within a Task.

 

 

 

 

 


Additional Information


All Entities have Attributes. Attributes are certain properties that further define an Entity, and can vary. 

 

E.G. eBay's Product Entity has Attributes such as: 

 

Title, Type, Size, Color, Quantity, Price, etc, 

 

whereas a Contact entity would have attributes such as: 

 

First name, Last name, email, phone, address, etc.

 

Another thing worth mentioning is that the Entity you selected for your Source and Target Integration will determine what the Mapping section will look like. 

 

 


Feature Requests


In addition to new Integration Request, you can also submit a Feature Request by clicking here.

 

Feature Requests usually pertain (but are not limited) to the addition of new Entities to an already existing Integration. 


E.G. Users can request Entities such as Email Campaigns and SMS Campaign to be added to our Sendinblue Integration.

 

 



We hope you found this Article helpful :)

 

If you still have any questions or inquiries left unanswered, please email us at [email protected]

Additionally,  you can shoot us a message via our website's chat widget or get in touch with us on our Facebook page, and our Customer Support Representatives will be more than happy to assist you.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article