CHchift
Syncs

What a consumer's sync did to one object

Changed on

Its state, what happened to it (each step with its execution), the objects it needed and those that needed it, and the open issues holding it up. kind is the object's type, e.g. supplier_invoice.

get/consumers/{consumer_id}/syncs/{syncid}/objects/{kind}/{object_id}

Request

Path parameters

consumer_idstring uuid required
syncidstring uuid required
kindstring required
object_idstring uuid required

Query parameters

languagestring nullable

ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

Response

Successful Response

idstring uuid required

The object's id: read it with GET …/objects/{kind}/{id}.

kindstring required

The object's type, e.g. 'supplier_invoice'.

capabilitystring required

Key of the capability that handles it.

source_idstring required

Its id in the source.

scopeobject required

What identifies it beside its source id, for a sync keying its objects on something the consumer runs several of: {"location_id": "paris"}. Empty otherwise.

statusstring required

Where it stands, e.g. 'pending', 'success', 'failed', 'skipped', 'never_retry'.

target_idstring nullable required

What it was booked as in the target. Null until then.

booked_asstring nullable required

Key of the mode that booked it.

attemptsinteger required

How many times it failed.

last_error_codestring nullable required

The code of its last failure.

created_atstring date-time required

When the sync first saw it.

updated_atstring date-time required

When it last changed.

succeeded_atstring date-time nullable required

When it was booked.

targetobject nullable required

What it was booked as, as the target answered.

Example response

{
  "issues": [
    {
      "kind": "configuration",
      "code": "ERROR_SYNC_MISSING_MAPPING_VALUE"
    }
  ]
}

Changes