Get Custom Aggregate Fields

gethttps://api.flxpoint.com/account/custom-aggregate-fields

Use this when you want to pull account data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Get all setup custom aggregate fields

Request

Example request

get/account/custom-aggregate-fields

curl -X GET "https://api.flxpoint.com/account/custom-aggregate-fields" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

array[CustomAggregateField]

idinteger

aggregateFieldDataTypeIdinteger

customAggregateFieldOptionIdinteger

namestring

handlestring

ignoreOutOfStockboolean

default false

accountIdinteger

Example response

[
  {
    "id": 0,
    "aggregateFieldDataTypeId": 0,
    "customAggregateFieldOptionId": 0,
    "name": "string",
    "handle": "string",
    "ignoreOutOfStock": true,
    "accountId": 0
  }
]

401Unauthorized

No schema documented for this status.

OpenAPI fragment

{
  "get": {
    "summary": "Get Custom Aggregate Fields",
    "description": "Get all setup custom aggregate fields",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/CustomAggregateField"
              }
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight