This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

GET /price-lists/{scope}

Get list of Price Lists

Description

Returns list of Price Lists

Parameters (path)

Name Required Description Values
scope required Scope. Can be either purchase or sales purchase, sales

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by.  
sortDirection optional Direction of sort. asc, desc
id[eq] optional Search for price list by id. Allowed expression(s): eq, in  
keyword[eq] optional Search for price list by keyword. Allowed expression(s): eq, ct  
active[eq] optional Search for pricelists by active status. Allowed expression(s): eq  
include optional The resources that can be included in this request, delimited by a comma: fallback, prices, reporting_partner  

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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "name",
          "currency",
          "exchange_rate",
          "active"
        ],
        "properties": {
          "id": {
            "description": "Id of the record",
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "currency": {
            "description": "ISO 4217 Currency Codes 3 letter currency code",
            "type": "string",
            "format": "string",
            "example": "DKK"
          },
          "exchange_rate": {
            "description": "The exchange rate of the price list. Will be used if an order is not in the same currency as\nthe price list",
            "type": "number",
            "format": "double",
            "example": 1234.123
          },
          "fallback_id": {
            "description": "If a price is not available in this price list. Look in this pricelist instead",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "global": {
            "description": "If this is true, partners that do not have an assigned price list, mat use prices from this\nprice list",
            "type": "boolean",
            "format": "boolean",
            "example": true
          },
          "correct_fallback": {
            "description": "Boolean indicating if the price list prices are based on corrections of the fallback price list",
            "type": "boolean",
            "format": "boolean",
            "example": false
          },
          "locked": {
            "description": "If this price list is locked and cannot be deleted",
            "type": "boolean",
            "format": "boolean",
            "readOnly": true,
            "example": true
          },
          "name": {
            "description": "Name of the price list",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "ref": {
            "description": "A reference code of the price list",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "replacement_id": {
            "description": "Id of a price list that replaces this price list",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "replaced_from": {
            "description": "If this is set the price list specified in *replacement_id* will take over on orders\ndelivered from this date.",
            "type": "string",
            "format": "date",
            "example": "2022-01-01"
          },
          "replaced_to": {
            "description": "If this is set the price list specified in *replacement_id* will take over on orders\ndelivered to this date.",
            "type": "string",
            "format": "date",
            "example": "2022-01-01"
          },
          "reporting_partner_id": {
            "description": "Id of a partner. Can be used for reporting purposes only. Does not affect price lookups",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "scope": {
            "description": "The scope of the price list. Wether this is purchase prices or sales prices.\nPurchase prices can be looked up on both production orders and purchase orders.",
            "type": "string",
            "format": "string",
            "readOnly": true,
            "example": "A string"
          },
          "auto_refresh_exchange_rate": {
            "description": "If the exchange rate should be updated automatically when new exchange rates are fetched from ECB",
            "type": "boolean",
            "format": "boolean",
            "example": true
          },
          "active": {
            "description": "Boolean indicating if the record is active and could be referenced from other entities",
            "type": "boolean",
            "format": "boolean",
            "example": true
          },
          "prices": {
            "description": "Prices in the price list. \nPrices should be an object where the property name is uuid of the SKU and the value\nshould be the price\nNotice that these will only be included if *prices* are included in the include parameter",
            "properties": {
              "be3233c4-c0a2-4f47-a62a-303492c20ba6": {
                "type": "number",
                "format": "double",
                "example": 100.21
              },
              "de3233c4-q0a2-4f47-a62a-503492c20ba6": {
                "type": "number",
                "format": "double",
                "example": 100.21
              }
            },
            "type": "object",
            "readOnly": true
          },
          "corrections": {
            "description": "Corrections in the price list. \nCorrections should be an object where the property name is uuid of the SKU and the value\nshould be the percentage correction\nNotice that these will only be included if *prices* are included in the include parameter\nand the price list is set to correct the fallback price list.",
            "properties": {
              "be3233c4-c0a2-4f47-a62a-303492c20ba6": {
                "type": "number",
                "format": "double",
                "example": 17
              },
              "de3233c4-q0a2-4f47-a62a-503492c20ba6": {
                "type": "number",
                "format": "double",
                "example": 15
              }
            },
            "type": "object",
            "readOnly": true
          },
          "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"
      }
    },
    "links": {
      "description": "Links",
      "properties": {
        "first": {
          "description": "Link to the first page",
          "type": "string"
        },
        "last": {
          "description": "Link to the last page",
          "type": "string"
        },
        "next": {
          "description": "Link to the next page",
          "type": "string"
        },
        "prev": {
          "description": "Link to the previous page",
          "type": "string"
        }
      },
      "type": "object"
    },
    "meta": {
      "description": "Meta with pagination",
      "properties": {
        "current_page": {
          "description": "The current page",
          "type": "integer"
        },
        "from": {
          "description": "The starting position of the current page results",
          "type": "integer"
        },
        "last_page": {
          "description": "The last page",
          "type": "integer"
        },
        "path": {
          "description": "The current path of the request",
          "type": "string"
        },
        "per_page": {
          "description": "Records that are displayed pr request",
          "type": "integer"
        },
        "to": {
          "description": "The ending position of the current page results",
          "type": "integer"
        },
        "total": {
          "description": "Number of records that are matched by the current query",
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

406

not acceptable

500

internal server error

POST /price-lists/{scope}

Create new PriceList

Description

Create a new PriceList

Parameters (path)

Name Required Description Values
scope required Scope. Can be either purchase or sales purchase, sales

Request body

Description

Target price list.

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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

{
  "required": [
    "name",
    "currency",
    "exchange_rate",
    "active"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "currency": {
      "description": "ISO 4217 Currency Codes 3 letter currency code",
      "type": "string",
      "format": "string",
      "example": "DKK"
    },
    "exchange_rate": {
      "description": "The exchange rate of the price list. Will be used if an order is not in the same currency as\nthe price list",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "fallback_id": {
      "description": "If a price is not available in this price list. Look in this pricelist instead",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "global": {
      "description": "If this is true, partners that do not have an assigned price list, mat use prices from this\nprice list",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "correct_fallback": {
      "description": "Boolean indicating if the price list prices are based on corrections of the fallback price list",
      "type": "boolean",
      "format": "boolean",
      "example": false
    },
    "locked": {
      "description": "If this price list is locked and cannot be deleted",
      "type": "boolean",
      "format": "boolean",
      "readOnly": true,
      "example": true
    },
    "name": {
      "description": "Name of the price list",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "ref": {
      "description": "A reference code of the price list",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "replacement_id": {
      "description": "Id of a price list that replaces this price list",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "replaced_from": {
      "description": "If this is set the price list specified in *replacement_id* will take over on orders\ndelivered from this date.",
      "type": "string",
      "format": "date",
      "example": "2022-01-01"
    },
    "replaced_to": {
      "description": "If this is set the price list specified in *replacement_id* will take over on orders\ndelivered to this date.",
      "type": "string",
      "format": "date",
      "example": "2022-01-01"
    },
    "reporting_partner_id": {
      "description": "Id of a partner. Can be used for reporting purposes only. Does not affect price lookups",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "scope": {
      "description": "The scope of the price list. Wether this is purchase prices or sales prices.\nPurchase prices can be looked up on both production orders and purchase orders.",
      "type": "string",
      "format": "string",
      "readOnly": true,
      "example": "A string"
    },
    "auto_refresh_exchange_rate": {
      "description": "If the exchange rate should be updated automatically when new exchange rates are fetched from ECB",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "active": {
      "description": "Boolean indicating if the record is active and could be referenced from other entities",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "prices": {
      "description": "Prices in the price list. \nPrices should be an object where the property name is uuid of the SKU and the value\nshould be the price\nNotice that these will only be included if *prices* are included in the include parameter",
      "properties": {
        "be3233c4-c0a2-4f47-a62a-303492c20ba6": {
          "type": "number",
          "format": "double",
          "example": 100.21
        },
        "de3233c4-q0a2-4f47-a62a-503492c20ba6": {
          "type": "number",
          "format": "double",
          "example": 100.21
        }
      },
      "type": "object",
      "readOnly": true
    },
    "corrections": {
      "description": "Corrections in the price list. \nCorrections should be an object where the property name is uuid of the SKU and the value\nshould be the percentage correction\nNotice that these will only be included if *prices* are included in the include parameter\nand the price list is set to correct the fallback price list.",
      "properties": {
        "be3233c4-c0a2-4f47-a62a-303492c20ba6": {
          "type": "number",
          "format": "double",
          "example": 17
        },
        "de3233c4-q0a2-4f47-a62a-503492c20ba6": {
          "type": "number",
          "format": "double",
          "example": 15
        }
      },
      "type": "object",
      "readOnly": true
    },
    "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

201

successful operation

406

not acceptable

500

internal server error