List Product Custom Fields

GET /api/v1/product-custom-fields/

Show all product custom fields the requesting manager has access permissions to.

Examples

Request example (JSON):

{
  "name": "Show all product custom fields the requesting manager has access permissions to.",
  "method": "GET",
  "url": "/api/v1/product-custom-fields/",
  "description": "",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "b0xj3F46234ncp6cj0d3f",
        "language": "json",
        "code": "",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "b0xj3F46234ncp6cj0d3f"
  },
  "results": {
    "languages": [
      {
        "id": "aTMf1--aFpAngFFPMIUgA",
        "language": "200",
        "code": "{\n    \"count\": 3,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 66,\n            \"product_custom_field_enums\": [],\n            \"name\": \"cf1\",\n            \"data_type\": null,\n            \"default_value\": \"1\",\n            \"description\": null,\n            \"product\": 1584723961091260\n        }\n        ...\n    ]\n}",
        "customLabel": ""
      },
      {
        "id": "3PthBJ1JJ9aRMWo8_HjeX",
        "language": "404",
        "code": "{\n  \"message\": \"Ain't no cake like that.\"\n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "aTMf1--aFpAngFFPMIUgA"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}

Successful response example (200):

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 66,
            "product_custom_field_enums": [],
            "name": "cf1",
            "data_type": null,
            "default_value": "1",
            "description": null,
            "product": 1584723961091260
        }
        ...
    ]
}

Error response example (404):

{
  "message": "Ain't no cake like that."
}

Query Parameters

(No specific path, header, or body parameters listed in the source.)

Pagination

Default pagination is 20 results per page.

• limit — Number of results to return per page. Example: limit=20

• offset — The initial index from which to return the results. Example: offset=21

Filtering

The results can be filtered by various attributes on product custom field or related to the product custom field.

Possible filters:

• product