TOtopi
ops
ops-sales-agents

Create a sales agent

Changed on

Add a new seller portal sales agent

post/ops/sales-agents

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/sales-agents
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-seller:edit

Request body

emailstring email required

E-mail

external_agent_idstring

Id number used to identify the sales agent in the seller's internal system

namestring required

Name of the agent

phonestring required

Phone number

seller_idstring regexp

Seller ID

seller_store_idstring

Id number used to identify the store a PoS agent is operating from

topi_relevantboolean

Whether the user is relevant for driving topi GMV, this allows us to opt out users that are managers or are not expected to do much sales from reporting.

Example request

{
  "email": "alice@example.com",
  "external_agent_id": "abc123",
  "name": "abc123",
  "phone": "abc123",
  "seller_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "seller_store_id": "abc123",
  "topi_relevant": false
}

Response

Created response.

emailstring email required

E-mail

external_agent_idstring

Id number used to identify the sales agent in the seller's internal system

idstring required

Auth0 Sales Agent ID

languagestring

User language

last_loginstring date-time
namestring required

Name of the agent

phonestring required

Phone number

seller_idstring regexp

Seller ID

seller_store_idstring

Id number used to identify the store a PoS agent is operating from

statusstring

User status

topi_relevantboolean

Whether the user is relevant for driving topi GMV, this allows us to opt out users that are managers or are not expected to do much sales from reporting.

Example response

{
  "email": "alice@example.com",
  "external_agent_id": "abc123",
  "id": "auth0|63881a171828b3997ad1b3fc",
  "language": "abc123",
  "last_login": "1970-01-01T00:00:01Z",
  "name": "abc123",
  "phone": "abc123",
  "seller_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "seller_store_id": "abc123",
  "status": "abc123",
  "topi_relevant": false
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id portal_sales_agents.addPortalAgent removed and replaced with portal_sales_agents#addPortalAgent

  • 7ff7ee94b30eRevision changes
    • info

      api operation id portal_sales_agents#addPortalAgent removed and replaced with portal_sales_agents.addPortalAgent

    • info

      api tag ops-sales-agents added