# NewAgentChannelInput

input type

Create-input for an AgentChannel. The tenant (org group) derives SERVER-SIDE from the principal; organizationId (the parent) is tenant-scoped server-side and must be ACTIVE; the referenced records gate record-aware IN THE KIT. Every control is optional — an omitted control takes its strict default (nothing listed · no shipping · no pickup · no platforms · stock hidden · codes off · consent all false · email required · normal rate · 6 h).

## Fields

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `caption` | [String](/types/#scalars) | no | Optional: when omitted the per-type default applies — the owning organization’s name + ' agent channel'; when supplied it must be non-blank. |
| `organizationId` | [ID](/types/#scalars) `ID!` | yes | The parent Organization (whose channel this is) — tenant-scoped + ACTIVE; exactly one channel per org. Immutable after birth. |
| `logicalFacilityId` | [ID](/types/#scalars) `ID!` | yes | The selling location — tenant-scoped + ACTIVE. |
| `pickupLogicalFacilityIds` | [ID](/types/#scalars) `[ID!]` | no | Pickup locations (0..16, distinct, each ACTIVE); omitted =. |
| `shipToCountries` | [String](/types/#scalars) `[String!]` | no | Ship-to countries (ISO alpha-2 uppercase; 0..64, distinct); omitted = (no shipping). |
| `collectionIds` | [ID](/types/#scalars) `[ID!]` | no | The listed collections (0..24, distinct, each ACTIVE); omitted = (nothing listed). |
| `divisionId` | [ID](/types/#scalars) | no | The optional CHANNEL-type division (ACTIVE + channel-kind — a different kind refuses). |
| `showStockLevels` | [Boolean](/types/#scalars) | no | Show stock figures to agents; omitted = false. |
| `excludedVariantIds` | [ID](/types/#scalars) `[ID!]` | no | Variants never listed (0..200, distinct, in-tenant); omitted =. |
| `priceListId` | [ID](/types/#scalars) | no | The optional agent price list (ACTIVE; selected for the owning organization; unscoped). |
| `allowDiscountCodes` | [Boolean](/types/#scalars) | no | Accept discount codes from agents; omitted = false. |
| `maxCheckoutTotalMinor` | [Int](/types/#scalars) | no | The optional single-checkout cap in minor units (≥ 1). |
| `fulfillmentMethods` | [AgentChannelFulfillmentMethod](/types/AgentChannelFulfillmentMethod/) `[AgentChannelFulfillmentMethod!]` | no | The offered methods (distinct); omitted = (publish then refuses until set). |
| `shippingOptions` | [AgentChannelShippingOptionInput](/types/AgentChannelShippingOptionInput/) `[AgentChannelShippingOptionInput!]` | no | The flat-rate shipping cards (0..16, ids unique); omitted =. |
| `handlingDays` | [Int](/types/#scalars) | no | Handling days (0..30); omitted = 0. |
| `requireBuyerEmail` | [Boolean](/types/#scalars) | no | Require the buyer’s email; omitted = true. |
| `requireBuyerPhone` | [Boolean](/types/#scalars) | no | Require the buyer’s phone; omitted = false. |
| `allowedPlatforms` | [AgentChannelPlatformInput](/types/AgentChannelPlatformInput/) `[AgentChannelPlatformInput!]` | no | The pre-approved platforms (0..16, profile URLs unique, https); omitted = (every platform refused). |
| `rateClass` | [AgentChannelRateClass](/types/AgentChannelRateClass/) | no | The request-rate class; omitted = normal. |
| `consentDefaults` | [AgentChannelConsentDefaultsInput](/types/AgentChannelConsentDefaultsInput/) | no | The buyer_consent defaults; omitted = all false. |
| `returnPolicy` | [String](/types/#scalars) | no | The return policy text (at most 2000 characters). |
| `warrantyPolicy` | [String](/types/#scalars) | no | The warranty policy text (at most 2000 characters). |
| `checkoutTtlMinutes` | [Int](/types/#scalars) | no | The checkout window (15..1440 minutes); omitted = 360. |
| `identityLinking` | [Boolean](/types/#scalars) | no | Advertise buyer account linking; omitted = false. |
| `requireLinkedBuyer` | [Boolean](/types/#scalars) | no | Require a signed-in (linked) buyer for every checkout and order operation; omitted = false. |

## Used by

- [createAgentChannel](/reference/agent-channel/createAgentChannel/)