Execute the equipment step of an onboarding
Equip a joiner and close the Equipment step of their onboarding in one call: places the catalog order when order is provided, assigns devices and accessories from existing stock when assignedFromInventory is provided, then moves the step and its onboarding-ticket task to done and links the order to the ticket. Send neither when the joiner is already equipped — the step still closes. Returns the onboarding and the order placed, or order: null when nothing was purchased. This is the only way to close an onboarding Equipment step: updateTaskStatus refuses that task, and createOrder places an order without touching the onboarding. To buy for stock or outside an onboarding, use createOrder instead. To close a whole onboarding for someone already in post without ordering or provisioning anything, use completeOnboarding instead. Refused with ONBOARDING_EQUIPMENT_ALREADY_EXECUTED when the step is already done — that means the work happened, not that the call failed.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Path Parameters
Body
Catalog order to place. Omit when nothing is purchased.
Devices and accessories taken from existing stock and assigned to the employee.
Leave unset to keep the onboarding current setting.
Leave unset to keep the onboarding current setting.