AlmondTill/G3N API

On this page

agentChannelCheckout

query · in the family Reading your records

What it does

Read one agent checkout as the platform sees it — the lines, the quote, the delivery options, the status and its messages.

THE AGENT CHECKOUT — read: one agent checkout's quote view at NOW. The agent_platform principal reads its OWN channel's checkouts opened by ITS platform (any other → the uniform NOT_FOUND); staff (read) read any checkout of their group's channels. A checkout of another channel, another platform, or an Order that is not an agent checkout is the SAME uniform NOT_FOUND.

What happens

Reads only.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
agentChannelIdID ID!yesNo further notes.
orderIdID ID!yesNo further notes.
linkedConsumerIdIDnoNo further notes.

Returns

AgentCheckout AgentCheckout! — THE AGENT CHECKOUT VIEW: the draft Order as a UCP checkout session at NOW — status ∈ incomplete | requires_escalation | ready_for_complete | complete_in_progress | completed | canceled (the status rule) over its lines, buyer, consent, fulfillment offer, totals, discounts and messages.

Example request

query ExampleAgentChannelCheckout($agentChannelId: ID!, $orderId: ID!, $linkedConsumerId: ID) {
  agentChannelCheckout(agentChannelId: $agentChannelId, orderId: $orderId, linkedConsumerId: $linkedConsumerId) {
    orderId
    revision
    revisionNum
    agentChannelId
    organizationId
    platformProfileUrl
    consumerId
    currency
    orderStatus
    status
    validUntil
  }
}

Variables:

{
  "agentChannelId": "01900000-0000-7000-8000-d23fae740000",
  "orderId": "01900000-0000-7000-8000-f6d8263a0000",
  "linkedConsumerId": "01900000-0000-7000-8000-2aa003e10000"
}

Example response

{
  "data": {
    "agentChannelCheckout": {
      "orderId": "01900000-0000-7000-8000-f6d8263a0000",
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "revisionNum": 1,
      "agentChannelId": "01900000-0000-7000-8000-d23fae740000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "platformProfileUrl": "https://example.com/hook",
      "consumerId": "01900000-0000-7000-8000-6e8c92ec0000",
      "currency": "USD",
      "orderStatus": "<order status>",
      "status": "<status>",
      "validUntil": "<valid until>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer