Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

connection
string
required

Query Parameters

stream
enum<string> | null

Only runs of this stream, such as orders_in. One kind of record a connection syncs, in one direction. A name ending in _in brings records into StockShift, and one ending in _out sends them out.

Available options:
products_in,
products_out,
stock_out,
orders_in,
fulfillments_out,
invoices_out,
credit_notes_out,
payments_out,
bills_out,
journals_out,
contacts_out,
tracking_in,
fulfillment_requests_out,
warehouse_shipments_in,
inbound_notices_out,
warehouse_receipts_in,
warehouse_stock_in,
edi_in,
edi_out,
migration_in,
customers_in,
customers_out,
deals_in,
sales_activity_out,
tax_documents_out,
part_prices_in
status
enum<string> | null

Only runs with this status, such as failed. Where a sync run stands. partial finished with some records failed; failed stopped before it could finish.

Available options:
queued,
running,
succeeded,
partial,
failed,
cancelled
after
string<uuid> | null

The next of the previous page.

Response

SyncRunPageResource

data
SyncRunPageResource · object
required