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.

Body

application/json
reservation_hold_hours
integer | null
required

How many hours a draft order holds its stock, 1 to 8760; null holds it until the order is cancelled.

Required range: 1 <= x <= 8760
reserve_on
enum<string>

When an order holds its stock: confirm, payment (once a sales channel says it is paid; an order from no channel then waits for someone to reserve it) or manual. Left out, it stays as it is.

Available options:
confirm,
payment,
manual
short_stock
enum<string>

What a line does when stock runs short: refuse, backorder or partial. Left out, it stays as it is.

Available options:
refuse,
backorder,
partial
over_allocation_percent
string

How far past what is left to promise a line may hold, in percent, up to 100. Left out, it stays as it is.

Maximum string length: 100
Pattern: ^\d{1,3}(\.\d{1,4})?$
invoice_timing
enum<string>

What an invoice bills: after_shipping (what has shipped) or before_shipping (what was ordered). Left out, it stays as it is.

Available options:
after_shipping,
before_shipping
tax_rounding
enum<string>

Where an invoice's tax is rounded to the cent: per_line or per_invoice. Left out, it stays as it is.

Available options:
per_line,
per_invoice
return_status
enum<string>

The stock status returned goods come back into: quarantined, to inspect them first, or available. Left out, it stays as it is.

Available options:
quarantined,
available
quote_validity_days
integer

How many days a new quote stays valid, 1 to 365. Left out, it stays as it is.

Required range: 1 <= x <= 365

Response

SalesSettingsResource

data
SalesSettingsResource · object
required