Articles in this section

Available OneStock APIs

When you configure an export, import, or other type of flow step using the prebuilt OneStock connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the OneStock API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Buffer management

Initialize async buffer import

X

Monitor async import by ID

X

Close async import

X

Send a batch of buffers to async import

X

Retrieve the list of buffers

X

Create or update buffer positions

X

Delivery promise

Get delivery estimate

X

Documents

Get document and metadata

X

History

Retrieve raw log data

X

Anonymise logs of orders

X

Locations, users, and sales channels

Initialize async import

X

Monitor async import

X

Close async import

X

Create a batch of stock locations

X

Create stock location

X

Retrieve stock location by ID

X

Modify the specific stock location

X

Create and assign stock location groups

X

Create groups

X

Delete group

X

Retrieve specific groups by ID

X

Modify group

X

Get sales channels

X

Create sales channel

X

Remove sales channel

X

Retrieve sales channel by ID

X

Modify sales channel

X

Initialize async import

X

Retrieve async import information

X

Close async import

X

Add users to async import

X

Create user

X

Delete user with options

X

Get user by ID

X

Modify user

X

Orchestration

Compute orchestration candidates

X

Order management

Get line item groups

X

Update line item groups

X

Get line item group details

X

Create order in OneStock

X

Anonymise order fields

X

Retrieve order by ID

X

Update order in OneStock

X

Get comments by order ID

X

Update order item

X

Create parcel for order

X

Add line item group to parcel

X

Get parcel details by ID

X

Update parcel

X

Partial order preparation

Create a piece group for stock unavailability

X

Payment management

Get transactions by order ID

X

Payments

Retrieve transactions by OneStock order in-store

X

Product information

Get categories and subcategories

X

Create or replace all categories

X

Get category by ID

X

Modify category structure

X

Create asynchronous item import

X

Monitor async import

X

Close async import

X

Create a batch of items for import

X

Get items and their information

X

Edit or import items

X

Return manager

Create return parcel

X

Update return parcel

X

Modify returned line item

X

Stock coverage

Reset stock coverages by date

X

Create asynchronous import

X

Retrieve import by ID

X

Close import when finished sending batches

X

Create stock coverages

X

Retrieve stock coverages

X

Create stock coverages

X

Stock dispositions

Initialize async import

X

Monitor async import

X

Close async import

X

Create batch stock disposition import

X

Delete dispositions by attributes or site ID

X

Retrieve the stock disposition list

X

Create disposition

X

Stock exports

Get real-time stock export

X

Export stock data to external systems

X

Stock history

Get stock history movements

X

Stock import

Create or update stock positions

X

Initialize async stock import

X

Monitor async stock import

X

Close async import

X

Create a batch stock import

X

Post-stock transfer notification

X

Time machine

Retrieve scheduled events

X

Create scheduled event

X

Delete scheduled events by ID

X

Retrieve scheduled event details

X

Update scheduled event details

X

Webhook notifications

Get webhook topics

X

Create a custom webhook topic

X

Remove webhook topic

X

Retrieve webhook topic by ID

X

Get webhooks

X

Create webhook

X

Delete webhook by ID

X

Retrieve webhook by ID

X

Update webhook with data

X

Update webhook hash key

X

Trigger webhook status update by ID

X