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

GET /traces

Get list of traces (max 100 records)

Description

Returns list of traces (max 100 records)

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by.  
sortDirection optional Direction of sort. asc, desc
origin_lot[eq] optional Search for traces by origin lot id. Allowed expression(s): eq, in  
origin_delivery[eq] optional Search for traces by delivery id. Allowed expression(s): eq, in  
key[eq] optional Search for trace key. Eg. batch number, lot number, etc. Allowed expression(s): eq, in, ct  

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

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "origin_entity_id",
          "origin_model_name",
          "bring_forward",
          "key",
          "system"
        ],
        "properties": {
          "id": {
            "description": "Id of the record",
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "bring_forward": {
            "description": "If the trace should be brought forward to successors of the lot (only available if origin entity is a lot)",
            "type": "boolean",
            "format": "boolean",
            "example": false
          },
          "hide_on_documents": {
            "description": "If the trace should be hidden on documents",
            "type": "boolean",
            "format": "boolean",
            "example": false
          },
          "key": {
            "description": "The key of the trace",
            "type": "string",
            "format": "string",
            "example": "ABC1234"
          },
          "label": {
            "description": "The lavel of the trace",
            "type": "string",
            "format": "string",
            "example": "Track&trace number"
          },
          "link_entity_id": {
            "description": "The entity to be linked to this trace. See *link_model_name*",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "link_model_name": {
            "description": "Model name of the model this trace is linked to",
            "type": "string",
            "format": "string",
            "enum": [
              "PartnerCertificate",
              "Partner"
            ],
            "example": "PartnerCertificate"
          },
          "origin_entity_id": {
            "description": "The id of the delivery or lot that this trace is attached to",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "origin_model_name": {
            "description": "The model name that this trace is attached to",
            "type": "string",
            "format": "string",
            "enum": [
              "Delivery",
              "Lot",
              "Order"
            ],
            "example": "Lot"
          },
          "system": {
            "description": "The trace system",
            "type": "string",
            "format": "string",
            "enum": [
              "certificate",
              "batch_number",
              "lot_number",
              "serial_number",
              "container_number",
              "pallet_number",
              "track_and_trace",
              "transport_event",
              "owner",
              "other",
              "line_ref",
              "control_body_code",
              "customer",
              "origin_raw_material"
            ],
            "example": "batch_number"
          },
          "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"
      }
    },
    "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 /traces

Create new Trace

Description

Create a new Trace

Request body

Description

Target Trace.

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

{
  "required": [
    "origin_entity_id",
    "origin_model_name",
    "bring_forward",
    "key",
    "system"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "bring_forward": {
      "description": "If the trace should be brought forward to successors of the lot (only available if origin entity is a lot)",
      "type": "boolean",
      "format": "boolean",
      "example": false
    },
    "hide_on_documents": {
      "description": "If the trace should be hidden on documents",
      "type": "boolean",
      "format": "boolean",
      "example": false
    },
    "key": {
      "description": "The key of the trace",
      "type": "string",
      "format": "string",
      "example": "ABC1234"
    },
    "label": {
      "description": "The lavel of the trace",
      "type": "string",
      "format": "string",
      "example": "Track&trace number"
    },
    "link_entity_id": {
      "description": "The entity to be linked to this trace. See *link_model_name*",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "link_model_name": {
      "description": "Model name of the model this trace is linked to",
      "type": "string",
      "format": "string",
      "enum": [
        "PartnerCertificate",
        "Partner"
      ],
      "example": "PartnerCertificate"
    },
    "origin_entity_id": {
      "description": "The id of the delivery or lot that this trace is attached to",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "origin_model_name": {
      "description": "The model name that this trace is attached to",
      "type": "string",
      "format": "string",
      "enum": [
        "Delivery",
        "Lot",
        "Order"
      ],
      "example": "Lot"
    },
    "system": {
      "description": "The trace system",
      "type": "string",
      "format": "string",
      "enum": [
        "certificate",
        "batch_number",
        "lot_number",
        "serial_number",
        "container_number",
        "pallet_number",
        "track_and_trace",
        "transport_event",
        "owner",
        "other",
        "line_ref",
        "control_body_code",
        "customer",
        "origin_raw_material"
      ],
      "example": "batch_number"
    },
    "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"
}

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

{
  "properties": {
    "type": "array",
    "items": {
      "required": [
        "origin_entity_id",
        "origin_model_name",
        "bring_forward",
        "key",
        "system"
      ],
      "properties": {
        "id": {
          "description": "Id of the record",
          "type": "string",
          "format": "uuid",
          "readOnly": true,
          "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
        },
        "bring_forward": {
          "description": "If the trace should be brought forward to successors of the lot (only available if origin entity is a lot)",
          "type": "boolean",
          "format": "boolean",
          "example": false
        },
        "hide_on_documents": {
          "description": "If the trace should be hidden on documents",
          "type": "boolean",
          "format": "boolean",
          "example": false
        },
        "key": {
          "description": "The key of the trace",
          "type": "string",
          "format": "string",
          "example": "ABC1234"
        },
        "label": {
          "description": "The lavel of the trace",
          "type": "string",
          "format": "string",
          "example": "Track&trace number"
        },
        "link_entity_id": {
          "description": "The entity to be linked to this trace. See *link_model_name*",
          "type": "string",
          "format": "uuid",
          "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
        },
        "link_model_name": {
          "description": "Model name of the model this trace is linked to",
          "type": "string",
          "format": "string",
          "enum": [
            "PartnerCertificate",
            "Partner"
          ],
          "example": "PartnerCertificate"
        },
        "origin_entity_id": {
          "description": "The id of the delivery or lot that this trace is attached to",
          "type": "string",
          "format": "uuid",
          "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
        },
        "origin_model_name": {
          "description": "The model name that this trace is attached to",
          "type": "string",
          "format": "string",
          "enum": [
            "Delivery",
            "Lot",
            "Order"
          ],
          "example": "Lot"
        },
        "system": {
          "description": "The trace system",
          "type": "string",
          "format": "string",
          "enum": [
            "certificate",
            "batch_number",
            "lot_number",
            "serial_number",
            "container_number",
            "pallet_number",
            "track_and_trace",
            "transport_event",
            "owner",
            "other",
            "line_ref",
            "control_body_code",
            "customer",
            "origin_raw_material"
          ],
          "example": "batch_number"
        },
        "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