Find product field by ID

GET

https://api.rechain.co/public/v1/product_fields/:id

GET

/public/v1/product_fields/:id

curl https://api.rechain.co/public/v1/product_fields/id \
     -H "Authorization: Bearer <token>"

{
  "name": "Sample Name",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2021-01-01T00:00:00Z",
  "fieldType": 3,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "listboxOptions": [
    "Option 1",
    "Option 2",
    "Option 3"
  ],
  "multipleSelection": true,
  "position": 1,
  "productCategoryFields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productFieldId": "123e4567-e89b-12d3-a456-426614174000",
      "productCategoryId": "123e4567-e89b-12d3-a456-426614174000",
      "categoryName": "Sample Name"
    }
  ],
  "productFieldGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Sample Name",
    "position": 1
  },
  "productFieldGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2021-01-01T00:00:00Z"
}

Returns a single product field

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

ID of product field to return

Response

This endpoint returns an object.

namestring

companyIdstringOptional

createdAtdatetimeOptional

fieldTypeintegerOptional

Field type, can be any of { short_text: 0, long_text: 1, checkbox: 2, listbox: 3, date: 4 }

idstringOptional

listboxOptionslist of stringsOptional

multipleSelectionbooleanOptional

positionintegerOptional

productCategoryFieldslist of objectsOptional

productFieldGroupobjectOptional

productFieldGroupIdstringOptional

updatedAtdatetimeOptional

Errors

400

Bad Request

404

Not Found