logo

Categories

Creates a new category.

Category Name must be unique in the merchant account.

SecurityBearer or Bearer or Bearer or Bearer
Request
header Parameters
x-api-version
string
Request Body schema: application/json

The category creation request.

name
string or null

Sets the name of the category.

defaultUnitTypeId
integer or null <int32>

Sets the default unit type identifier for the category.

Responses
200

Success

400

Bad Request

404

Not Found

500

Server Error

post/pay-int-api/categories
Request samples
application/json
{
  • "name": "string",
  • "defaultUnitTypeId": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Retrieves a paginated list of categories.

SecurityBearer or Bearer or Bearer or Bearer
Request
query Parameters
page
integer <int32>

Gets or sets the page number for pagination.

pageSize
integer <int32>

Gets or sets the size of each page for pagination.

asc
boolean

Gets or sets the sorting order.

orderBy
string

Gets or sets the property name to sort by.

search
string

Gets or sets the search query to filter categories.

header Parameters
x-api-version
string
Responses
200

Success

500

Server Error

get/pay-int-api/categories
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "total": 0
}
Deletes a category by its ID.
This category will not be available in the catalog.
Items linked to this category will still be in the catalog with empty category.


SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
categoryId
required
string <uuid> 
The ID of the category to delete.


 
header Parameters
x-api-version
string
 
Responses 
204
No Content


500
Server Error


delete/pay-int-api/categories/{categoryId}
Request samples 
Response samples 
application/json
{
  • "details": null,
  • "statusCode": 500,
  • "source": "<Service>",
  • "exceptionType": "Exceptions.IntegrationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
Updates a category by its ID.
Category Name must be unique in the merchant account.


SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
categoryId
required
string <uuid> 
The ID of the category to update.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The category update request.


name
string or null
Gets or sets the new name of the category.


 
defaultUnitTypeId
integer or null <int32> 
Gets or sets the default unit type identifier for the category, if it needs to be updated.


 
Responses 
200
Success


400
Bad Request


404
Not Found


500
Server Error


put/pay-int-api/categories/{categoryId}
Request samples 
application/json
{
  • "name": "string",
  • "defaultUnitTypeId": 0
}
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
➔ Next to Invoices