Productfields
With productfields a user can extend the data fields that a product can contain. New productfields can only be created in the app, but the contents of productfields can be updated via the API.
Attributes
Name | Type | Description |
---|---|---|
idproductfield | integer | Unique Picqer reference |
title | string | Title of productfield |
type | text | Type of field (eg. text or radio) |
values | array | Possible values in case of radio or select type |
required | boolean | Is this field required for each product |
visible_picklist | boolean | Field shown on picklist |
visible_invoice | boolean | Field shown on invoice |
visible_shippinglist | boolean | Field shown on shippinglist |
visible_portal | boolean | Field shown on portal |
visible_purchase_order | boolean | Field shown on purchase order |
Get all productfields
GET
https://example.picqer.com/api/v1/productfields
HTTP/1.1 200 OK
[
{
"idproductfield":1,
"title":"Season",
"type":"text",
"values":[],
"required":false,
"visible_picklist":true,
"visible_invoice":true,
"visible_shippinglist":true,
"visible_portal":true,
"visible_purchase_order":true
}
]
This endpoint uses pagination.
Get a single productfield
GET
https://example.picqer.com/api/v1/productfields/{idproductfield}
HTTP/1.1 200 OK
{
"idproductfield":1,
"title":"Season",
"type":"text",
"values":[],
"required":false,
"visible_picklist":true,
"visible_invoice":true,
"visible_shippinglist":true,
"visible_portal":true,
"visible_purchase_order":true
}
Read more Orderfields