This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /certificates
Get list of partner certificates
Description
Returns list of certificates
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| active[eq] | optional | Search for active partner certificates. Allowed expression(s): eq | |
| ref[eq] | optional | Search for partner certificates by reference. Allowed expression(s): eq, ct | |
| partner[eq] | optional | Search for partner certificates by partner id. Allowed expression(s): eq, in | |
| certification_body[eq] | optional | Search for certificates by certification body (partner id). Allowed expression(s): eq, in | |
| certification_scheme[eq] | optional | Search for certificates by scheme id. Allowed expression(s): eq, in | |
| country[eq] | optional | Search for partner certificates by partner country. Allowed expression(s): eq | |
| include | optional | The resources that can be included in this request, delimited by a comma: partner, location, skus, certification_body, certification_scheme, 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
{
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"ref",
"certification_body_id"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"certification_body_id": {
"description": "Partner id of the certification body",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"expires_at": {
"description": "When the certificate expires",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"issued_at": {
"description": "When this certificate was issued",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"audited_at": {
"description": "When this certificate was audited",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"next_audit_at": {
"description": "When the next audit is scheduled to take place",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"locked": {
"description": "If this certificate is locked and therefore cannot be deleted",
"type": "boolean",
"format": "boolean",
"example": true
},
"number": {
"description": "Number of the certificate",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"partner_id": {
"description": "Reference to the partner the certificate belongs to",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"location_id": {
"description": "Reference to the partner location the certificate belongs to",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"ref": {
"description": "Reference code of this certificate",
"type": "string",
"format": "string",
"example": "A string"
},
"certification_scheme_id": {
"description": "Certification scheme",
"type": "string",
"format": "string",
"example": "certification_scheme_id"
},
"url": {
"description": "Url of external documentation for this certificate",
"type": "string",
"format": "string",
"example": "A string"
},
"valid_from": {
"description": "When this certificate is valid from",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"batch_certificate": {
"description": "Boolean indicating if this certificate should be valid for all batches from this\nsupplier where the reference matches the batch number. Can be limited to specific skus.",
"type": "boolean",
"format": "boolean",
"example": true
},
"sku_limit_rule": {
"description": "How/if this certificate should be limited to specific SKU's\n- *any*: This certificate applies to any SKU's\n- *only*: This certificate only applies to specified SKU's\n- *except*: This certificate applies to any SKU's except those specified",
"type": "string",
"format": "string",
"default": "any",
"enum": [
"any",
"only",
"except"
],
"example": "only"
},
"active": {
"description": "Boolean indicating if the record is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"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"
}
403
Unauthorized request
406
Not acceptable
500
Internal server error