logo

LineItems

Creates a new line item.

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

The line item creation request.

productName
string or null
description
string or null
sku
string or null
unitPrice
number <double>
unitTypeId
integer <int32>
categoryId
string or null <uuid>
taxRate
number <double>
Responses
200

Success

400

Bad Request

500

Server Error

post/pay-int-api/line-items
Request samples
application/json
{
  • "productName": "string",
  • "description": "string",
  • "sku": "string",
  • "unitPrice": 0,
  • "unitTypeId": 0,
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "taxRate": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Retrieves a paginated list of line items.

SecurityBearer or Bearer or Bearer or Bearer
Request
query Parameters
page
integer <int32>
pageSize
integer <int32>
asc
boolean
orderBy
string
search
string
categoryId
string <uuid>
noCategory
boolean
header Parameters
x-api-version
string
Responses
200

Success

get/pay-int-api/line-items
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "total": 0
}
Updates a specific line item.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
lineItemId
required
string <uuid> 
The ID of the line item to update.


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


productName
string or null
 
description
string or null
 
sku
string or null
 
unitPrice
number <double> 
 
unitTypeId
integer <int32> 
 
categoryId
string or null <uuid> 
 
taxRate
number <double> 
 
Responses 
200
Success


400
Bad Request


404
Not Found


500
Server Error


put/pay-int-api/line-items/{lineItemId}
Request samples 
application/json
{
  • "productName": "string",
  • "description": "string",
  • "sku": "string",
  • "unitPrice": 0,
  • "unitTypeId": 0,
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "taxRate": 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
}
Deletes a specific line item.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
lineItemId
required
string <uuid> 
The ID of the line item to delete.


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


404
Not Found


500
Server Error


delete/pay-int-api/line-items/{lineItemId}
Request samples 
Response samples 
application/json
{
  • "details": "Not found Id 'b31fbe9f-eebb-45ce-9cae-92265389f47f' with type='<Service>.DataAccess.Entities.<Model>Entity'",
  • "statusCode": 404,
  • "source": "<Service>",
  • "exceptionType": "Exceptions.NotFoundException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
Retrieves the available unit types for line items.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
header Parameters
x-api-version
string
 
Responses 
200
Success


get/pay-int-api/line-items/unit-types
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to PaymentSessions