YOM Docs

• Integration guides
  • Integration methods
    • API integration
    • File integration
  • Entities
    • Categories
    • Distribution Center
    • Commerces
    • Loaned Equipment
    • Delivery cost
    • Credit
    • Tax Documents
    • Discount limit
    • Payments
    • Products
    • Promotions
    • Segments
    • Overrides
    • Stock
    • Supervisors
    • Transactions
    • Sellers
  • Webhooks
    • Technical requirements
    • Customer-to-YOM Webhooks
      • Order modification
      • Bulk stock upload
      • Bulk order modification
    • YOM-to-customer Webhooks
      • Orders
      • Payments
      • Minimum order
      • Delivery price
      • Returns
      • Loaned Equipment
      • Commerce creation
  • Changelog
  • Recommendations Extraction API
    • Authentication
    • Recommendations
    • Best practices
• Settings

Integration guides

<aside> 🆕

Version → 2.0.0

</aside>

To start using the solutions offered by Yom, you need to integrate your company's data on a regular basis. This includes syncing information about your Customers, Products, Orders, Stock, and more.

🔁 Flows

To work with YOM, you need to build integrations in two directions: Data upload and Data injection.

<aside> ➡️

Data upload

</aside>

<aside> ⬅️

Data injection

</aside>

Every company has different needs and technical capabilities. That's why we offer several different integration methods to make transferring data between your systems and ours easier. These are documented in the following sections:

<aside> ➡️

Data upload

<aside> 📂

Files

</aside>

</aside>

<aside> ⬅️

</aside>

Below we explain the use cases for each method.

➡️ Data upload

📂 File Transfer Integration (SFTP)

Description → This method is designed for companies that don't have significant technical development capacity but do have reports in file form or the ability to generate them periodically. You drop your commerce, product, and order documents onto a designated SFTP server. Our system checks these files daily, processing and updating the information in our systems.

Ideal for →

• Companies with established SFTP infrastructure.
• Organizations that handle large volumes of data in batches.
• Those that prefer a simple, effective solution for data transfer without needing advanced technical development.

📤 Scheduled API Integration

Description → This approach is ideal for companies that have the technical development capacity to make their data available through API endpoints but can't run load operations in real time. With this method, we send HTTP GET requests to the endpoints you provide, retrieving the data we need at the frequency we define together.

Ideal for →