Skip to main content

Start Year-End Count Check-in

POST 
/api/success-plan/check-ins/year-end

Tells SKU.io you did your year-end stock count, and returns the year-end check-in to answer. Creates it (201) the first time; afterwards returns the existing one (200), made due again unless it was already answered.

Required scope: success_plan:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token with the success_plan:write scope. The user must hold the success_plan.manage permission.

Body (optional):

  • stock_take_ids (integer array, max 50): the stock takes that made up the count.
  • count_date (date, not in the future): when you counted; defaults to today.

Check-in objects carry id, kind (go_live_14, day_30, day_90, day_180, year_end), title, due_on, status (scheduled, due, snoozed, answered, skipped, lapsed) with status_label, snoozed_until, snooze_count, can_snooze, can_answer, answered_by, answered_at, questions and answers. Questions are fixed the first time a check-in is due; each has a key, goal_id, label, input (number, roles_hours, yes_no, yes_partly_no, checklist, text), unit, optional, previous_reading_id and, for a checklist, items. The schedule is in Get Success Plan (check_ins). Answers in your own words (text) are customer text: show them as plain text, never as HTML.

Request​

Responses​

OK

Response Headers
    Content-Type