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

The organization's fiscal calendar: the month the fiscal year starts in and the time zone inventory periods are cut in.

fiscal_year_start
integer
required

The month the fiscal year starts in, from 1 for January to 12 for December.

Required range: 1 <= x <= 12
time_zone
string
required

The time zone the periods start and end in, as an IANA name such as America/Toronto.

Response

StockPeriodsResource

data
StockPeriodsResource · object
required

A fiscal year's inventory periods, with the fiscal calendar and the lock date.