{
"openapi": "3.1.0",
"x-powered-by": "strapi",
"x-strapi-version": "5.23.1",
"info": {
"title": "pixory-cms",
"description": "API documentation for pixory-cms v0.1.0",
"version": "0.1.0"
},
"paths": {
"/addresses": {
"get": {
"operationId": "address/get/addresses",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"isDefaultShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"isDefaultBilling": {
"description": "A boolean field",
"type": "boolean"
},
"firstName": {
"description": "A string field",
"type": "string"
},
"lastName": {
"description": "A string field",
"type": "string"
},
"addressLine1": {
"description": "A string field",
"type": "string"
},
"addressLine2": {
"description": "A string field",
"type": "string"
},
"zipCode": {
"description": "A string field",
"type": "string"
},
"city": {
"description": "A string field",
"type": "string"
},
"phoneNumber": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.469Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"state": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"country": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"billingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
}
},
"required": [
"documentId",
"id",
"isDefaultShipping",
"firstName",
"lastName",
"addressLine1",
"zipCode",
"city",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"address"
]
},
"post": {
"operationId": "address/post/addresses",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"isDefaultShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"isDefaultBilling": {
"description": "A boolean field",
"type": "boolean"
},
"firstName": {
"description": "A string field",
"type": "string"
},
"lastName": {
"description": "A string field",
"type": "string"
},
"addressLine1": {
"description": "A string field",
"type": "string"
},
"addressLine2": {
"description": "A string field",
"type": "string"
},
"zipCode": {
"description": "A string field",
"type": "string"
},
"city": {
"description": "A string field",
"type": "string"
},
"phoneNumber": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.489Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"state": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"country": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"billingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
}
},
"required": [
"documentId",
"id",
"isDefaultShipping",
"firstName",
"lastName",
"addressLine1",
"zipCode",
"city",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"address"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"isDefaultShipping": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"isDefaultBilling": {
"description": "A boolean field",
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"firstName": {
"description": "A string field",
"type": "string"
},
"lastName": {
"description": "A string field",
"type": "string"
},
"addressLine1": {
"description": "A string field",
"type": "string"
},
"addressLine2": {
"description": "A string field",
"type": "string"
},
"zipCode": {
"description": "A string field",
"type": "string"
},
"city": {
"description": "A string field",
"type": "string"
},
"phoneNumber": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.488Z",
"type": "string"
},
"user": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"state": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"country": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"shippingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"billingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"isDefaultShipping",
"firstName",
"lastName",
"addressLine1",
"zipCode",
"city",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/addresses/{id}": {
"put": {
"operationId": "address/put/addresses_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"isDefaultShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"isDefaultBilling": {
"description": "A boolean field",
"type": "boolean"
},
"firstName": {
"description": "A string field",
"type": "string"
},
"lastName": {
"description": "A string field",
"type": "string"
},
"addressLine1": {
"description": "A string field",
"type": "string"
},
"addressLine2": {
"description": "A string field",
"type": "string"
},
"zipCode": {
"description": "A string field",
"type": "string"
},
"city": {
"description": "A string field",
"type": "string"
},
"phoneNumber": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.492Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"state": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"country": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"billingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
}
},
"required": [
"documentId",
"id",
"isDefaultShipping",
"firstName",
"lastName",
"addressLine1",
"zipCode",
"city",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"address"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"isDefaultShipping": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"isDefaultBilling": {
"description": "A boolean field",
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"firstName": {
"description": "A string field",
"type": "string"
},
"lastName": {
"description": "A string field",
"type": "string"
},
"addressLine1": {
"description": "A string field",
"type": "string"
},
"addressLine2": {
"description": "A string field",
"type": "string"
},
"zipCode": {
"description": "A string field",
"type": "string"
},
"city": {
"description": "A string field",
"type": "string"
},
"phoneNumber": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.491Z",
"type": "string"
},
"user": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"state": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"country": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"shippingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"billingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "address/delete/addresses_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"state",
"country",
"shippingOrders",
"billingOrders"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"isDefaultShipping",
"isDefaultBilling",
"firstName",
"lastName",
"addressLine1",
"addressLine2",
"zipCode",
"city",
"phoneNumber",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"isDefaultShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"isDefaultBilling": {
"description": "A boolean field",
"type": "boolean"
},
"firstName": {
"description": "A string field",
"type": "string"
},
"lastName": {
"description": "A string field",
"type": "string"
},
"addressLine1": {
"description": "A string field",
"type": "string"
},
"addressLine2": {
"description": "A string field",
"type": "string"
},
"zipCode": {
"description": "A string field",
"type": "string"
},
"city": {
"description": "A string field",
"type": "string"
},
"phoneNumber": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.493Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"state": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"country": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"billingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
}
},
"required": [
"documentId",
"id",
"isDefaultShipping",
"firstName",
"lastName",
"addressLine1",
"zipCode",
"city",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"address"
]
}
},
"/addresses/default-shipping/{id}": {
"post": {
"operationId": "address/post/addresses_default_shipping_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"address"
]
}
},
"/addresses/default-billing/{id}": {
"post": {
"operationId": "address/post/addresses_default_billing_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"address"
]
}
},
"/book-settings": {
"get": {
"operationId": "book-setting/get/book_settings",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.495Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-setting"
]
},
"post": {
"operationId": "book-setting/post/book_settings",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.497Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-setting"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.497Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"bookType": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"paperFinish": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"pricing": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"required": [
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/book-settings/{id}": {
"get": {
"operationId": "book-setting/get/book_settings_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.496Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-setting"
]
},
"put": {
"operationId": "book-setting/put/book_settings_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.498Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-setting"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.498Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"bookType": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"paperFinish": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"pricing": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "book-setting/delete/book_settings_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"bookSize",
"bookType",
"paperFinish",
"pricing"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.500Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-setting"
]
}
},
"/book-sizes": {
"get": {
"operationId": "book-size/get/book_sizes",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.502Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-size"
]
},
"post": {
"operationId": "book-size/post/book_sizes",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.504Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-size"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.504Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/book-sizes/{id}": {
"get": {
"operationId": "book-size/get/book_sizes_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.503Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-size"
]
},
"put": {
"operationId": "book-size/put/book_sizes_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.505Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-size"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.505Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "book-size/delete/book_sizes_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.506Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-size"
]
}
},
"/book-types": {
"get": {
"operationId": "book-type/get/book_types",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.509Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"minPages",
"maxPages",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-type"
]
},
"post": {
"operationId": "book-type/post/book_types",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.513Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"minPages",
"maxPages",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-type"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.512Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"title",
"minPages",
"maxPages",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/book-types/{id}": {
"get": {
"operationId": "book-type/get/book_types_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.511Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"minPages",
"maxPages",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-type"
]
},
"put": {
"operationId": "book-type/put/book_types_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.514Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"minPages",
"maxPages",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-type"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.514Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "book-type/delete/book_types_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings",
"shippingPrices"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"minPages",
"maxPages",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.515Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"minPages",
"maxPages",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"book-type"
]
}
},
"/campaigns": {
"get": {
"operationId": "campaign/get/campaigns",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.518Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
}
},
"required": [
"documentId",
"id",
"code",
"freeShipping",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign"
]
},
"post": {
"operationId": "campaign/post/campaigns",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.521Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
}
},
"required": [
"documentId",
"id",
"code",
"freeShipping",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.520Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"code",
"freeShipping",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/campaigns/{id}": {
"get": {
"operationId": "campaign/get/campaigns_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.520Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
}
},
"required": [
"documentId",
"id",
"code",
"freeShipping",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign"
]
},
"put": {
"operationId": "campaign/put/campaigns_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.522Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
}
},
"required": [
"documentId",
"id",
"code",
"freeShipping",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.522Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "campaign/delete/campaigns_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"code",
"freeShipping",
"discountPercent",
"discountFixed",
"usersLimit",
"timeLimit",
"perUserLimit",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.523Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
}
},
"required": [
"documentId",
"id",
"code",
"freeShipping",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign"
]
}
},
"/campaign-usages": {
"get": {
"operationId": "campaign-usage/get/campaign_usages",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.525Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiCampaignCampaignDocument"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign-usage"
]
},
"post": {
"operationId": "campaign-usage/post/campaign_usages",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.527Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiCampaignCampaignDocument"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign-usage"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.527Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"order": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"user": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"required": [
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/campaign-usages/{id}": {
"get": {
"operationId": "campaign-usage/get/campaign_usages_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.526Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiCampaignCampaignDocument"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign-usage"
]
},
"put": {
"operationId": "campaign-usage/put/campaign_usages_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.528Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiCampaignCampaignDocument"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign-usage"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.527Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"order": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"user": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "campaign-usage/delete/campaign_usages_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign",
"order",
"user"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.528Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiCampaignCampaignDocument"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"campaign-usage"
]
}
},
"/carts": {
"get": {
"operationId": "cart/get/carts",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"orderedProjects",
"orderAdditives",
"user"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"orderedProjects",
"orderAdditives",
"user"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.529Z",
"type": "string"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
},
"orderAdditives": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderAdditiveOrderAdditiveDocument"
}
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"cart"
]
},
"post": {
"operationId": "cart/post/carts",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"orderedProjects",
"orderAdditives",
"user"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"orderedProjects",
"orderAdditives",
"user"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.532Z",
"type": "string"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
},
"orderAdditives": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderAdditiveOrderAdditiveDocument"
}
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"cart"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.532Z",
"type": "string"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"orderAdditives": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"user": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"required": [
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/carts/set": {
"put": {
"operationId": "cart/put/carts_set",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"cart"
]
}
},
"/carts/add": {
"put": {
"operationId": "cart/put/carts_add",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"cart"
]
}
},
"/configuration": {
"get": {
"operationId": "configuration/get/configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"defaultCurrency",
"availableCurrencies",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"defaultBookSetting"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"defaultBookSetting"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"defaultCurrency",
"availableCurrencies",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"defaultCurrency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"availableCurrencies": {
"description": "A JSON field"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.534Z",
"type": "string"
},
"defaultBookSetting": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"required": [
"documentId",
"id",
"defaultCurrency",
"availableCurrencies",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"configuration"
]
},
"put": {
"operationId": "configuration/put/configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"defaultCurrency",
"availableCurrencies",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"defaultBookSetting"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"defaultBookSetting"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"defaultCurrency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"availableCurrencies": {
"description": "A JSON field"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.535Z",
"type": "string"
},
"defaultBookSetting": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"required": [
"documentId",
"id",
"defaultCurrency",
"availableCurrencies",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"configuration"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"defaultCurrency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"availableCurrencies": {
"description": "A JSON field"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.535Z",
"type": "string"
},
"defaultBookSetting": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "configuration/delete/configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"defaultCurrency",
"availableCurrencies",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"defaultBookSetting"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"defaultBookSetting"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"defaultCurrency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"availableCurrencies": {
"description": "A JSON field"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.536Z",
"type": "string"
},
"defaultBookSetting": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"required": [
"documentId",
"id",
"defaultCurrency",
"availableCurrencies",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"configuration"
]
}
},
"/facebook-pixel-configuration": {
"get": {
"operationId": "facebook-pixel-configuration/get/facebook_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.536Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"facebook-pixel-configuration"
]
},
"put": {
"operationId": "facebook-pixel-configuration/put/facebook_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.537Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"facebook-pixel-configuration"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"enabled": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.537Z",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "facebook-pixel-configuration/delete/facebook_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.538Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"facebook-pixel-configuration"
]
}
},
"/my-user": {
"put": {
"operationId": "my-user/put/my_user",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"my-user"
]
},
"get": {
"operationId": "my-user/get/my_user",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"my-user"
]
}
},
"/orders/checkout": {
"post": {
"operationId": "order/post/orders_checkout",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order"
]
}
},
"/orders/set-addresses": {
"put": {
"operationId": "order/put/orders_set_addresses",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order"
]
}
},
"/orders/use-campaign": {
"put": {
"operationId": "order/put/orders_use_campaign",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order"
]
}
},
"/orders/order": {
"post": {
"operationId": "order/post/orders_order",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order"
]
}
},
"/orders": {
"get": {
"operationId": "order/get/orders",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages",
"creator",
"shippingAddress",
"billingAddress",
"orderedProjects",
"refund"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages",
"creator",
"shippingAddress",
"billingAddress",
"orderedProjects",
"refund"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"orderStatus": {
"description": "An enum field",
"default": "Scheduled",
"type": "string",
"enum": [
"Scheduled",
"Open",
"Cancelled",
"In Progress"
]
},
"paymentStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Paid",
"Failed",
"Refunded (partially)",
"Refunded"
]
},
"deliveryStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Shipped",
"Cancelled"
]
},
"currency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"orderPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"orderPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"paidAt": {
"description": "A datetime field",
"type": "string"
},
"peechoOrderId": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"paymentIntentId": {
"description": "A string field",
"type": "string"
},
"printboxOrderId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.541Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
},
"creator": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"shippingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"billingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
},
"refund": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRefundRefundDocument"
}
},
"required": [
"documentId",
"id",
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order"
]
}
},
"/orders/{id}": {
"get": {
"operationId": "order/get/orders_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages",
"creator",
"shippingAddress",
"billingAddress",
"orderedProjects",
"refund"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages",
"creator",
"shippingAddress",
"billingAddress",
"orderedProjects",
"refund"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"orderStatus": {
"description": "An enum field",
"default": "Scheduled",
"type": "string",
"enum": [
"Scheduled",
"Open",
"Cancelled",
"In Progress"
]
},
"paymentStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Paid",
"Failed",
"Refunded (partially)",
"Refunded"
]
},
"deliveryStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Shipped",
"Cancelled"
]
},
"currency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"orderPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"orderPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"paidAt": {
"description": "A datetime field",
"type": "string"
},
"peechoOrderId": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"paymentIntentId": {
"description": "A string field",
"type": "string"
},
"printboxOrderId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.543Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
},
"creator": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"shippingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"billingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
},
"refund": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRefundRefundDocument"
}
},
"required": [
"documentId",
"id",
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order"
]
},
"put": {
"operationId": "order/put/orders_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"paidAt",
"peechoOrderId",
"paymentIntentId",
"printboxOrderId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"campaignUsages",
"creator",
"shippingAddress",
"billingAddress",
"orderedProjects",
"refund"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"campaignUsages",
"creator",
"shippingAddress",
"billingAddress",
"orderedProjects",
"refund"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"orderStatus": {
"description": "An enum field",
"default": "Scheduled",
"type": "string",
"enum": [
"Scheduled",
"Open",
"Cancelled",
"In Progress"
]
},
"paymentStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Paid",
"Failed",
"Refunded (partially)",
"Refunded"
]
},
"deliveryStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Shipped",
"Cancelled"
]
},
"currency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"orderPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"orderPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"paidAt": {
"description": "A datetime field",
"type": "string"
},
"peechoOrderId": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"paymentIntentId": {
"description": "A string field",
"type": "string"
},
"printboxOrderId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.549Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
},
"creator": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"shippingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"billingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
},
"refund": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRefundRefundDocument"
}
},
"required": [
"documentId",
"id",
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"orderStatus": {
"description": "An enum field",
"default": "Scheduled",
"type": "string",
"enum": [
"Scheduled",
"Open",
"Cancelled",
"In Progress"
]
},
"paymentStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Paid",
"Failed",
"Refunded (partially)",
"Refunded"
]
},
"deliveryStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Shipped",
"Cancelled"
]
},
"currency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"orderPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"orderPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"paidAt": {
"description": "A datetime field",
"type": "string"
},
"peechoOrderId": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"paymentIntentId": {
"description": "A string field",
"type": "string"
},
"printboxOrderId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.548Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"creator": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"shippingAddress": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"billingAddress": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"refund": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/order-additives": {
"get": {
"operationId": "order-additive/get/order_additives",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.552Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"description",
"price",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order-additive"
]
},
"post": {
"operationId": "order-additive/post/order_additives",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.554Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"description",
"price",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order-additive"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:38.874Z",
"type": "string"
}
},
"required": [
"title",
"description",
"price",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/order-additives/{id}": {
"get": {
"operationId": "order-additive/get/order_additives_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.553Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"description",
"price",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order-additive"
]
},
"put": {
"operationId": "order-additive/put/order_additives_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.555Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"description",
"price",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order-additive"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.554Z",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "order-additive/delete/order_additives_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"price",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.555Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"description",
"price",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"order-additive"
]
}
},
"/ordered-projects": {
"get": {
"operationId": "ordered-project/get/ordered_projects",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"project"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"project"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"quantity": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.556Z",
"type": "string"
},
"project": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"required": [
"documentId",
"id",
"quantity",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"ordered-project"
]
},
"post": {
"operationId": "ordered-project/post/ordered_projects",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"project"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"project"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"quantity": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.559Z",
"type": "string"
},
"project": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"required": [
"documentId",
"id",
"quantity",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"ordered-project"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"quantity": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.559Z",
"type": "string"
},
"project": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"required": [
"quantity",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/ordered-projects/{id}": {
"get": {
"operationId": "ordered-project/get/ordered_projects_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"project"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"project"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"quantity": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.558Z",
"type": "string"
},
"project": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"required": [
"documentId",
"id",
"quantity",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"ordered-project"
]
},
"put": {
"operationId": "ordered-project/put/ordered_projects_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"project"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"project"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"quantity": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.559Z",
"type": "string"
},
"project": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"required": [
"documentId",
"id",
"quantity",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"ordered-project"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"quantity": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.559Z",
"type": "string"
},
"project": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "ordered-project/delete/ordered_projects_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"project"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"project"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"quantity",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"quantity": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.560Z",
"type": "string"
},
"project": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"required": [
"documentId",
"id",
"quantity",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"ordered-project"
]
}
},
"/paper-finishes": {
"get": {
"operationId": "paper-finish/get/paper_finishes",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.561Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"paper-finish"
]
},
"post": {
"operationId": "paper-finish/post/paper_finishes",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.563Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"paper-finish"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.563Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/paper-finishes/{id}": {
"get": {
"operationId": "paper-finish/get/paper_finishes_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.562Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"paper-finish"
]
},
"put": {
"operationId": "paper-finish/put/paper_finishes_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.565Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"paper-finish"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.565Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "paper-finish/delete/paper_finishes_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"projects",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"projects",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"description",
"printboxId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.566Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"paper-finish"
]
}
},
"/pinterest-tag-configuration": {
"get": {
"operationId": "pinterest-tag-configuration/get/pinterest_tag_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.567Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pinterest-tag-configuration"
]
},
"put": {
"operationId": "pinterest-tag-configuration/put/pinterest_tag_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.568Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pinterest-tag-configuration"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"enabled": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.567Z",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "pinterest-tag-configuration/delete/pinterest_tag_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.568Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pinterest-tag-configuration"
]
}
},
"/pricings": {
"get": {
"operationId": "pricing/get/pricings",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.569Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProductProductDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"base",
"perPage",
"discount",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pricing"
]
},
"post": {
"operationId": "pricing/post/pricings",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.572Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProductProductDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"base",
"perPage",
"discount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.572Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"base",
"perPage",
"discount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/pricings/{id}": {
"get": {
"operationId": "pricing/get/pricings_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.570Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProductProductDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"base",
"perPage",
"discount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pricing"
]
},
"put": {
"operationId": "pricing/put/pricings_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.573Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProductProductDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"base",
"perPage",
"discount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pricing"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.573Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "pricing/delete/pricings_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"products",
"bookSettings"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"products",
"bookSettings"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"base",
"perPage",
"discount",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.574Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProductProductDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"base",
"perPage",
"discount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"pricing"
]
}
},
"/products": {
"get": {
"operationId": "product/get/products",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"printboxId",
"description",
"series",
"rating",
"mockReviewsCount",
"amountLeft",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"printboxId",
"description",
"series",
"rating",
"mockReviewsCount",
"amountLeft",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"printboxId",
"description",
"series",
"rating",
"mockReviewsCount",
"amountLeft",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"printboxId",
"description",
"series",
"rating",
"mockReviewsCount",
"amountLeft",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"printboxId",
"description",
"series",
"rating",
"mockReviewsCount",
"amountLeft",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"printboxId",
"description",
"series",
"rating",
"mockReviewsCount",
"amountLeft",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"pricing",
"projects"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"pricing",
"projects"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"series": {
"description": "A string field",
"type": "string"
},
"rating": {
"description": "An integer field",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"mockReviewsCount": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"amountLeft": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.575Z",
"type": "string"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"printboxId",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"product"
]
}
},
"/projects/book-size/{id}": {
"post": {
"operationId": "project/post/projects_book_size_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"project"
]
}
},
"/projects/book-type/{id}": {
"post": {
"operationId": "project/post/projects_book_type_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"project"
]
}
},
"/projects/paper-finish/{id}": {
"post": {
"operationId": "project/post/projects_paper_finish_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"project"
]
}
},
"/projects": {
"get": {
"operationId": "project/get/projects",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"user",
"product",
"bookType",
"bookSize",
"paperFinish",
"orderedProjects"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"product",
"bookType",
"bookSize",
"paperFinish",
"orderedProjects"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"default": "Custom travel book",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"priceDiscounted": {
"description": "A decimal field",
"type": "number"
},
"printboxProjectUuid": {
"description": "A string field",
"type": "string",
"minLength": 36,
"maxLength": 36
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.583Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"product": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProductProductDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"printboxProjectUuid",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"project"
]
},
"post": {
"operationId": "project/post/projects",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"user",
"product",
"bookType",
"bookSize",
"paperFinish",
"orderedProjects"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"product",
"bookType",
"bookSize",
"paperFinish",
"orderedProjects"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"default": "Custom travel book",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"priceDiscounted": {
"description": "A decimal field",
"type": "number"
},
"printboxProjectUuid": {
"description": "A string field",
"type": "string",
"minLength": 36,
"maxLength": 36
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.586Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"product": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProductProductDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"printboxProjectUuid",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"project"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"default": "Custom travel book",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"priceDiscounted": {
"description": "A decimal field",
"type": "number"
},
"printboxProjectUuid": {
"description": "A string field",
"type": "string",
"minLength": 36,
"maxLength": 36
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.586Z",
"type": "string"
},
"user": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"product": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"bookType": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"bookSize": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"paperFinish": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"title",
"printboxProjectUuid",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/projects/{id}": {
"delete": {
"operationId": "project/delete/projects_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"user",
"product",
"bookType",
"bookSize",
"paperFinish",
"orderedProjects"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"product",
"bookType",
"bookSize",
"paperFinish",
"orderedProjects"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"price",
"priceDiscounted",
"printboxProjectUuid",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"default": "Custom travel book",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"priceDiscounted": {
"description": "A decimal field",
"type": "number"
},
"printboxProjectUuid": {
"description": "A string field",
"type": "string",
"minLength": 36,
"maxLength": 36
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.589Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"product": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProductProductDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"printboxProjectUuid",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"project"
]
}
},
"/refunds": {
"get": {
"operationId": "refund/get/refunds",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"order"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"order"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.590Z",
"type": "string"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"required": [
"documentId",
"id",
"refundAmount",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"refund"
]
},
"post": {
"operationId": "refund/post/refunds",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"order"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"order"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.593Z",
"type": "string"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"required": [
"documentId",
"id",
"refundAmount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"refund"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.592Z",
"type": "string"
},
"order": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"required": [
"refundAmount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/refunds/{id}": {
"get": {
"operationId": "refund/get/refunds_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"order"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"order"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.592Z",
"type": "string"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"required": [
"documentId",
"id",
"refundAmount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"refund"
]
},
"put": {
"operationId": "refund/put/refunds_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"order"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"order"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.593Z",
"type": "string"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"required": [
"documentId",
"id",
"refundAmount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"refund"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.593Z",
"type": "string"
},
"order": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "refund/delete/refunds_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"order"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"order"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"refundAmount",
"description",
"refundedAt",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.594Z",
"type": "string"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"required": [
"documentId",
"id",
"refundAmount",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"refund"
]
}
},
"/regions": {
"get": {
"operationId": "region/get/regions",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.595Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"parentRegion": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingPrice": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiAddressAddressDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"region"
]
},
"post": {
"operationId": "region/post/regions",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.598Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"parentRegion": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingPrice": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiAddressAddressDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"region"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.598Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"parentRegion": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"shippingPrice": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/regions/{id}": {
"get": {
"operationId": "region/get/regions_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.596Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"parentRegion": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingPrice": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiAddressAddressDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"region"
]
},
"put": {
"operationId": "region/put/regions_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.599Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"parentRegion": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingPrice": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiAddressAddressDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"region"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.599Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"parentRegion": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"shippingPrice": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "region/delete/regions_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"subRegions",
"parentRegion",
"shippingPrice",
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"code",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.600Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"parentRegion": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingPrice": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiAddressAddressDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"region"
]
}
},
"/shipping-prices": {
"get": {
"operationId": "shipping-price/get/shipping_prices",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"regions",
"bookType"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"regions",
"bookType"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"minPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.602Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
}
},
"required": [
"documentId",
"id",
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"shipping-price"
]
},
"post": {
"operationId": "shipping-price/post/shipping_prices",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"regions",
"bookType"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"regions",
"bookType"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"minPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.605Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
}
},
"required": [
"documentId",
"id",
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"shipping-price"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"minPage": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.604Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookType": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"required": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/shipping-prices/{id}": {
"get": {
"operationId": "shipping-price/get/shipping_prices_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"regions",
"bookType"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"regions",
"bookType"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"minPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.603Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
}
},
"required": [
"documentId",
"id",
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"shipping-price"
]
},
"put": {
"operationId": "shipping-price/put/shipping_prices_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"regions",
"bookType"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"regions",
"bookType"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"minPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.606Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
}
},
"required": [
"documentId",
"id",
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"shipping-price"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"minPage": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "A float field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.605Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"bookType": {
"description": "A relational field",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "shipping-price/delete/shipping_prices_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"regions",
"bookType"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"regions",
"bookType"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"minPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.606Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
}
},
"required": [
"documentId",
"id",
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"shipping-price"
]
}
},
"/snapchat-pixel-configuration": {
"get": {
"operationId": "snapchat-pixel-configuration/get/snapchat_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.607Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"snapchat-pixel-configuration"
]
},
"put": {
"operationId": "snapchat-pixel-configuration/put/snapchat_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.608Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"snapchat-pixel-configuration"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"enabled": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.608Z",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "snapchat-pixel-configuration/delete/snapchat_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.608Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"snapchat-pixel-configuration"
]
}
},
"/tik-tok-pixel-configuration": {
"get": {
"operationId": "tik-tok-pixel-configuration/get/tik_tok_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.609Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"tik-tok-pixel-configuration"
]
},
"put": {
"operationId": "tik-tok-pixel-configuration/put/tik_tok_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.611Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"tik-tok-pixel-configuration"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"enabled": {
"description": "A boolean field",
"default": false,
"type": "string",
"enum": [
"0",
"1",
"t",
"true",
"f",
"false"
]
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.609Z",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "tik-tok-pixel-configuration/delete/tik_tok_pixel_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"enabled",
"pixelId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Fetch documents based on their status. Default to \"published\" if not specified.",
"type": "string",
"enum": [
"draft",
"published"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"enabled": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"pixelId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.611Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"enabled",
"pixelId",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"tik-tok-pixel-configuration"
]
}
},
"/user-tags": {
"get": {
"operationId": "user-tag/get/user_tags",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "_q",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string"
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.612Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"user-tag"
]
},
"post": {
"operationId": "user-tag/post/user_tags",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.613Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"user-tag"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.613Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"required": [
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/user-tags/{id}": {
"get": {
"operationId": "user-tag/get/user_tags_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the result",
"anyOf": [
{
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
{
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.613Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"user-tag"
]
},
"put": {
"operationId": "user-tag/put/user_tags_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.614Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"user-tag"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.614Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "user-tag/delete/user_tags_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": [
"users"
]
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": [
"users"
]
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"title",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.614Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"user-tag"
]
}
},
"/webhooks/stripe": {
"post": {
"operationId": "webhooks/post/webhooks_stripe",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"webhooks"
]
}
},
"/zigpoll-configuration": {
"get": {
"operationId": "zigpoll-configuration/get/zigpoll_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"zigpollId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Filters to apply to the query",
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"zigpollId",
"createdAt",
"updatedAt",
"publishedAt"
]
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"zigpollId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.615Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"zigpoll-configuration"
]
},
"put": {
"operationId": "zigpoll-configuration/put/zigpoll_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"zigpollId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"zigpollId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.617Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"zigpoll-configuration"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"zigpollId": {
"description": "A string field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.616Z",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
},
"delete": {
"operationId": "zigpoll-configuration/delete/zigpoll_configuration",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The fields to return, this doesn't include populatable fields like relations, components, files, or dynamic zones",
"readOnly": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"zigpollId",
"createdAt",
"updatedAt",
"publishedAt"
]
}
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"description": "Populate all the first level relations, components, files, and dynamic zones for the entry",
"readOnly": true,
"type": "string",
"const": "*"
},
{
"description": "Populate a single relation, component, file, or dynamic zone",
"readOnly": true,
"type": "string",
"enum": []
},
{
"description": "Populate a selection of multiple relations, components, files, or dynamic zones",
"type": "array",
"items": {
"type": "string",
"enum": []
}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"zigpollId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.618Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"zigpoll-configuration"
]
}
},
"/content-types": {
"get": {
"operationId": "content-type-builder/get/content_types",
"parameters": [
{
"name": "kind",
"in": "query",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"enum": [
"collectionType",
"singleType"
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"plugin": {
"type": "string"
},
"apiID": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"singularName": {
"type": "string"
},
"pluralName": {
"type": "string"
},
"description": {
"type": "string"
},
"draftAndPublish": {
"type": "boolean"
},
"kind": {
"type": "string",
"enum": [
"collectionType",
"singleType"
]
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"visible": {
"type": "boolean"
},
"restrictRelationsTo": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"options": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reviewWorkflows": {
"type": "boolean"
},
"populateCreatorFields": {
"type": "boolean"
},
"comment": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"displayName",
"singularName",
"pluralName",
"description",
"draftAndPublish",
"kind",
"attributes",
"visible",
"restrictRelationsTo"
],
"additionalProperties": false
}
},
"required": [
"uid",
"apiID",
"schema"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/content-types/{uid}": {
"get": {
"operationId": "content-type-builder/get/content_types_by_uid",
"parameters": [
{
"name": "uid",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"plugin": {
"type": "string"
},
"apiID": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"singularName": {
"type": "string"
},
"pluralName": {
"type": "string"
},
"description": {
"type": "string"
},
"draftAndPublish": {
"type": "boolean"
},
"kind": {
"type": "string",
"enum": [
"collectionType",
"singleType"
]
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"visible": {
"type": "boolean"
},
"restrictRelationsTo": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"options": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"reviewWorkflows": {
"type": "boolean"
},
"populateCreatorFields": {
"type": "boolean"
},
"comment": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"displayName",
"singularName",
"pluralName",
"description",
"draftAndPublish",
"kind",
"attributes",
"visible",
"restrictRelationsTo"
],
"additionalProperties": false
}
},
"required": [
"uid",
"apiID",
"schema"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/components": {
"get": {
"operationId": "content-type-builder/get/components",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
},
"category": {
"type": "string"
},
"apiId": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"connection": {
"type": "string"
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"displayName",
"description",
"attributes"
],
"additionalProperties": false
}
},
"required": [
"uid",
"category",
"apiId",
"schema"
],
"additionalProperties": false
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/components/{uid}": {
"get": {
"operationId": "content-type-builder/get/components_by_uid",
"parameters": [
{
"name": "uid",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
},
"category": {
"type": "string"
},
"apiId": {
"type": "string"
},
"schema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"connection": {
"type": "string"
},
"collectionName": {
"type": "string"
},
"attributes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "media"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"multiple": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"allowedTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type",
"multiple"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "relation"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"relation": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^((strapi|admin)::[\\w-]+|(api|plugin)::[\\w-]+\\.[\\w-]+)$"
},
"targetAttribute": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoPopulate": {
"type": "boolean"
},
"mappedBy": {
"type": "string"
},
"inversedBy": {
"type": "string"
}
},
"required": [
"type",
"relation",
"target",
"targetAttribute"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "component"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"component": {
"type": "string"
},
"repeatable": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"component",
"repeatable"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "dynamiczone"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"components": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[\\w-]+\\.[\\w-]+$"
}
},
"required": {
"type": "boolean"
},
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"required": [
"type",
"components"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "uid"
},
"configurable": {
"type": "boolean",
"const": false
},
"private": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targetField": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"required": {
"type": "boolean"
},
"unique": {
"type": "boolean"
},
"default": {},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"minLength": {
"type": "number"
},
"maxLength": {
"type": "number"
},
"enum": {
"type": "array",
"items": {
"type": "string"
}
},
"regex": {
"type": "string"
},
"private": {
"type": "boolean"
},
"configurable": {
"type": "boolean"
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"pluginOptions": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"displayName",
"description",
"attributes"
],
"additionalProperties": false
}
},
"required": [
"uid",
"category",
"apiId",
"schema"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"content-type-builder"
]
}
},
"/": {
"post": {
"operationId": "upload/post",
"parameters": [
{
"name": "id",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
]
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
}
},
"/files": {
"get": {
"operationId": "upload/get/files",
"parameters": [
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Select specific fields to return in the response",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Specify which relations to populate in the response",
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Sort the results by specified fields",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "pagination",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Pagination parameters",
"allOf": [
{
"type": "object",
"properties": {
"withCount": {
"description": "Include total count in response",
"type": "boolean"
}
},
"additionalProperties": false
},
{
"anyOf": [
{
"description": "Page-based pagination",
"type": "object",
"properties": {
"page": {
"description": "Page number (1-based)",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"pageSize": {
"description": "Number of entries per page",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"page",
"pageSize"
],
"additionalProperties": false
},
{
"description": "Offset-based pagination",
"type": "object",
"properties": {
"start": {
"description": "Number of entries to skip",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Maximum number of entries to return",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"limit"
],
"additionalProperties": false
}
]
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "filters",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Apply filters to the query",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
}
},
"/files/{id}": {
"get": {
"operationId": "upload/get/files_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
{
"name": "fields",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Select specific fields to return in the response",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"x-strapi-serialize": "querystring"
},
{
"name": "populate",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Specify which relations to populate in the response",
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
]
},
"x-strapi-serialize": "querystring"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
},
"delete": {
"operationId": "upload/delete/files_by_id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"alternativeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"width": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"height": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"formats": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"hash": {
"type": "string"
},
"ext": {
"type": "string"
},
"mime": {
"type": "string"
},
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"previewUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folder": {
"type": "number"
},
"folderPath": {
"type": "string"
},
"provider": {
"type": "string"
},
"provider_metadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"createdBy": {
"type": "number"
},
"updatedBy": {
"type": "number"
}
},
"required": [
"id",
"documentId",
"name",
"hash",
"mime",
"size",
"url",
"folderPath",
"provider",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"upload"
]
}
},
"/locales": {
"get": {
"operationId": "i18n/get/locales",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"documentId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"name": {
"type": "string"
},
"code": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"publishedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"id",
"documentId",
"name",
"code",
"createdAt",
"updatedAt",
"publishedAt",
"isDefault"
],
"additionalProperties": false
}
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"i18n"
]
}
},
"/connect/(.*)": {
"get": {
"operationId": "users-permissions/get/connect_____",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/local": {
"post": {
"operationId": "users-permissions/post/auth_local",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/local/register": {
"post": {
"operationId": "users-permissions/post/auth_local_register",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/{provider}/callback": {
"get": {
"operationId": "users-permissions/get/auth_by_provider_callback",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/forgot-password": {
"post": {
"operationId": "users-permissions/post/auth_forgot_password",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/reset-password": {
"post": {
"operationId": "users-permissions/post/auth_reset_password",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/email-confirmation": {
"get": {
"operationId": "users-permissions/get/auth_email_confirmation",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/send-email-confirmation": {
"post": {
"operationId": "users-permissions/post/auth_send_email_confirmation",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/auth/change-password": {
"post": {
"operationId": "users-permissions/post/auth_change_password",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users/count": {
"get": {
"operationId": "users-permissions/get/users_count",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users": {
"get": {
"operationId": "users-permissions/get/users",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"post": {
"operationId": "users-permissions/post/users",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users/me": {
"get": {
"operationId": "users-permissions/get/users_me",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/users/{id}": {
"get": {
"operationId": "users-permissions/get/users_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"put": {
"operationId": "users-permissions/put/users_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"delete": {
"operationId": "users-permissions/delete/users_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/roles/{id}": {
"get": {
"operationId": "users-permissions/get/roles_by_id",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/roles": {
"get": {
"operationId": "users-permissions/get/roles",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"post": {
"operationId": "users-permissions/post/roles",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/roles/{role}": {
"put": {
"operationId": "users-permissions/put/roles_by_role",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
},
"delete": {
"operationId": "users-permissions/delete/roles_by_role",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
},
"/permissions": {
"get": {
"operationId": "users-permissions/get/permissions",
"parameters": [],
"responses": {
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
}
},
"tags": [
"users-permissions"
]
}
}
},
"components": {
"schemas": {
"PluginUsersPermissionsPermissionDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"action": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.473Z",
"type": "string"
},
"role": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsRoleDocument"
}
},
"required": [
"documentId",
"id",
"action",
"publishedAt"
],
"additionalProperties": false,
"id": "PluginUsersPermissionsPermissionDocument"
},
"PluginUsersPermissionsRoleDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"name": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A string field",
"type": "string"
},
"type": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.472Z",
"type": "string"
},
"permissions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsPermissionDocument"
}
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
}
},
"required": [
"documentId",
"id",
"name",
"publishedAt"
],
"additionalProperties": false,
"id": "PluginUsersPermissionsRoleDocument"
},
"ApiCampaignCampaignDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"code": {
"description": "A string field",
"type": "string"
},
"freeShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"discountPercent": {
"description": "A decimal field",
"type": "number",
"minimum": 0,
"maximum": 100
},
"discountFixed": {
"description": "A decimal field",
"type": "number"
},
"usersLimit": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"timeLimit": {
"description": "A datetime field",
"type": "string"
},
"perUserLimit": {
"description": "A biginteger field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.475Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
}
},
"required": [
"documentId",
"id",
"code",
"freeShipping",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiCampaignCampaignDocument"
},
"ApiCampaignUsageCampaignUsageDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.474Z",
"type": "string"
},
"campaign": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiCampaignCampaignDocument"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiCampaignUsageCampaignUsageDocument"
},
"ApiBookSizeBookSizeDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.479Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiBookSizeBookSizeDocument"
},
"ApiPaperFinishPaperFinishDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.480Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"description",
"printboxId",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiPaperFinishPaperFinishDocument"
},
"ApiBookSettingBookSettingDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.479Z",
"type": "string"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiBookSettingBookSettingDocument"
},
"ApiPricingPricingDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"base": {
"description": "A decimal field",
"type": "number"
},
"perPage": {
"description": "A decimal field",
"type": "number"
},
"discount": {
"description": "A decimal field",
"default": 0,
"type": "number",
"minimum": 0,
"maximum": 100
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.479Z",
"type": "string"
},
"products": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProductProductDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
}
},
"required": [
"documentId",
"id",
"base",
"perPage",
"discount",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiPricingPricingDocument"
},
"ApiProductProductDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"series": {
"description": "A string field",
"type": "string"
},
"rating": {
"description": "An integer field",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"mockReviewsCount": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"amountLeft": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.478Z",
"type": "string"
},
"pricing": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPricingPricingDocument"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"printboxId",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiProductProductDocument"
},
"ApiOrderedProjectOrderedProjectDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"quantity": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.481Z",
"type": "string"
},
"project": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"required": [
"documentId",
"id",
"quantity",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiOrderedProjectOrderedProjectDocument"
},
"ApiProjectProjectDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"default": "Custom travel book",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"priceDiscounted": {
"description": "A decimal field",
"type": "number"
},
"printboxProjectUuid": {
"description": "A string field",
"type": "string",
"minLength": 36,
"maxLength": 36
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.478Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"product": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiProductProductDocument"
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
},
"bookSize": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookSizeBookSizeDocument"
},
"paperFinish": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiPaperFinishPaperFinishDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"printboxProjectUuid",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiProjectProjectDocument"
},
"ApiBookTypeBookTypeDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"minPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPages": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printboxId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.477Z",
"type": "string"
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"bookSettings": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiBookSettingBookSettingDocument"
}
},
"shippingPrices": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"minPages",
"maxPages",
"printboxId",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiBookTypeBookTypeDocument"
},
"ApiShippingPriceShippingPriceDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"minPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxPage": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"bookNumber": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"price": {
"description": "A decimal field",
"type": "number"
},
"isFree": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.477Z",
"type": "string"
},
"regions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"bookType": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiBookTypeBookTypeDocument"
}
},
"required": [
"documentId",
"id",
"minPage",
"maxPage",
"bookNumber",
"price",
"isFree",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiShippingPriceShippingPriceDocument"
},
"ApiRegionRegionDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"code": {
"description": "A string field",
"type": "string",
"minLength": 2,
"maxLength": 2
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.476Z",
"type": "string"
},
"subRegions": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRegionRegionDocument"
}
},
"parentRegion": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingPrice": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiShippingPriceShippingPriceDocument"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiAddressAddressDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiRegionRegionDocument"
},
"ApiAddressAddressDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"isDefaultShipping": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"isDefaultBilling": {
"description": "A boolean field",
"type": "boolean"
},
"firstName": {
"description": "A string field",
"type": "string"
},
"lastName": {
"description": "A string field",
"type": "string"
},
"addressLine1": {
"description": "A string field",
"type": "string"
},
"addressLine2": {
"description": "A string field",
"type": "string"
},
"zipCode": {
"description": "A string field",
"type": "string"
},
"city": {
"description": "A string field",
"type": "string"
},
"phoneNumber": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.476Z",
"type": "string"
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"state": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"country": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRegionRegionDocument"
},
"shippingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"billingOrders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
}
},
"required": [
"documentId",
"id",
"isDefaultShipping",
"firstName",
"lastName",
"addressLine1",
"zipCode",
"city",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiAddressAddressDocument"
},
"ApiRefundRefundDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"refundAmount": {
"description": "A decimal field",
"type": "number"
},
"description": {
"description": "A string field",
"type": "string"
},
"refundedAt": {
"description": "A datetime field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.483Z",
"type": "string"
},
"order": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"required": [
"documentId",
"id",
"refundAmount",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiRefundRefundDocument"
},
"ApiOrderOrderDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"orderStatus": {
"description": "An enum field",
"default": "Scheduled",
"type": "string",
"enum": [
"Scheduled",
"Open",
"Cancelled",
"In Progress"
]
},
"paymentStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Paid",
"Failed",
"Refunded (partially)",
"Refunded"
]
},
"deliveryStatus": {
"description": "An enum field",
"default": "Open",
"type": "string",
"enum": [
"Open",
"Shipped",
"Cancelled"
]
},
"currency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"orderPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"orderPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"shippingPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPrice": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"totalPriceDiscounted": {
"description": "A decimal field",
"default": 0,
"type": "number"
},
"paidAt": {
"description": "A datetime field",
"type": "string"
},
"peechoOrderId": {
"description": "An integer field",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"paymentIntentId": {
"description": "A string field",
"type": "string"
},
"printboxOrderId": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.474Z",
"type": "string"
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
},
"creator": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
},
"shippingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"billingAddress": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiAddressAddressDocument"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
},
"refund": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiRefundRefundDocument"
}
},
"required": [
"documentId",
"id",
"orderStatus",
"paymentStatus",
"deliveryStatus",
"currency",
"orderPrice",
"orderPriceDiscounted",
"shippingPrice",
"shippingPriceDiscounted",
"totalPrice",
"totalPriceDiscounted",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiOrderOrderDocument"
},
"ApiUserTagUserTagDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.483Z",
"type": "string"
},
"users": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
}
},
"required": [
"documentId",
"id",
"title",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiUserTagUserTagDocument"
},
"ApiOrderAdditiveOrderAdditiveDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"title": {
"description": "A string field",
"type": "string"
},
"description": {
"description": "A text field",
"type": "string"
},
"price": {
"description": "A decimal field",
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.484Z",
"type": "string"
}
},
"required": [
"documentId",
"id",
"title",
"description",
"price",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiOrderAdditiveOrderAdditiveDocument"
},
"ApiCartCartDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.484Z",
"type": "string"
},
"orderedProjects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderedProjectOrderedProjectDocument"
}
},
"orderAdditives": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderAdditiveOrderAdditiveDocument"
}
},
"user": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsUserDocument"
}
},
"required": [
"documentId",
"id",
"publishedAt"
],
"additionalProperties": false,
"id": "ApiCartCartDocument"
},
"PluginUsersPermissionsUserDocument": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"description": "The document ID, represented by a UUID",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
},
"id": {
"type": "number"
},
"username": {
"description": "A string field",
"type": "string"
},
"email": {
"description": "An email field",
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"provider": {
"description": "A string field",
"type": "string"
},
"confirmed": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"blocked": {
"description": "A boolean field",
"default": false,
"type": "boolean"
},
"sub": {
"description": "A string field",
"type": "string"
},
"currency": {
"description": "A string field",
"default": "USD",
"type": "string"
},
"timezone": {
"description": "A string field",
"default": "UTC",
"type": "string"
},
"externalIdentifiers": {
"description": "A JSON field"
},
"createdAt": {
"description": "A datetime field",
"type": "string"
},
"updatedAt": {
"description": "A datetime field",
"type": "string"
},
"publishedAt": {
"description": "A datetime field",
"default": "2025-09-17T16:47:37.471Z",
"type": "string"
},
"role": {
"description": "A relational field",
"$ref": "#/components/schemas/PluginUsersPermissionsRoleDocument"
},
"orders": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiOrderOrderDocument"
}
},
"campaignUsages": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCampaignUsageCampaignUsageDocument"
}
},
"userTags": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiUserTagUserTagDocument"
}
},
"addresses": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiAddressAddressDocument"
}
},
"projects": {
"description": "A relational field",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProjectProjectDocument"
}
},
"cart": {
"description": "A relational field",
"$ref": "#/components/schemas/ApiCartCartDocument"
}
},
"required": [
"documentId",
"id",
"username",
"email",
"confirmed",
"blocked",
"sub",
"currency",
"timezone",
"publishedAt"
],
"additionalProperties": false,
"id": "PluginUsersPermissionsUserDocument"
}
}
}
}