ProductWarranty
ProductWarranty
List product warranty terms.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Query parameters
pageNumberintegerOptional
Reference to a specific page in a result set.
pageSizeintegerOptional
The number of items per page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Responses
200
Example response
application/json
get
/tenants/{tenantUid}/product-warrantiesGET /v2/tenants/{tenantUid}/product-warranties HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"items": [
{
"productWarrantyUid": "text",
"name": "text",
"terms": "text",
"createdBy": "text",
"createdAt": "2025-10-28T15:52:31.182Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-10-28T15:52:31.182Z"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create new product warranty terms.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Body
productWarrantyUidstringOptionalPattern:
^[A-Za-z0-9-_]*namestringOptional
termsstringRequired
Responses
201
Example response
application/json
post
/tenants/{tenantUid}/product-warrantiesPOST /v2/tenants/{tenantUid}/product-warranties HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"productWarrantyUid": "text",
"name": "text",
"terms": "text"
}201
Example response
{
"productWarrantyUid": "text",
"name": "text",
"terms": "text",
"createdBy": "text",
"createdAt": "2025-10-28T15:52:31.182Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-10-28T15:52:31.182Z"
}Get a product warranty terms details.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+productWarrantyUidstringRequired
Reference to product warranty terms
Responses
200
Example response
application/json
get
/tenants/{tenantUid}/product-warranties/{productWarrantyUid}GET /v2/tenants/{tenantUid}/product-warranties/{productWarrantyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Example response
{
"productWarrantyUid": "text",
"name": "text",
"terms": "text",
"createdBy": "text",
"createdAt": "2025-10-28T15:52:31.182Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-10-28T15:52:31.182Z"
}Update a product warranty terms.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+productWarrantyUidstringRequired
Reference to product warranty terms
Body
namestringOptional
termsstringOptional
Responses
200
Example response
application/json
put
/tenants/{tenantUid}/product-warranties/{productWarrantyUid}PUT /v2/tenants/{tenantUid}/product-warranties/{productWarrantyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"name": "text",
"terms": "text"
}200
Example response
{
"productWarrantyUid": "text",
"name": "text",
"terms": "text",
"createdBy": "text",
"createdAt": "2025-10-28T15:52:31.182Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-10-28T15:52:31.182Z"
}Delete a product warranty terms.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+productWarrantyUidstringRequired
Reference to product warranty terms
Responses
204
No Content
No content
delete
/tenants/{tenantUid}/product-warranties/{productWarrantyUid}DELETE /v2/tenants/{tenantUid}/product-warranties/{productWarrantyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
Was this helpful?