DevelopersAPI reference

Store managers API

REST endpoints for store managers in SKUFlow: 6 operations with parameters, request and response fields, permissions and curl examples.

Base URL: https://app.skuflow.ai/api. Every call needs Authorization: Bearer skf_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

OperationEndpointRisk
A store's managersGET /organizations/{organizationId}/stores/{storeId}/managersread
Make someone a store managerPOST /organizations/{organizationId}/stores/{storeId}/managerssensitive
Rename a store managerPATCH /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}write
Remove a store managerDELETE /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}sensitive
Sign a store manager out everywherePOST /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}/sign-outsensitive
Email a store manager how to sign inPOST /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}/send-sign-insensitive

A store's managers

GET /organizations/{organizationId}/stores/{storeId}/managers

The people of the store's customer who manage it on the store's own site (sign-in address signInUrl, the store's address + /manage): email, name, when they last signed in and devices signed in now. canAdd is false until the store is for a customer. Read-only.

Permissionstores.read (Owner, Admin, Staff, Member)
Riskread, OAuth scope skuflow.read. Read: reads only.
MCP toolstoreManagers_list (toolset stores)

Parameters

NameInTypeRequiredDescription
storeIdpathstringYesThe store (GET /stores).

Example

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/stores/{storeId}/managers" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

Response

200: the answer's fields
FieldTypeDescription
itemsarray of object
items[].idstring
items[].emailstring
items[].namestring or null
items[].lastSignedInAtstring (date-time) or null
items[].createdAtstring (date-time)
items[].signedInDevicesintegerDevices signed in now.
signInUrlstring
canAddboolean

Make someone a store manager

POST /organizations/{organizationId}/stores/{storeId}/managers

Grants access: the person (by email) can sign in on the store's own site with a code sent to that email and manage it: show, hide, arrange and add the items prepared for the store's customer (their customer products), see and export the store's orders, change its banner, welcome text, logo, contact and categories, its shoppers (password, email domains, invites, allowance) and open or close it; in an AFFILIATE store also make their own items and set selling prices (never below the base). They take no seat and see nothing else of the business. The store must be for a customer (409 otherwise); up to 10 managers; the same email once (409). Send them the sign-in link with POST …/managers/{storeManagerId}/send-sign-in.

Permissionstores.manage (Owner, Admin, Staff)
Risksensitive, OAuth scope skuflow.sensitive. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP toolstoreManagers_add (toolset stores)
PlanOnline stores: the Grow plan and up.
ApprovalWaits for your approval in SKUFlow when called with an API key or a connected app: the first call answers 428 APPROVAL_REQUIRED; once you approve it, repeat the call with the X-SKUFlow-Approval header. See Approvals.

Parameters

NameInTypeRequiredDescription
storeIdpathstringYesThe store (GET /stores).

Request body

FieldTypeRequiredDescription
emailstring (email)YesThe address sign-in codes go to. Up to 254 characters.
namestring or nullNoUp to 200 characters.

Example

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/stores/{storeId}/managers" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"dana@example.com"}'

Response

201: the answer's fields
FieldTypeDescription
managerobject
manager.idstring
manager.emailstring
manager.namestring or null
manager.lastSignedInAtstring (date-time) or null
manager.createdAtstring (date-time)
manager.signedInDevicesintegerDevices signed in now.
signInUrlstring

Rename a store manager

PATCH /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}

Changes the manager's name (their email is their sign-in: remove and add them again to change it).

Permissionstores.manage (Owner, Admin, Staff)
Riskwrite, OAuth scope skuflow.write. Write: creates or changes records inside the business; nothing leaves it.
MCP toolstoreManagers_update (toolset stores)
PlanOnline stores: the Grow plan and up.

Parameters

NameInTypeRequiredDescription
storeIdpathstringYesThe store (GET /stores).
storeManagerIdpathstringYesThe store manager (GET /stores/{storeId}/managers).

Request body

FieldTypeRequiredDescription
namestring or nullYesUp to 200 characters.

Example

curl -X PATCH "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/stores/{storeId}/managers/{storeManagerId}" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Dana Whitfield"}'

Response

200: the answer's fields
FieldTypeDescription
idstring
emailstring
namestring or null
lastSignedInAtstring (date-time) or null
createdAtstring (date-time)
signedInDevicesintegerDevices signed in now.

Remove a store manager

DELETE /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}

Revokes access: the person can no longer sign in on the store's site; their sessions end at once. Items an affiliate made stay in the store.

Permissionstores.manage (Owner, Admin, Staff)
Risksensitive, OAuth scope skuflow.sensitive. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP toolstoreManagers_remove (toolset stores)
ApprovalOver MCP, this tool always waits for your approval in SKUFlow. See Approvals.

Parameters

NameInTypeRequiredDescription
storeIdpathstringYesThe store (GET /stores).
storeManagerIdpathstringYesThe store manager (GET /stores/{storeId}/managers).

Example

curl -X DELETE "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/stores/{storeId}/managers/{storeManagerId}" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

Response

200: the answer's fields
FieldTypeDescription
deletedtrue

Sign a store manager out everywhere

POST /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}/sign-out

Revokes access: ends every session of this manager (they can sign in again with a new code).

Permissionstores.manage (Owner, Admin, Staff)
Risksensitive, OAuth scope skuflow.sensitive. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP toolstoreManagers_signOut (toolset stores)
ApprovalOver MCP, this tool asks for your OK first (in the AI app when it supports it, otherwise in SKUFlow). See Approvals.

Parameters

NameInTypeRequiredDescription
storeIdpathstringYesThe store (GET /stores).
storeManagerIdpathstringYesThe store manager (GET /stores/{storeId}/managers).

Example

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/stores/{storeId}/managers/{storeManagerId}/sign-out" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

Response

200: the answer's fields
FieldTypeDescription
revokedinteger

Email a store manager how to sign in

POST /organizations/{organizationId}/stores/{storeId}/managers/{storeManagerId}/send-sign-in

SENDS AN EMAIL to the manager (through the business's email, as a transactional message): they manage the store and sign in at its address + /manage with their email (a code comes then; nothing secret is in this email). At most one a minute per manager.

Permissionstores.manage (Owner, Admin, Staff)
Risksensitive, OAuth scope skuflow.sensitive. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP toolstoreManagers_sendSignIn (toolset stores)
PlanOnline stores: the Grow plan and up.
ApprovalOver MCP, this tool asks for your OK first (in the AI app when it supports it, otherwise in SKUFlow). See Approvals.

Parameters

NameInTypeRequiredDescription
storeIdpathstringYesThe store (GET /stores).
storeManagerIdpathstringYesThe store manager (GET /stores/{storeId}/managers).

Example

curl -X POST "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/stores/{storeId}/managers/{storeManagerId}/send-sign-in" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

Response

200: the answer's fields
FieldTypeDescription
signInUrlstring
statusstringThe message's status (SENT, SENT_TEST, SKIPPED…).

On this page