This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /deliveries/{deliveryId}/lines-extract
Get summarised extract of lines on delivery
Description
Returns summarised extract of lines on delivery
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| deliveryId | required | Target delivery. |
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| include | optional | The resources that can be included in this request, delimited by a comma: sku, lot, order_lot |
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
{
"properties": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"batch_number_overwrite": {
"description": "SSCC given batch number overwrite.",
"type": "string",
"format": "string",
"example": "A string"
},
"change_reason": {
"description": "GS1 change reason code",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_line_number": {
"description": "The customer line number from the sales order",
"format": "",
"example": ""
},
"customer_order_ean": {
"description": "The ean number the customer used to order this item",
"type": "string",
"format": "string",
"example": "A string"
},
"delivery_lot_id": {
"description": "The line id of this line on the delivery",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"expiry_date_overwrite": {
"description": "Overwrite of expiry date given by the SSCC line",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"line_text": {
"description": "Line text on the delivery line",
"type": "string",
"format": "string",
"example": "A string"
},
"lot_id": {
"description": "Lot id of the lot on the delivery",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_lot_id": {
"description": "The id of the lot line on the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"quantity": {
"description": "The quantity being delivered",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_diff": {
"description": "Deviation from expected delivery",
"type": "integer",
"format": "int32",
"example": 1234
},
"quantity_parcels": {
"description": "Number of delivered parcels",
"type": "integer",
"format": "int32",
"example": 1234
},
"base_unit": {
"description": "Unit of the quantity-field",
"type": "string",
"format": "string",
"example": "A string"
},
"quantity_uom": {
"description": "Quantity of UomS",
"type": "number",
"format": "double",
"example": 1234.123
},
"sku_id": {
"description": "The ID of the SKU being delivered",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"source": {
"description": "Source",
"type": "string",
"format": "string",
"example": "A string"
},
"sscc": {
"description": "SSCC number of a SSCC line",
"type": "string",
"format": "string",
"example": "A string"
},
"sscc_free_text_1": {
"description": "Free text field on SSCC",
"type": "string",
"format": "string",
"example": "A string"
},
"sscc_free_text_2": {
"description": "Free text field on SSCC",
"type": "string",
"format": "string",
"example": "A string"
},
"sscc_free_text_3": {
"description": "Free text field on SSCC",
"type": "string",
"format": "string",
"example": "A string"
},
"sscc_free_int_1": {
"description": "Free int field on SSCC",
"type": "integer",
"format": "int",
"example": 0
},
"sscc_comment": {
"description": "Comment related to SSCC",
"type": "string",
"format": "string",
"example": "A string"
},
"uom_conversion": {
"description": "Conversion between the *base_unit* and the *unit_of_measure* of the SKU",
"type": "number",
"format": "double",
"example": 1234.123
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"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",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
},
"type": "object"
}
406
not acceptable
500
internal server error