Get Stock Periods

Returns a list of stock periods in an outlet.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Requires the stock period view permission.

For a full explanation of stock periods, see Managing Stock Periods.

status is the stable enum value (OPEN, CLOSED or REOPENED), not a translated label.

Path Params
string
required

The ID of the outlet.

Query Params
integer

Page number.

integer

Results per page. Maximum 200.

string
enum

Only return periods in this state.

Allowed:

Case-insensitive match on the period's name.

Responses

400

Unknown status value.

403

The library does not have the stock periods module enabled, or the user lacks the required permission.

404

Outlet not found.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json