Skip to main content
PUT
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

Body

application/json

How one sales channel connection shares stock and takes orders.

location_feeds
object
required

By channel location id, the StockShift location ids whose stock it shows. One StockShift location may feed several.

safety_buffer
integer
required

Units held back from every listing.

Required range: 0 <= x <= 1000000
rounding
enum<string>
required

floor or nearest.

Available options:
floor,
nearest
customer_strategy
enum<string>
required

store_customer or match_company.

Available options:
store_customer,
match_company
order_location_id
string<uuid> | null

The StockShift location channel orders ship from; orders wait until it is set.

reserve_on
enum<string> | null

confirm, payment or manual; null follows the organization's Sales setting.

Available options:
confirm,
payment,
manual
release_unpaid_after_hours
integer | null

Hours an unpaid order holds its stock; null holds it until paid or cancelled.

Required range: 1 <= x <= 8760
max_quantity
integer | null

The most any listing shows; null shows all there is.

Required range: 0 <= x <= 1000000
push_prices
boolean

Whether matched listings take their price from the price list.

price_list_id
string<uuid> | null

The price list prices come from; required to push prices.

import_since
string<date> | null

Orders placed before this day are not imported.

Response

SalesChannelSettingsResource

data
SalesChannelSettingsResource · object
required