Repzo API - Storecheck Template (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Storecheck Template endpoints.

Find storecheck templates

query Parameters

object

Query parameters for filtering storecheck templates

Responses

Response samples

200

Content type

application/json

{"data": [{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"sections": [{"title": "string",
"questions": [{"id": "string",
"text": "string",
"type": "text",
"required": true,
"options": ["string"
]
}
]
}
],
"targets": ["string"
],
"frequency": "daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"disabled": true,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
],
"total_result": 0,
"current_count": 0,
"total_pages": 0,
"current_page": 0,
"per_page": 0
}

Create a storecheck template

Request Body schema: application/json

name required	string Name of the storecheck template
description	string Description of the template
category	string Category of the storecheck
required	Array of objects Template sections and questions
targets	Array of strings Target entities (clients, routes, etc.)
frequency	string Enum: "daily" "weekly" "monthly" "quarterly" "yearly" "custom" Frequency of storecheck execution
validFrom	string <date-time> Start date of template validity
validTo	string <date-time> End date of template validity
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"category": "string",
"sections": [{"title": "string",
"questions": [{"text": "string",
"type": "text",
"required": true,
"options": ["string"
]
}
]
}
],
"targets": ["string"
],
"frequency": "daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"integration_meta": { }
}

Response samples

201

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"sections": [{"title": "string",
"questions": [{"id": "string",
"text": "string",
"type": "text",
"required": true,
"options": ["string"
]
}
]
}
],
"targets": ["string"
],
"frequency": "daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"disabled": true,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Get a storecheck template by ID

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"sections": [{"title": "string",
"questions": [{"id": "string",
"text": "string",
"type": "text",
"required": true,
"options": ["string"
]
}
]
}
],
"targets": ["string"
],
"frequency": "daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"disabled": true,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Update a storecheck template

path Parameters

id

required

string

Request Body schema: application/json

name	string Name of the storecheck template
description	string Description of the template
category	string Category of the storecheck
	Array of objects Template sections and questions
targets	Array of strings Target entities (clients, routes, etc.)
frequency	string Enum: "daily" "weekly" "monthly" "quarterly" "yearly" "custom" Frequency of storecheck execution
validFrom	string <date-time> Start date of template validity
validTo	string <date-time> End date of template validity
disabled	boolean Whether the template is disabled
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"category": "string",
"sections": [{"title": "string",
"questions": [{"id": "string",
"text": "string",
"type": "text",
"required": true,
"options": ["string"
]
}
]
}
],
"targets": ["string"
],
"frequency": "daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"disabled": true,
"integration_meta": { }
}

Response samples

200

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"sections": [{"title": "string",
"questions": [{"id": "string",
"text": "string",
"type": "text",
"required": true,
"options": ["string"
]
}
]
}
],
"targets": ["string"
],
"frequency": "daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"disabled": true,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Remove a storecheck template

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"sections": [{"title": "string",
"questions": [{"id": "string",
"text": "string",
"type": "text",
"required": true,
"options": ["string"
]
}
]
}
],
"targets": ["string"
],
"frequency": "daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"disabled": true,
"integration_meta": { },
"company_namespace": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}