HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Define a new custom field

post
https://{domain_prefix}.retail.lightspeed.app/api/2.0/workflows/custom_fields

Create a new custom field definition for a given entity type.

🔒 Requires: custom_fields:write scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The parameters that can be passed to the create custom field definition API.

string
enum
required

The type of entity.

Allowed:
string
required
string
required
string
enum
required

The type of the value to be stored using this custom field.

Allowed:
boolean
Defaults to false

Should this custom field be visible in the UI.

boolean
Defaults to false

Should this custom field be editable in the UI.

boolean
Defaults to false

Should this custom field be printed on receipts.

Response

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?