Easyteam Retail
    Easyteam Retail
    • Home
    • Staff Management
      • List all staff
        GET
      • Add a new staff member
        POST
      • Retrieve staff details
        GET
      • Update staff details
        PUT
      • Delete a staff member
        DELETE
    • Time Tracking
      • Clock-in for a shift
        POST
      • Clock-out from a shift
        POST
      • Start a break
        POST
      • End a break
        POST
    • Timesheets
      • Retrieve timesheets
        GET
      • Retrieve a staff member's timesheet
        GET
      • Adjust a timesheet
        PUT
      • Retrieve late staff
        GET
    • Schedules
      • Retrieve schedules
        GET
      • Create a new schedule
        POST
      • Retrieve schedule details
        GET
      • Update schedule details
        PUT
      • Delete a schedule
        DELETE
      • Export schedule data
        GET
      • Retrieve AI store traffic
        GET
    • Commissions
      • List all commission plans
        GET
      • Add a new commission plan
        POST
      • Update a commission plan
        PUT
      • Delete a commission plan
        DELETE
      • Retrieve commission reports
        GET
      • Change order attribution
        PUT
      • AI insights for sales increases
        GET
    • Sales Performance
      • Retrieve sales performance by location
      • Set sales goals
      • Check location goal status
      • AI-based sales goal prediction
      • Retrieve top-performing staff
    • Payroll Management
      • Retrieve payroll by location
      • Process payroll for a timeframe
      • Retrieve payroll history
      • Retrieve pay slips
      • Retrieve tax details
      • Onboard staff to payroll
      • Terminate staff payroll
    • Checklists
      • Retrieve all checklists
      • Create a new checklist
      • Update a checklist
      • Delete a checklist
      • Check a task inside a checklist
      • Webhook for pending checklists

    Home

    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.
    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.

    🛠️ 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.
    Next
    List all staff