AlphaAlpha Docs

Shop

Public shop endpoints

Get shop categories

GET
/public/shop/{tenantCode}/categories
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/shop/string/categories"
[
  "string"
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get public shop products

GET
/public/shop/{tenantCode}/products
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string

Query Parameters

search?string
category?string
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sortBy?string
sortDirection?string
Value in"ASC" | "DESC"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/shop/string/products"
{
  "content": [
    {
      "category": "string",
      "currency": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "price": 0.1,
      "supplier": "string",
      "thumbnail": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get a single shop product

GET
/public/shop/{tenantCode}/products/{productId}
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string
productId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/shop/string/products/string"
{
  "category": "string",
  "currency": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "price": 0.1,
  "supplier": "string",
  "thumbnail": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  }
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Register a new shop client

POST
/public/shop/{tenantCode}/register
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/shop/string/register" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "verificationBaseUrl": "string"  }'
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}