Get Channel

gethttps://api.flxpoint.com/channel/{id}

Use this when you want to pull channel 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.

Retrieves back a Channel by its ID.

This endpoint requires an Account or Channel token for authentication.

Request

Example request

get/channel/{id}

curl -X GET "https://api.flxpoint.com/channel/{id}" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

idinteger

Channel ID

namestring

Channel Name

descriptionstring

Channel Description

insertedAtstring (date-time)

updatedAtstring (date-time)

channelTypestring

A string handle indicating the type of the Channel. Options are Sales Channel ("Custom") or Reseller (formerly known as "Dealer").

allowedflxpoint.api.customflxpoint.api.dealers

accountIdinteger

primaryboolean

channelInvoiceReceiptOptionIdinteger

invoiceReceiptAccountCustomAlertIdinteger

paymentCollectionboolean

default true

channelInvoiceDefaultStatusPaymentStatus

allowedNot AuthorizedAuthorizedPaidDeferredRefundedCreditedAwaiting ClearanceDeclinedRefund PendingRefund Failed

channelInvoiceCcstring

pricingWorkflowEventIdinteger

The ID of the Listing Price & Quantity Workflow for the Channel.

archivedAtstring (date-time)

autoGeneratePoOnImportboolean

A setting that enables auto-generation of PO/FRs upon Order Import from the Channel.

default false

listingStatusWorkflowEventIdinteger

The ID of the Listing Status Workflow for the Channel.

allowBackorderboolean

allowDealersboolean

listingBuilderMappingTemplateIdinteger

inStoreOrderboolean

integrationsarray[any]

listPriceProtectionboolean

Indicates whether price protection is applied to the listing. When true, the listing will not be eligible to sync to channels because either the price is below or equal to cost, the cost is missing, or the listing has no linked inventories.

Example response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "insertedAt": "2026-04-20T00:00:00Z",
  "updatedAt": "2026-04-20T00:00:00Z",
  "channelType": "flxpoint.api.custom",
  "accountId": 0,
  "primary": true,
  "channelInvoiceReceiptOptionId": 0,
  "invoiceReceiptAccountCustomAlertId": 0,
  "paymentCollection": true,
  "channelInvoiceDefaultStatus": "Not Authorized",
  "channelInvoiceCc": "string",
  "pricingWorkflowEventId": 0,
  "archivedAt": "2026-04-20T00:00:00Z",
  "autoGeneratePoOnImport": true,
  "listingStatusWorkflowEventId": 0,
  "allowBackorder": true,
  "allowDealers": true,
  "listingBuilderMappingTemplateId": 0,
  "inStoreOrder": true,
  "integrations": [
    null
  ],
  "listPriceProtection": true
}

401Unauthorized

No schema documented for this status.

403Forbidden

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "get": {
    "summary": "Get Channel",
    "description": "Retrieves back a Channel by its ID.\n\nThis endpoint requires an Account or Channel token for authentication.",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Channel"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      },
      "403": {
        "description": "Forbidden"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

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