API docs by Redocly

Activity Storecheck API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing activity storecheck records

Activity Storecheck

Operations related to activity storecheck management

Get all activity storecheck records

Retrieve a list of all activity storecheck records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new activity storecheck record

Create a new activity storecheck record with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client identifier

rep
required
string

Sales representative identifier

template
required
string

Storecheck template identifier

date
required
string <date-time>

Date and time of the storecheck activity

object
Array of objects
status
string
Default: "draft"
Enum: "draft" "submitted" "approved" "rejected"

Status of the storecheck activity

notes
string

Additional notes

Responses

Request samples

Content type
application/json
{
  • "client": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "rep": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "date": "2023-01-15T10:30:00Z",
  • "location": {
    },
  • "responses": [
    ],
  • "status": "draft",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get activity storecheck record by ID

Retrieve a specific activity storecheck record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity storecheck record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update activity storecheck record

Update an existing activity storecheck record with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity storecheck record ID

Request Body schema: application/json
client
required
string

Client identifier

rep
required
string

Sales representative identifier

template
required
string

Storecheck template identifier

date
required
string <date-time>

Date and time of the storecheck activity

object
Array of objects
status
string
Default: "draft"
Enum: "draft" "submitted" "approved" "rejected"

Status of the storecheck activity

notes
string

Additional notes

Responses

Request samples

Content type
application/json
{
  • "client": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "rep": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "date": "2023-01-15T10:30:00Z",
  • "location": {
    },
  • "responses": [
    ],
  • "status": "draft",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete activity storecheck record

Delete an existing activity storecheck record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Activity storecheck record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Activity storecheck record deleted successfully"
}