ProductWarranty

PreviousProductProperties NextProperties

Was this helpful?

Get product warranty terms

get

Get a product warranty terms details.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productWarrantyUidstringrequired

Reference to product warranty terms

Responses

application/json

objectoptional

get

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-04-18T01:57:13.138Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:57:13.138Z"
}

Delete product warranty terms

delete

Delete a product warranty terms.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productWarrantyUidstringrequired

Reference to product warranty terms

Responses

delete

DELETE /v2/tenants/{tenantUid}/product-warranties/{productWarrantyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List product warranty terms

get

List product warranty terms.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Responses

application/json

objectoptional

get

GET /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-04-18T01:57:13.138Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:57:13.138Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create product warranty terms

post

Create new product warranty terms.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

productWarrantyUidstringoptionalPattern: ^[A-Za-z0-9-_]*

namestringoptional

termsstringrequired

Responses

application/json

objectoptional

post

POST /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-04-18T01:57:13.138Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:57:13.138Z"
}

Update product warranty terms

put

Update a product warranty terms.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productWarrantyUidstringrequired

Reference to product warranty terms

Body

namestringoptional

termsstringoptional

Responses

application/json

objectoptional

put

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-04-18T01:57:13.138Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:57:13.138Z"
}