Skip to main content
POST
Preview what a consumer's sync would create

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string<uuid>
required
syncid
string<uuid>
required

Body

application/json
limit
integer
default:50

Objects each capability the consumer chose books at most. What they need (their suppliers) is previewed whatever its number.

Required range: 1 <= x <= 500
force_from_date
string<date> | null

First day the preview covers. Defaults to 14 days ago.

force_to_date
string<date> | null

Last day it covers. Defaults to today.

Response

Successful Response

preview_id
string<uuid>
required

Read the preview with it: the legacy routes know it as the preview execution.

status
enum<string>
required

Pending while it is queued or running, then ready or failed.

Available options:
pending,
ready,
failed