custom-fields

Update Order Item Custom Field Dropdown Choices

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this custom field.

query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
name
required
string [ 1 .. 200 ] characters
default_value
string <= 5000 characters
is_required
boolean
field_type
required
string non-empty
field_choices
Array of strings
Default: []
Responses
200
Response Schema:
object
Default: {}
required
object (CustomFieldRead)
put/api/v3/custom-fields/{id}/
Request samples
{
  • "name": "string",
  • "default_value": "string",
  • "is_required": true,
  • "field_type": "string",
  • "field_choices": [ ]
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Get Active/Inactive Order Item Custom Fields

Get list of custom fields associated with order items

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
field_type
string
  • t - Text
  • a - Large Text Field
  • i - Integer
  • f - Floating point decimal
  • b - Boolean (Yes/No)
  • m - Dropdown Choices
  • d - Date
  • h - Date Time
Enum: "a" "b" "d" "f" "h" "i" "m" "t"
format
string
Enum: "csv" "json"
meta__is_active
boolean
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
Response Schema:
object
Array of objects (CustomFieldRead)
get/api/v3/custom-fields/order-items/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}
➔ Next to receipt