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