Skip to main content

Quickstart Guide for Foxdeli API

Zero-effort integrations

Did you know there are prebuilt zero-effort modules that can be integrated into selected e-commerce solutions? Check here.

Foxdeli API adheres to the established principles of RESTful APIs. This means it leverages a consistent and predictable structure for its URLs, making them easy to understand and navigate. The API primarily interacts with data through:

  • JSON-formatted request bodies: These bodies clearly outline the specific data being sent to the API.
  • JSON-formatted responses: The API returns information in a structured and easily interpretable format.
  • RFC7808 application/problem error reponses: The API returns standard HTTP error codes and a payload in the response body describing cause of error.
  • Standard HTTP verbs and codes: Familiar verbs like GET, POST, PUT, and DELETE are used to interact with resources, while standard response codes provide informative feedback on the success or failure of requests.

To optimize performance and user experience, Foxdeli also offers:

  • ETag and If-None-Match headers: These headers allow efficient caching of resources, ensuring users only receive updated information when necessary.
  • Partial updates with PATCH: This method enables users to modify specific fields within a resource without needing to send the entire entity again, streamlining data modifications.

This topic describes how to get started with Foxdeli v1 REST APIs.

Recommended reading

Before getting started with this quickstart guide, we recommend that you read Introduction to Foxdeli to familiarize yourself with basic Foxdeli concepts.

Objectives​

In this quickstart you'll learn: