This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

GET /forecast-scenarios

Get list of forecast scenarios

Description

Returns list of forecast scenarios

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by. memo, ref, created_at, updated_at
sortDirection optional Direction of sort. asc, desc
keyword[ct] optional Search for scenario by keyword. Allowed expression(s): ct  

Responses

200

successful operation

406

not acceptable

500

internal server error

POST /forecast-scenarios

Create new forecast scenario

Description

Create a new forecast scenario

Request body

Description

Target forecast scenario.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "created_by_id": {
      "description": "Id of the user that created the scenario",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "memo": {
      "description": "Memo describing the scenario",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "ref": {
      "description": "Reference code for the scenario",
      "type": "string",
      "format": "string",
      "example": "XYZ"
    },
    "estimate_expires": {
      "description": "If expected expirees should be estimated",
      "type": "string",
      "format": "bool",
      "example": false
    },
    "supply_estimator_version": {
      "description": "The version of the supply estimator",
      "type": "integer",
      "format": "int32",
      "example": 1
    },
    "supply_sales_only_tag_id": {
      "description": "Sku tag id of skus where only the sales should be considered when estimating supply",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "supply_expected_sales_only": {
      "description": "If only the expected sales (and not actual sales orders) should be considered\nwhen calculating supplies",
      "type": "string",
      "format": "bool",
      "example": false
    },
    "production_estimated_at": {
      "description": "The time when consumption was last estimated",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "created_by_id": {
        "description": "Id of the user that created the scenario",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "memo": {
        "description": "Memo describing the scenario",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "ref": {
        "description": "Reference code for the scenario",
        "type": "string",
        "format": "string",
        "example": "XYZ"
      },
      "estimate_expires": {
        "description": "If expected expirees should be estimated",
        "type": "string",
        "format": "bool",
        "example": false
      },
      "supply_estimator_version": {
        "description": "The version of the supply estimator",
        "type": "integer",
        "format": "int32",
        "example": 1
      },
      "supply_sales_only_tag_id": {
        "description": "Sku tag id of skus where only the sales should be considered when estimating supply",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "supply_expected_sales_only": {
        "description": "If only the expected sales (and not actual sales orders) should be considered\nwhen calculating supplies",
        "type": "string",
        "format": "bool",
        "example": false
      },
      "production_estimated_at": {
        "description": "The time when consumption was last estimated",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "readOnly": true,
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "readOnly": true,
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

500

internal server error