Supplier tools

Who you are signed in as. Supplier, role and permissions.

Read only.

Resourceresources/read aikonic://supplier/supplier_me

Arguments

A resource takes no arguments: the agent reads it by its address.

Your users and their roles.

Read only.

Resourceresources/read aikonic://supplier/list_supplier_users

Arguments

A resource takes no arguments: the agent reads it by its address.

Your contract.

Read only.

Resourceresources/read aikonic://supplier/supplier_contract

Arguments

A resource takes no arguments: the agent reads it by its address.

Your compliance documents.

Read only.

Resourceresources/read aikonic://supplier/supplier_compliance_documents

Arguments

A resource takes no arguments: the agent reads it by its address.

Your notification preferences.

Read only.

Resourceresources/read aikonic://supplier/supplier_notification_prefs

Arguments

A resource takes no arguments: the agent reads it by its address.

Your sandbox details.

Read only.

Resourceresources/read aikonic://supplier/supplier_sandbox_info

Arguments

A resource takes no arguments: the agent reads it by its address.

Your certification status.

Read only.

Resourceresources/read aikonic://supplier/supplier_cert_status

Arguments

A resource takes no arguments: the agent reads it by its address.

The health of your integration.

Read only.

Resourceresources/read aikonic://supplier/supplier_integration_health

Arguments

A resource takes no arguments: the agent reads it by its address.

The health of your content feeds.

Read only.

Resourceresources/read aikonic://supplier/supplier_feeds

Arguments

A resource takes no arguments: the agent reads it by its address.

Times the platform paused traffic to your integration, and why.

Read only.

Resourceresources/read aikonic://supplier/supplier_breaker_events

Arguments

A resource takes no arguments: the agent reads it by its address.

The bookings routed to you, on-request first.

Read only.

Tool signaturelist_supplier_bookings(
  domain?: string,
  from?: string (date),
  page?: integer,
  pageSize?: integer,
  state?: string,
  to?: string (date)
)
// * required   ? optional

Arguments

• domainoptional
  string Only bookings of this product, by its product code (for example HTL).
• fromoptional
  string (date) Start of the date range (inclusive).
• pageoptional
  integer Page number, 1-based.
• pageSizeoptional
  integer Rows per page, 1..200 (console lists).
• stateoptional
  string Only bookings in this state.
• tooptional
  string (date) End of the date range (inclusive).

One booking routed to you.

Read only.

Resourceresources/read aikonic://supplier/get_supplier_booking/{bookingRef}

Arguments

• bookingRefrequired
  string The booking to read, as the supplier's booking list names it.

Your disputes.

Read only.

Resourceresources/read aikonic://supplier/supplier_disputes

Arguments

A resource takes no arguments: the agent reads it by its address.

Your booking volume.

Read only.

Tool signaturesupplier_analytics_volume(
  from?: string,
  to?: string
)
// * required   ? optional

Arguments

• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Your conversion funnel.

Read only.

Tool signaturesupplier_analytics_conversion(
  from?: string,
  to?: string
)
// * required   ? optional

Arguments

• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Your look-to-book ratio.

Read only.

Tool signaturesupplier_analytics_l2b(
  from?: string,
  to?: string
)
// * required   ? optional

Arguments

• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Your cancellations and declines.

Read only.

Tool signaturesupplier_analytics_cancellations(
  from?: string,
  to?: string
)
// * required   ? optional

Arguments

• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Your response times.

Read only.

Tool signaturesupplier_analytics_response_times(
  from?: string,
  to?: string
)
// * required   ? optional

Arguments

• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Failed calls to your integration, by kind.

Read only.

Tool signaturesupplier_analytics_errors(
  from?: string,
  to?: string
)
// * required   ? optional

Arguments

• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Your API traffic from the platform.

Read only.

Tool signaturesupplier_analytics_api_calls(
  from?: string,
  limit?: integer,
  operation?: string,
  outcome?: SupplierCallOutcome,
  to?: string
)
// * required   ? optional

Arguments

• fromoptional
  string Start of the window: an ISO date (UTC day) or instant.
• limitoptional
  integer At most this many rows, newest first (1..500, default 100).
• operationoptional
  string Narrow to one supplier operation, as journalled.
• outcomeoptional
  SupplierCallOutcome Narrow to one call outcome.
• tooptional
  string End of the window (exclusive): an ISO date (the whole UTC day) or instant.

Your service-level scorecard.

Read only.

Resourceresources/read aikonic://supplier/supplier_sla_scorecard

Arguments

A resource takes no arguments: the agent reads it by its address.

Your settlement statements.

Read only.

Resourceresources/read aikonic://supplier/supplier_settlements

Arguments

A resource takes no arguments: the agent reads it by its address.

Reconcile a statement against your own lines.

Read only.

Tool signaturesupplier_reconcile_statement(
  body*: SupplierReconcileRequest,
  idempotencyKey*: string (uuid),
  statementId*: string
)
// * required   ? optional

Arguments

• bodyrequired
  SupplierReconcileRequest The supplier's own lines to match against a statement.

  SupplierReconcileRequest: 1 field

  • linesrequired
    array of object Your own statement lines to match.

    4 fields

    • amountrequired
      integer The line's amount, in minor units of its currency.
    • currencyrequired
      string The line's currency, as an ISO 4217 code.
    • lineIdoptional
      string Your own id for the line, matched with the booking reference when sent.
    • supplierBookingRefrequired
      string The booking the line is for, by your booking reference.
• idempotencyKeyrequired
  string (uuid) Mandatory on mutations: **48h TTL**; replay with same body-hash returns the original response with Idempotency-Replayed true; same key + different body is 409 ….
• statementIdrequired
  string The settlement statement to reconcile against.