Skip to main content

Foxdeli API Data Model

The Foxdeli API data model defines the structure of information you exchange with the Foxdeli system. It outlines the specific data required to interact with various entities within Foxdeli, including creating, updating, and deleting resources. This section describes the primary resources and their relationships, providing a comprehensive overview of the Foxdeli API data model.

Resources​

Foxdeli API is a RESTful API that uses resources to interact with the system. Each resource has a unique URL and can be accessed using standard HTTP verbs like GET, POST, PUT, PATCH and DELETE. These resources represent real-world entities in Foxdeli and allow you to manipulate data:

  • Create: Add new entities to the system.
  • Update: Modify existing entities with new information.
  • Delete: Remove entities from the system.

Here's an overview of the primary resources used to interact with Foxdeli:

  • Order: Represents a customer's order within an e-commerce platform. As the foundation for parcel creation, orders act as a parent resource in the data model.
  • Parcel: Represents a physical package associated with a previously created order. Par parcels can be optionally created, with the possibility of having multiple parcels for a single order.
  • Pickup place: Represents a pickup point where parcels are collected by customer.

By understanding the data model and its resources, you can effectively interact with the Foxdeli API and leverage its functionalities to manage your e-commerce workflows seamlessly.

Optional Fields and Functionality​

The Foxdeli API offers flexibility by making certain fields optional. These fields are clearly marked in the documentation. While not essential for creating basic orders and parcels, including them can unlock additional functionalities and improve your customers overall experience.

Here's a breakdown of how optional fields can impact your experience:

  • Creating Basic Orders and Parcels: You can still create functional orders and parcels even if you leave some fields blank.
  • Advanced Features and Tracking: Omitting optional fields might limit access to advanced functionalities like customized email templates or detailed information on the Tracking page.

In short, providing more data through optional fields enhances your experience by enabling advanced features within the Foxdeli system.