Asset

Was this helpful?

Get asset details

get

Get asset details. The asset itself must be loaded from the host.

Private assets are signed URLs with expiry time. They are not included in the regular asset response but you can get them from the endpoint Get asset private URL.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

assetUidstringrequired

Reference to an asset

Responses

application/json

all ofoptional

get

GET /v2/tenants/{tenantUid}/assets/{assetUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "assetUid": "text",
  "name": "text",
  "description": "text",
  "category": "BRANDING",
  "isPublic": true,
  "publicUrl": "text",
  "mimeType": "text",
  "size": "text",
  "serviceOrderUids": [
    "text"
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T00:53:55.465Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T00:53:55.465Z"
}

Delete asset

delete

Delete an asset. This also removes the asset from the host.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

assetUidstringrequired

Reference to an asset

Responses

delete

DELETE /v2/tenants/{tenantUid}/assets/{assetUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

Download asset file

get

Private asset URLs have signature and expiry parameters so they cannot be accessed randomly.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

assetUidstringrequired

Reference to an asset

Responses

get

GET /v2/tenants/{tenantUid}/assets/{assetUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

303

See Other

No Content

List assets

get

List assets.

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:

categoriesstring · enum[]optional

Filter on categories

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/assets HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "assetUid": "text",
      "name": "text",
      "description": "text",
      "category": "BRANDING",
      "isPublic": true,
      "publicUrl": "text",
      "mimeType": "text",
      "size": "text",
      "serviceOrderUids": [
        "text"
      ]
    },
    {
      "createdBy": "text",
      "createdAt": "2025-04-18T00:53:55.465Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T00:53:55.465Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create asset

post

This endpoint lets you create the asset record. To upload a file, use the Upload asset file endpoint where the assetUid you get here is part of the path.

If you want to point to an asset that you already host, just add the correct URL of the asset and you are good to go.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

namestringrequired

categorystring · enumrequiredAvailable options:

descriptionstringoptional

isPublicbooleanoptionalDefault: false

urlstringoptional

for self-hosted asset

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

serviceOrderUidsstring[]optional

Responses

application/json

all ofoptional

post

POST /v2/tenants/{tenantUid}/assets HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "name": "text",
  "category": "BRANDING",
  "description": "text",
  "isPublic": true,
  "url": "text",
  "assetUid": "text",
  "serviceOrderUids": [
    "text"
  ]
}

201

Example response

{
  "assetUid": "text",
  "name": "text",
  "description": "text",
  "category": "BRANDING",
  "isPublic": true,
  "publicUrl": "text",
  "mimeType": "text",
  "size": "text",
  "serviceOrderUids": [
    "text"
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T00:53:55.465Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T00:53:55.465Z"
}

Upload asset file

post

Upload file for the asset which "container" record was created on the Add asset endpoint.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

assetUidstringrequired

Reference to an asset

Body

string · binaryoptional

Responses

application/json

all ofoptional

post

POST /v2/tenants/{tenantUid}/assets/{assetUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"

201

Example response

{
  "assetUid": "text",
  "name": "text",
  "description": "text",
  "category": "BRANDING",
  "isPublic": true,
  "publicUrl": "text",
  "mimeType": "text",
  "size": "text",
  "serviceOrderUids": [
    "text"
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T00:53:55.465Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T00:53:55.465Z"
}

Update asset details

put

Update asset details.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

assetUidstringrequired

Reference to an asset

Body

namestringoptional

categorystring · enumoptionalAvailable options:

descriptionstringoptional

isPublicbooleanoptional

urlstringoptional

for self-hosted asset

serviceOrderUidsstring[]optional

Responses

application/json

all ofoptional

put

PUT /v2/tenants/{tenantUid}/assets/{assetUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "name": "text",
  "category": "BRANDING",
  "description": "text",
  "isPublic": true,
  "url": "text",
  "serviceOrderUids": [
    "text"
  ]
}

200

Example response

{
  "assetUid": "text",
  "name": "text",
  "description": "text",
  "category": "BRANDING",
  "isPublic": true,
  "publicUrl": "text",
  "mimeType": "text",
  "size": "text",
  "serviceOrderUids": [
    "text"
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T00:53:55.465Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T00:53:55.465Z"
}