This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /skus/{skuId}
Get sku
Description
Returns sku
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| skuId | required | Target sku. |
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| include | optional | The resources that can be included in this request, delimited by a comma: attributes, translations, none_traceable_stock_as_of, quantity_declarations, tags, certification_bodies, nutrition, descriptions, codings, dimensions, partner_codes, masters, subs, retail_prices, files_count |
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
{
"properties": {
"required": [
"sku_code",
"name",
"unit_of_measure",
"lot_unit",
"weight_factor_gross",
"weight_factor_net"
],
"properties": {
"id": {
"description": "Id of the Sku record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"allow_consumption": {
"description": "If this SKU should be allowed to be used on production orders as a raw material",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_production": {
"description": "If this SKU should be allowed to be produced on production orders",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_purchase": {
"description": "If this SKU should be allowed to be purchased on purchase orders",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_suppliers_purchase": {
"description": "If this SKU should be allowed to be purchased from partners that have been marked\nas suppiers only. This is only relevant if *allow_purchase* is set to *false*",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_sales": {
"description": "If this SKU should be allowed to be sold on sales orders\nNotice that this setting is only guiding and can be used in the UI to filter SKUs",
"type": "boolean",
"format": "boolean",
"example": true
},
"auto_recipe_id": {
"description": "The recipe that should be linked to this SKU. When adding the SKU as a finished product on a production order, \nthis recipe will be added automatically. Also this recipe will be used when doing forecasting",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"average_parcel_size": {
"description": "When parcels are enabled this is the average parcel size in UoMs that will be used on the order",
"type": "number",
"format": "double",
"example": 1234.123
},
"batch_controlled": {
"description": "If traceable lots of this SKU is expected to have a batch number assigned",
"type": "boolean",
"format": "boolean",
"example": true
},
"expiry_date_type": {
"description": "What type the expiry date is on this SKU",
"type": "string",
"format": "string",
"default": "none",
"enum": [
"any",
"best_before",
"use_by",
"none"
],
"example": "best_before"
},
"lock_parcel_size": {
"description": "Boolean indicating if the parcel size defined on the inbound order should be\nbrought forward to outbound orders. Only works if *enable_parcels_outbound* and\nenable_parcels_inbound* is set to true!",
"type": "boolean",
"format": "boolean",
"example": false
},
"category": {
"description": "Wether this is a finished good or a raw material. As a general rule, goods that are normally not being sold is a raw material",
"type": "string",
"format": "string",
"enum": [
"raw_material",
"intermediate_good",
"finished_good"
],
"example": "raw_material"
},
"cost_avg_actual": {
"description": "The average actual cost price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"cost_avg_expected": {
"description": "The average expected cost price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"cost_base": {
"description": "Not being used yet",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"days_best_before": {
"description": "Days from the production date till the best before date",
"type": "integer",
"format": "int32",
"example": 365
},
"days_use_by": {
"description": "Days from the production date till the use by date",
"type": "integer",
"format": "int32",
"example": 365
},
"default_origin_country": {
"description": "The origin country that should be set by default on lots with this SKU. \nISO 3166-1 alpha-2 Country Code",
"type": "string",
"format": "string",
"example": "DK"
},
"default_uom_conversion": {
"description": "The default conversion factor between one lot unit and one unit of measure",
"type": "number",
"format": "double",
"default": 1,
"example": 1234.123
},
"none_traceable_uom_conversion": {
"description": "The conversion between one lot unit and one UoM that will be used for none traceable inventory",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"ean": {
"description": "The EAN number of one lot unit",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"ean_parcel": {
"description": "The EAN number of one parcel unit",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"ean_uom": {
"description": "The ean number of one Unit of Measure",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"enable_parcels_inbound": {
"description": "If parcels should be enabled on inbound lines, eg. purchased lots, produced lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"enable_parcels_outbound": {
"description": "If parcels should be enabled on outbound lines, eg. sold lots, consumed lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"force_inbound_parcel_size": {
"description": "If the parcel size set in *average_parcel_size* should be forced on inbound orders. When this option is enabled the system will automatically round up the ordered quantity",
"type": "boolean",
"format": "boolean",
"example": true
},
"global_name": {
"description": "The name that should be used if no translation is specified",
"type": "string",
"format": "string",
"example": "Carrots"
},
"has_subs": {
"description": "true* if SKU has any subordinate SKUs",
"type": "string",
"format": "boolean",
"readOnly": true,
"example": false
},
"invoice_sum_only": {
"description": "If invoices should only display sums for this product, and not display the underlying lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"hide_on_documents": {
"description": "If lines with this SKU should never be shown on documents",
"type": "boolean",
"format": "boolean",
"example": true
},
"latin_name": {
"description": "Latin name of the SKU",
"type": "string",
"format": "string",
"example": "A string"
},
"lead_time": {
"description": "How many days before receipt an inbound has to be placed to make sure the goods will make it on time",
"type": "integer",
"format": "int32",
"example": 100
},
"locked": {
"description": "If this SKU is locked. Usually because other entities reference the SKU. When the SKU is locked it cannot be deleted.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"lock_uom_conversion": {
"description": "If the conversion between one lot unit and one UoM should be locked. (deprecated)",
"type": "boolean",
"format": "boolean",
"example": true
},
"lot_unit": {
"description": "The unit that should be used for traceable lots",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"mcl",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"m3",
"oz",
"lb"
],
"example": "colli"
},
"none_traceable_lot_unit": {
"description": "The unit that should be used for none-traceable inventory",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"mcl",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"m3",
"oz",
"lb"
],
"readOnly": true,
"example": "pcs"
},
"planner_id": {
"description": "Id of the user that are the planner for this SKU.",
"type": "integer",
"format": "int32",
"example": 1234
},
"use_reorder_point": {
"description": "If reorder point should be used for planning purposes",
"type": "boolean",
"format": "boolean",
"example": true
},
"reorder_point": {
"description": "When inventory has reached this level a new order should be placed. Only used for planning purposes if *use_reorder_point* is set to *true*",
"type": "integer",
"format": "int32",
"example": 1234
},
"req_days_expiry": {
"description": "General expiry date requirement",
"type": "integer",
"format": "int32",
"example": 365
},
"safety_stock": {
"description": "How much should always be left on stock, when inventory levels in webshops and the like are updated",
"type": "integer",
"format": "int32",
"example": 1234
},
"sku_code": {
"description": "A SKU code that uniquely identify the SKU. Keep it short!",
"type": "string",
"format": "string",
"example": "1001A"
},
"specify_lot_input": {
"description": "If raw material lots for finisheds goods lots should be specified indvidually",
"type": "boolean",
"format": "boolean",
"example": true
},
"traceable": {
"description": "If this SKU should be traceable",
"type": "boolean",
"format": "boolean",
"example": true
},
"unit_of_measure": {
"description": "The unit of measure. This will be the common measure across all inventory.",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"oz",
"lb"
],
"example": "pcs"
},
"use_cost_base": {
"description": "Not used yet",
"type": "boolean",
"format": "boolean",
"example": true
},
"weight_factor_gross": {
"description": "Gross weight per one UoM",
"type": "number",
"format": "double",
"example": 1234.123
},
"weight_factor_net": {
"description": "Net weight per one UoM",
"type": "number",
"format": "double",
"example": 1234.123
},
"active": {
"description": "Boolean indicating if the SKU is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"tag_ids": {
"description": "Tag ids related to the SKU entity. \nNotice that these will only be included if *tags* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"translations": {
"description": "Translations of the SKU entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
"properties": {
"da": {
"type": "string",
"format": "string",
"example": "Gulerødder"
},
"de": {
"type": "string",
"format": "string",
"example": "Môhren"
}
},
"type": "object"
},
"attributes": {
"description": "Attributes of the SKU entity. Enabled attributes can be assigned to lots\nAttributes should be an object where each property represent an attribute.\nAvailable attributes are: *catch_method, customs_status, eu_tariff_code, ewc_code, fao_fishing_area, origin, origin_farm, origin_breeder, packaging, quality, size, specification, storage_bin, supplier_sku*\nNotice that these will only be included if *attriutes* are included in the include parameter",
"properties": {
"properties": {
"enable": {
"type": "string",
"format": "boolean",
"default": false,
"example": true
},
"default_value_id": {
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"type": "object"
},
"type": "object"
},
"certification_body_ids": {
"description": "DEPRECATED. Use *certification_bodies* instead! Ids of partner that are certification bodies of this SKU. \nNotice that these will only be included if *certification_bodies* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"deprecated": true
},
"certification_bodies": {
"description": "Information related to certification bodies & schemes on this SKU. \nNotice that these will only be included if *certification_bodies* are included in the include parameter",
"type": "array",
"items": {
"properties": {
"certification_body_id": {
"description": "Partner id of certification body",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"certification_scheme_id": {
"description": "Id of certification scheme",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"req_supplier_cert": {
"description": "If the supplier of this SKU must hold an active certificate under this certification scheme",
"type": "string",
"format": "boolean",
"example": false
},
"req_customer_cert": {
"description": "If the customer of this SKU must hold an active certificate under this certification scheme",
"type": "string",
"format": "boolean",
"example": false
}
},
"type": "object"
}
},
"partner_codes": {
"description": "Information related to trading partners on this SKU. \nNotice that these will only be included if *partner_codes* are included in the include parameter",
"type": "array",
"items": {
"properties": {
"partner_id": {
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"code_name": {
"description": "What the supplier calls the SKU. Can be left empty",
"type": "string",
"format": "string",
"example": "Super Carrots"
},
"is_supplier": {
"description": "If the partner is a supplier of this product",
"type": "string",
"format": "boolean",
"example": false
},
"is_producer": {
"description": "If the partner is a producer of this product",
"type": "string",
"format": "boolean",
"example": false
},
"is_customer": {
"description": "If the partner is a customer of this product",
"type": "string",
"format": "boolean",
"example": true
},
"min_order": {
"description": "The minimum order quantity when trading with this partner",
"type": "string",
"format": "int32",
"example": 100
},
"sku_code": {
"description": "The partners SKU code of one lot unit",
"type": "string",
"format": "string",
"example": "101"
},
"sku_code_uom": {
"description": "The partners SKU code of one unit of measure",
"type": "string",
"format": "string",
"example": "1001"
},
"req_days_expiry": {
"description": "Required days until expiry after delivery",
"type": "string",
"format": "int32",
"example": 100
}
},
"type": "object"
}
},
"quantity_declarations": {
"description": "Quantity Declarations of the SKU. \nQuantity Declarations should be an object where the property name is the id of the quantity declaration and the value is an\nobject representing the QUID on the SKU. \nNotice that these will only be included if *quantity_declarations* are included in the include parameter",
"properties": {
"description": "Each property represents a quantity declaration on a sku, where the attribute is the uuid of the quantity declaration",
"properties": {
"quantity": {
"description": "The quantity of the quid on the sku.",
"type": "number",
"format": "double",
"example": 20
},
"allergen_status": {
"description": "Allergen status if any.",
"type": "string",
"format": "string",
"enum": [
"contains",
"may_contain"
],
"example": "contains"
}
},
"type": "object"
},
"type": "object"
},
"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
PUT /skus/{skuId}
Update existing sku
Description
Update the specified resource in storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| skuId | required | Target sku. |
Request body
Description
Target sku.
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
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
{
"required": [
"sku_code",
"name",
"unit_of_measure",
"lot_unit",
"weight_factor_gross",
"weight_factor_net"
],
"properties": {
"id": {
"description": "Id of the Sku record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"allow_consumption": {
"description": "If this SKU should be allowed to be used on production orders as a raw material",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_production": {
"description": "If this SKU should be allowed to be produced on production orders",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_purchase": {
"description": "If this SKU should be allowed to be purchased on purchase orders",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_suppliers_purchase": {
"description": "If this SKU should be allowed to be purchased from partners that have been marked\nas suppiers only. This is only relevant if *allow_purchase* is set to *false*",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_sales": {
"description": "If this SKU should be allowed to be sold on sales orders\nNotice that this setting is only guiding and can be used in the UI to filter SKUs",
"type": "boolean",
"format": "boolean",
"example": true
},
"auto_recipe_id": {
"description": "The recipe that should be linked to this SKU. When adding the SKU as a finished product on a production order, \nthis recipe will be added automatically. Also this recipe will be used when doing forecasting",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"average_parcel_size": {
"description": "When parcels are enabled this is the average parcel size in UoMs that will be used on the order",
"type": "number",
"format": "double",
"example": 1234.123
},
"batch_controlled": {
"description": "If traceable lots of this SKU is expected to have a batch number assigned",
"type": "boolean",
"format": "boolean",
"example": true
},
"expiry_date_type": {
"description": "What type the expiry date is on this SKU",
"type": "string",
"format": "string",
"default": "none",
"enum": [
"any",
"best_before",
"use_by",
"none"
],
"example": "best_before"
},
"lock_parcel_size": {
"description": "Boolean indicating if the parcel size defined on the inbound order should be\nbrought forward to outbound orders. Only works if *enable_parcels_outbound* and\nenable_parcels_inbound* is set to true!",
"type": "boolean",
"format": "boolean",
"example": false
},
"category": {
"description": "Wether this is a finished good or a raw material. As a general rule, goods that are normally not being sold is a raw material",
"type": "string",
"format": "string",
"enum": [
"raw_material",
"intermediate_good",
"finished_good"
],
"example": "raw_material"
},
"cost_avg_actual": {
"description": "The average actual cost price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"cost_avg_expected": {
"description": "The average expected cost price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"cost_base": {
"description": "Not being used yet",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"days_best_before": {
"description": "Days from the production date till the best before date",
"type": "integer",
"format": "int32",
"example": 365
},
"days_use_by": {
"description": "Days from the production date till the use by date",
"type": "integer",
"format": "int32",
"example": 365
},
"default_origin_country": {
"description": "The origin country that should be set by default on lots with this SKU. \nISO 3166-1 alpha-2 Country Code",
"type": "string",
"format": "string",
"example": "DK"
},
"default_uom_conversion": {
"description": "The default conversion factor between one lot unit and one unit of measure",
"type": "number",
"format": "double",
"default": 1,
"example": 1234.123
},
"none_traceable_uom_conversion": {
"description": "The conversion between one lot unit and one UoM that will be used for none traceable inventory",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"ean": {
"description": "The EAN number of one lot unit",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"ean_parcel": {
"description": "The EAN number of one parcel unit",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"ean_uom": {
"description": "The ean number of one Unit of Measure",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"enable_parcels_inbound": {
"description": "If parcels should be enabled on inbound lines, eg. purchased lots, produced lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"enable_parcels_outbound": {
"description": "If parcels should be enabled on outbound lines, eg. sold lots, consumed lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"force_inbound_parcel_size": {
"description": "If the parcel size set in *average_parcel_size* should be forced on inbound orders. When this option is enabled the system will automatically round up the ordered quantity",
"type": "boolean",
"format": "boolean",
"example": true
},
"global_name": {
"description": "The name that should be used if no translation is specified",
"type": "string",
"format": "string",
"example": "Carrots"
},
"has_subs": {
"description": "true* if SKU has any subordinate SKUs",
"type": "string",
"format": "boolean",
"readOnly": true,
"example": false
},
"invoice_sum_only": {
"description": "If invoices should only display sums for this product, and not display the underlying lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"hide_on_documents": {
"description": "If lines with this SKU should never be shown on documents",
"type": "boolean",
"format": "boolean",
"example": true
},
"latin_name": {
"description": "Latin name of the SKU",
"type": "string",
"format": "string",
"example": "A string"
},
"lead_time": {
"description": "How many days before receipt an inbound has to be placed to make sure the goods will make it on time",
"type": "integer",
"format": "int32",
"example": 100
},
"locked": {
"description": "If this SKU is locked. Usually because other entities reference the SKU. When the SKU is locked it cannot be deleted.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"lock_uom_conversion": {
"description": "If the conversion between one lot unit and one UoM should be locked. (deprecated)",
"type": "boolean",
"format": "boolean",
"example": true
},
"lot_unit": {
"description": "The unit that should be used for traceable lots",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"mcl",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"m3",
"oz",
"lb"
],
"example": "colli"
},
"none_traceable_lot_unit": {
"description": "The unit that should be used for none-traceable inventory",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"mcl",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"m3",
"oz",
"lb"
],
"readOnly": true,
"example": "pcs"
},
"planner_id": {
"description": "Id of the user that are the planner for this SKU.",
"type": "integer",
"format": "int32",
"example": 1234
},
"use_reorder_point": {
"description": "If reorder point should be used for planning purposes",
"type": "boolean",
"format": "boolean",
"example": true
},
"reorder_point": {
"description": "When inventory has reached this level a new order should be placed. Only used for planning purposes if *use_reorder_point* is set to *true*",
"type": "integer",
"format": "int32",
"example": 1234
},
"req_days_expiry": {
"description": "General expiry date requirement",
"type": "integer",
"format": "int32",
"example": 365
},
"safety_stock": {
"description": "How much should always be left on stock, when inventory levels in webshops and the like are updated",
"type": "integer",
"format": "int32",
"example": 1234
},
"sku_code": {
"description": "A SKU code that uniquely identify the SKU. Keep it short!",
"type": "string",
"format": "string",
"example": "1001A"
},
"specify_lot_input": {
"description": "If raw material lots for finisheds goods lots should be specified indvidually",
"type": "boolean",
"format": "boolean",
"example": true
},
"traceable": {
"description": "If this SKU should be traceable",
"type": "boolean",
"format": "boolean",
"example": true
},
"unit_of_measure": {
"description": "The unit of measure. This will be the common measure across all inventory.",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"oz",
"lb"
],
"example": "pcs"
},
"use_cost_base": {
"description": "Not used yet",
"type": "boolean",
"format": "boolean",
"example": true
},
"weight_factor_gross": {
"description": "Gross weight per one UoM",
"type": "number",
"format": "double",
"example": 1234.123
},
"weight_factor_net": {
"description": "Net weight per one UoM",
"type": "number",
"format": "double",
"example": 1234.123
},
"active": {
"description": "Boolean indicating if the SKU is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"tag_ids": {
"description": "Tag ids related to the SKU entity. \nNotice that these will only be included if *tags* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"translations": {
"description": "Translations of the SKU entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
"properties": {
"da": {
"type": "string",
"format": "string",
"example": "Gulerødder"
},
"de": {
"type": "string",
"format": "string",
"example": "Môhren"
}
},
"type": "object"
},
"attributes": {
"description": "Attributes of the SKU entity. Enabled attributes can be assigned to lots\nAttributes should be an object where each property represent an attribute.\nAvailable attributes are: *catch_method, customs_status, eu_tariff_code, ewc_code, fao_fishing_area, origin, origin_farm, origin_breeder, packaging, quality, size, specification, storage_bin, supplier_sku*\nNotice that these will only be included if *attriutes* are included in the include parameter",
"properties": {
"properties": {
"enable": {
"type": "string",
"format": "boolean",
"default": false,
"example": true
},
"default_value_id": {
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"type": "object"
},
"type": "object"
},
"certification_body_ids": {
"description": "DEPRECATED. Use *certification_bodies* instead! Ids of partner that are certification bodies of this SKU. \nNotice that these will only be included if *certification_bodies* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"deprecated": true
},
"certification_bodies": {
"description": "Information related to certification bodies & schemes on this SKU. \nNotice that these will only be included if *certification_bodies* are included in the include parameter",
"type": "array",
"items": {
"properties": {
"certification_body_id": {
"description": "Partner id of certification body",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"certification_scheme_id": {
"description": "Id of certification scheme",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"req_supplier_cert": {
"description": "If the supplier of this SKU must hold an active certificate under this certification scheme",
"type": "string",
"format": "boolean",
"example": false
},
"req_customer_cert": {
"description": "If the customer of this SKU must hold an active certificate under this certification scheme",
"type": "string",
"format": "boolean",
"example": false
}
},
"type": "object"
}
},
"partner_codes": {
"description": "Information related to trading partners on this SKU. \nNotice that these will only be included if *partner_codes* are included in the include parameter",
"type": "array",
"items": {
"properties": {
"partner_id": {
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"code_name": {
"description": "What the supplier calls the SKU. Can be left empty",
"type": "string",
"format": "string",
"example": "Super Carrots"
},
"is_supplier": {
"description": "If the partner is a supplier of this product",
"type": "string",
"format": "boolean",
"example": false
},
"is_producer": {
"description": "If the partner is a producer of this product",
"type": "string",
"format": "boolean",
"example": false
},
"is_customer": {
"description": "If the partner is a customer of this product",
"type": "string",
"format": "boolean",
"example": true
},
"min_order": {
"description": "The minimum order quantity when trading with this partner",
"type": "string",
"format": "int32",
"example": 100
},
"sku_code": {
"description": "The partners SKU code of one lot unit",
"type": "string",
"format": "string",
"example": "101"
},
"sku_code_uom": {
"description": "The partners SKU code of one unit of measure",
"type": "string",
"format": "string",
"example": "1001"
},
"req_days_expiry": {
"description": "Required days until expiry after delivery",
"type": "string",
"format": "int32",
"example": 100
}
},
"type": "object"
}
},
"quantity_declarations": {
"description": "Quantity Declarations of the SKU. \nQuantity Declarations should be an object where the property name is the id of the quantity declaration and the value is an\nobject representing the QUID on the SKU. \nNotice that these will only be included if *quantity_declarations* are included in the include parameter",
"properties": {
"description": "Each property represents a quantity declaration on a sku, where the attribute is the uuid of the quantity declaration",
"properties": {
"quantity": {
"description": "The quantity of the quid on the sku.",
"type": "number",
"format": "double",
"example": 20
},
"allergen_status": {
"description": "Allergen status if any.",
"type": "string",
"format": "string",
"enum": [
"contains",
"may_contain"
],
"example": "contains"
}
},
"type": "object"
},
"type": "object"
},
"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
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
{
"properties": {
"required": [
"sku_code",
"name",
"unit_of_measure",
"lot_unit",
"weight_factor_gross",
"weight_factor_net"
],
"properties": {
"id": {
"description": "Id of the Sku record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"allow_consumption": {
"description": "If this SKU should be allowed to be used on production orders as a raw material",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_production": {
"description": "If this SKU should be allowed to be produced on production orders",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_purchase": {
"description": "If this SKU should be allowed to be purchased on purchase orders",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_suppliers_purchase": {
"description": "If this SKU should be allowed to be purchased from partners that have been marked\nas suppiers only. This is only relevant if *allow_purchase* is set to *false*",
"type": "boolean",
"format": "boolean",
"example": true
},
"allow_sales": {
"description": "If this SKU should be allowed to be sold on sales orders\nNotice that this setting is only guiding and can be used in the UI to filter SKUs",
"type": "boolean",
"format": "boolean",
"example": true
},
"auto_recipe_id": {
"description": "The recipe that should be linked to this SKU. When adding the SKU as a finished product on a production order, \nthis recipe will be added automatically. Also this recipe will be used when doing forecasting",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"average_parcel_size": {
"description": "When parcels are enabled this is the average parcel size in UoMs that will be used on the order",
"type": "number",
"format": "double",
"example": 1234.123
},
"batch_controlled": {
"description": "If traceable lots of this SKU is expected to have a batch number assigned",
"type": "boolean",
"format": "boolean",
"example": true
},
"expiry_date_type": {
"description": "What type the expiry date is on this SKU",
"type": "string",
"format": "string",
"default": "none",
"enum": [
"any",
"best_before",
"use_by",
"none"
],
"example": "best_before"
},
"lock_parcel_size": {
"description": "Boolean indicating if the parcel size defined on the inbound order should be\nbrought forward to outbound orders. Only works if *enable_parcels_outbound* and\nenable_parcels_inbound* is set to true!",
"type": "boolean",
"format": "boolean",
"example": false
},
"category": {
"description": "Wether this is a finished good or a raw material. As a general rule, goods that are normally not being sold is a raw material",
"type": "string",
"format": "string",
"enum": [
"raw_material",
"intermediate_good",
"finished_good"
],
"example": "raw_material"
},
"cost_avg_actual": {
"description": "The average actual cost price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"cost_avg_expected": {
"description": "The average expected cost price",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"cost_base": {
"description": "Not being used yet",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"days_best_before": {
"description": "Days from the production date till the best before date",
"type": "integer",
"format": "int32",
"example": 365
},
"days_use_by": {
"description": "Days from the production date till the use by date",
"type": "integer",
"format": "int32",
"example": 365
},
"default_origin_country": {
"description": "The origin country that should be set by default on lots with this SKU. \nISO 3166-1 alpha-2 Country Code",
"type": "string",
"format": "string",
"example": "DK"
},
"default_uom_conversion": {
"description": "The default conversion factor between one lot unit and one unit of measure",
"type": "number",
"format": "double",
"default": 1,
"example": 1234.123
},
"none_traceable_uom_conversion": {
"description": "The conversion between one lot unit and one UoM that will be used for none traceable inventory",
"type": "number",
"format": "double",
"readOnly": true,
"example": 1234.123
},
"ean": {
"description": "The EAN number of one lot unit",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"ean_parcel": {
"description": "The EAN number of one parcel unit",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"ean_uom": {
"description": "The ean number of one Unit of Measure",
"type": "integer",
"format": "int64",
"example": 12345678912345
},
"enable_parcels_inbound": {
"description": "If parcels should be enabled on inbound lines, eg. purchased lots, produced lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"enable_parcels_outbound": {
"description": "If parcels should be enabled on outbound lines, eg. sold lots, consumed lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"force_inbound_parcel_size": {
"description": "If the parcel size set in *average_parcel_size* should be forced on inbound orders. When this option is enabled the system will automatically round up the ordered quantity",
"type": "boolean",
"format": "boolean",
"example": true
},
"global_name": {
"description": "The name that should be used if no translation is specified",
"type": "string",
"format": "string",
"example": "Carrots"
},
"has_subs": {
"description": "true* if SKU has any subordinate SKUs",
"type": "string",
"format": "boolean",
"readOnly": true,
"example": false
},
"invoice_sum_only": {
"description": "If invoices should only display sums for this product, and not display the underlying lots",
"type": "boolean",
"format": "boolean",
"example": true
},
"hide_on_documents": {
"description": "If lines with this SKU should never be shown on documents",
"type": "boolean",
"format": "boolean",
"example": true
},
"latin_name": {
"description": "Latin name of the SKU",
"type": "string",
"format": "string",
"example": "A string"
},
"lead_time": {
"description": "How many days before receipt an inbound has to be placed to make sure the goods will make it on time",
"type": "integer",
"format": "int32",
"example": 100
},
"locked": {
"description": "If this SKU is locked. Usually because other entities reference the SKU. When the SKU is locked it cannot be deleted.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"lock_uom_conversion": {
"description": "If the conversion between one lot unit and one UoM should be locked. (deprecated)",
"type": "boolean",
"format": "boolean",
"example": true
},
"lot_unit": {
"description": "The unit that should be used for traceable lots",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"mcl",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"m3",
"oz",
"lb"
],
"example": "colli"
},
"none_traceable_lot_unit": {
"description": "The unit that should be used for none-traceable inventory",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"mcl",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"m3",
"oz",
"lb"
],
"readOnly": true,
"example": "pcs"
},
"planner_id": {
"description": "Id of the user that are the planner for this SKU.",
"type": "integer",
"format": "int32",
"example": 1234
},
"use_reorder_point": {
"description": "If reorder point should be used for planning purposes",
"type": "boolean",
"format": "boolean",
"example": true
},
"reorder_point": {
"description": "When inventory has reached this level a new order should be placed. Only used for planning purposes if *use_reorder_point* is set to *true*",
"type": "integer",
"format": "int32",
"example": 1234
},
"req_days_expiry": {
"description": "General expiry date requirement",
"type": "integer",
"format": "int32",
"example": 365
},
"safety_stock": {
"description": "How much should always be left on stock, when inventory levels in webshops and the like are updated",
"type": "integer",
"format": "int32",
"example": 1234
},
"sku_code": {
"description": "A SKU code that uniquely identify the SKU. Keep it short!",
"type": "string",
"format": "string",
"example": "1001A"
},
"specify_lot_input": {
"description": "If raw material lots for finisheds goods lots should be specified indvidually",
"type": "boolean",
"format": "boolean",
"example": true
},
"traceable": {
"description": "If this SKU should be traceable",
"type": "boolean",
"format": "boolean",
"example": true
},
"unit_of_measure": {
"description": "The unit of measure. This will be the common measure across all inventory.",
"type": "string",
"format": "string",
"enum": [
"colli",
"pcs",
"bigbag",
"ibc",
"jc",
"pd",
"fd",
"container",
"quarter_pallet",
"half_pallet",
"pallet",
"mm",
"cm",
"m",
"cm2",
"m2",
"l",
"ml",
"dl",
"cl",
"mg",
"g",
"hg",
"kg",
"mt",
"oz",
"lb"
],
"example": "pcs"
},
"use_cost_base": {
"description": "Not used yet",
"type": "boolean",
"format": "boolean",
"example": true
},
"weight_factor_gross": {
"description": "Gross weight per one UoM",
"type": "number",
"format": "double",
"example": 1234.123
},
"weight_factor_net": {
"description": "Net weight per one UoM",
"type": "number",
"format": "double",
"example": 1234.123
},
"active": {
"description": "Boolean indicating if the SKU is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"tag_ids": {
"description": "Tag ids related to the SKU entity. \nNotice that these will only be included if *tags* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"translations": {
"description": "Translations of the SKU entity. \nTranslations should be an object where the property name is the ISO 639-1 Code 2 letter language code and the value is the translation\nNotice that these will only be included if *translations* are included in the include parameter",
"properties": {
"da": {
"type": "string",
"format": "string",
"example": "Gulerødder"
},
"de": {
"type": "string",
"format": "string",
"example": "Môhren"
}
},
"type": "object"
},
"attributes": {
"description": "Attributes of the SKU entity. Enabled attributes can be assigned to lots\nAttributes should be an object where each property represent an attribute.\nAvailable attributes are: *catch_method, customs_status, eu_tariff_code, ewc_code, fao_fishing_area, origin, origin_farm, origin_breeder, packaging, quality, size, specification, storage_bin, supplier_sku*\nNotice that these will only be included if *attriutes* are included in the include parameter",
"properties": {
"properties": {
"enable": {
"type": "string",
"format": "boolean",
"default": false,
"example": true
},
"default_value_id": {
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"type": "object"
},
"type": "object"
},
"certification_body_ids": {
"description": "DEPRECATED. Use *certification_bodies* instead! Ids of partner that are certification bodies of this SKU. \nNotice that these will only be included if *certification_bodies* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"deprecated": true
},
"certification_bodies": {
"description": "Information related to certification bodies & schemes on this SKU. \nNotice that these will only be included if *certification_bodies* are included in the include parameter",
"type": "array",
"items": {
"properties": {
"certification_body_id": {
"description": "Partner id of certification body",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"certification_scheme_id": {
"description": "Id of certification scheme",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"req_supplier_cert": {
"description": "If the supplier of this SKU must hold an active certificate under this certification scheme",
"type": "string",
"format": "boolean",
"example": false
},
"req_customer_cert": {
"description": "If the customer of this SKU must hold an active certificate under this certification scheme",
"type": "string",
"format": "boolean",
"example": false
}
},
"type": "object"
}
},
"partner_codes": {
"description": "Information related to trading partners on this SKU. \nNotice that these will only be included if *partner_codes* are included in the include parameter",
"type": "array",
"items": {
"properties": {
"partner_id": {
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"code_name": {
"description": "What the supplier calls the SKU. Can be left empty",
"type": "string",
"format": "string",
"example": "Super Carrots"
},
"is_supplier": {
"description": "If the partner is a supplier of this product",
"type": "string",
"format": "boolean",
"example": false
},
"is_producer": {
"description": "If the partner is a producer of this product",
"type": "string",
"format": "boolean",
"example": false
},
"is_customer": {
"description": "If the partner is a customer of this product",
"type": "string",
"format": "boolean",
"example": true
},
"min_order": {
"description": "The minimum order quantity when trading with this partner",
"type": "string",
"format": "int32",
"example": 100
},
"sku_code": {
"description": "The partners SKU code of one lot unit",
"type": "string",
"format": "string",
"example": "101"
},
"sku_code_uom": {
"description": "The partners SKU code of one unit of measure",
"type": "string",
"format": "string",
"example": "1001"
},
"req_days_expiry": {
"description": "Required days until expiry after delivery",
"type": "string",
"format": "int32",
"example": 100
}
},
"type": "object"
}
},
"quantity_declarations": {
"description": "Quantity Declarations of the SKU. \nQuantity Declarations should be an object where the property name is the id of the quantity declaration and the value is an\nobject representing the QUID on the SKU. \nNotice that these will only be included if *quantity_declarations* are included in the include parameter",
"properties": {
"description": "Each property represents a quantity declaration on a sku, where the attribute is the uuid of the quantity declaration",
"properties": {
"quantity": {
"description": "The quantity of the quid on the sku.",
"type": "number",
"format": "double",
"example": 20
},
"allergen_status": {
"description": "Allergen status if any.",
"type": "string",
"format": "string",
"enum": [
"contains",
"may_contain"
],
"example": "contains"
}
},
"type": "object"
},
"type": "object"
},
"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"
}
403
Unauthorized request
406
not acceptable
422
Has validation errors
500
Internal server error
DELETE /skus/{skuId}
Delete sku
Description
Remove the specified resource from storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| skuId | required | Target sku. |
Responses
204
Delete was succesfull
403
Unauthorized request
406
not acceptable
500
Internal server error