Easyteam Retail API Documentation

Welcome to the EasyTeam Retail API documentation. Easyteam is the leading workforce management solution for Shopify and retail businesses, streamlining staff management, scheduling, payroll, and performance tracking. Our robust API provides developers and agencies with the tools to automate and enhance retail operations for Shopify Plus and Enterprises.

This API is available for Shopify Plus and Enterprise merchants, as well as Shopify agencies specializing in Shopify POS implementations. For further details, contact us here or contact our partnerships team at partnerships@easyteam.com.

---

Table of Contents

1. Introduction
2. Getting Started
3. API Overview
4. Core Features
   • Staff Management
   • Time Tracking
   • Timesheets
   • Scheduling
   • Commissions Management
   • Sales Performance
   • Payroll Management
   • Checklists
5. Authentication
6. Error Handling
7. Webhooks
8. Changelog

---

🔑 Getting Started

To begin using the Easyteam Retail API:

1. Obtain API credentials: Get your API key via your account manager.
2. Set up authentication: Use the API key in the header for all requests.

   GET /v1/resource HTTP/1.1
   Host: api.easyteam.com
   Authorization: Bearer YOUR_API_KEY
   

3. Explore the endpoints: Use this guide to interact with the API.

---

📚 API Overview

The API is organized into distinct sections for easy access:

• Staff Management: Manage staff details, roles, and onboarding.
• Time Tracking: Track staff clock-ins, breaks, and clock-outs.
• Scheduling: Automate and optimize shift scheduling by location.
• Payroll Management: Handle payroll processing, taxes, and pay slips.
• Sales Performance: Set and track goals, and retrieve AI-driven insights.
• Checklists: Manage tasks and ensure store operations are completed.

---

🔒 Authentication

All requests require an API key. Include it in the Authorization header.

Authorization: Bearer YOUR_API_KEY

---

🛠️ Webhooks

Webhooks allow real-time updates for critical events, such as:

• Staff clocking in/out
• Pending checklists when all staff clock out
• Etc.

---

Need Help?

If you need assistance, visit our Support Center or contact support@easyteam.com.