Verify catalog user

Checks whether an email address belongs to an existing user for the target catalog.

POST/api/catalogs/{handle}/verify-user

Checks whether an email address belongs to an existing user for the target catalog.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"starter-catalog"

Request Body

application/json

Request payload for Verify catalog user.

email*string

Email address to verify within the target catalog.

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/catalogs/starter-catalog/verify-user" \  -H "Content-Type: application/json" \  -d '{    "email": "buyer@example.com"  }'

true

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Verify catalog user

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`