AlmondTill/G3N API

On this page

agentChannelOrder

query · in the family Reading your records

What it does

Read a completed agent checkout’s order as the platform sees it — what was bought, how it ships, what has happened since.

THE AGENT ORDER — read: one agent-originated SALE as the platform reads it (the released Order's words). The agent_platform principal reads the orders ITS platform originated on ITS channel (any other → the uniform NOT_FOUND); staff read any of their group's agent sales — the merchant's own preview.

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

AgentOrder AgentOrder! — THE AGENT ORDER VIEW: the minted sale as the platform reads it — the released dev.ucp.shopping.order rendered by the door from these words; permalinkUrl = the order resource's own URL on the business host.

Example request

query ExampleAgentChannelOrder($agentChannelId: ID!, $orderId: ID!, $linkedConsumerId: ID) {
  agentChannelOrder(agentChannelId: $agentChannelId, orderId: $orderId, linkedConsumerId: $linkedConsumerId) {
    orderId
    sysId
    checkoutId
    agentChannelId
    organizationId
    platformProfileUrl
    consumerId
    currency
    orderStatus
    paymentState
    fulfillmentState
    placedAt
    permalinkUrl
    receiptToken
  }
}

Variables:

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

Example response

{
  "data": {
    "agentChannelOrder": {
      "orderId": "01900000-0000-7000-8000-f6d8263a0000",
      "sysId": "<sys id>",
      "checkoutId": "01900000-0000-7000-8000-679010dc0000",
      "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>",
      "paymentState": "<payment state>",
      "fulfillmentState": "<fulfillment state>",
      "placedAt": "2027-01-31T00:00:00.000Z",
      "permalinkUrl": "https://example.com/hook",
      "receiptToken": "<your session token>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer