appConnectorCursorAdvance

Requires at least one of the permissions customers:customer:read, inventory:stock_level:read, inventory:warehouse:read, payments:payment:read, products:product:read, purchase:grn:read, purchase:purchase_invoice:read, purchase:purchase_order:read, sales:credit_note:read, sales:quote:read, sales:sales_invoice:read, sales:sales_order:read, sales:shipment:read or suppliers:supplier:read.

Move the calling app's sync cursor for one resource and direction. The watermark only moves forward. Needs write_connector_sync.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation AppConnectorCursorAdvance($input: AppConnectorCursorInput!) {
  appConnectorCursorAdvance(input: $input) {
    cursor
    direction
    resource
    updatedAt
    watermark
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation AppConnectorCursorAdvance($input: AppConnectorCursorInput!) {\n  appConnectorCursorAdvance(input: $input) {\n    cursor\n    direction\n    resource\n    updatedAt\n    watermark\n  }\n}",
  "variables": {
    "input": {
      "direction": "INBOUND",
      "resource": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "direction": "INBOUND",
    "resource": "string"
  }
}

Response:

{
  "data": {
    "appConnectorCursorAdvance": {
      "cursor": "string",
      "direction": "INBOUND",
      "resource": "string",
      "updatedAt": "2025-01-15T00:00:00Z",
      "watermark": "2025-01-15T00:00:00Z"
    }
  }
}

appConnectorCursorAdvance(
  input: AppConnectorCursorInput!
): ConnectorCursorView!

Arguments

appConnectorCursorAdvance.input ● AppConnectorCursorInput! non-null input

The new position.

Type

ConnectorCursorView object

Where an installed app's sync of one resource, in one direction, stands.