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

GET /integration-logs

Get list of integration log entries

Description

Returns list of log intries

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by. created_at
sortDirection optional Direction of sort. asc, desc
collection_name[eq] optional Search for log entries by collection name. Allowed expression(s): eq, in  
collection_entity_id[eq] optional Search for log entries by collection entity id. Allowed expression(s): eq, in  
keyword[ct] optional Search for log entries by keyword. Allowed expression(s): ct, eq  
include optional The resources that can be included in this request, delimited by a comma: integration,created_by  

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

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "app_name",
          "log_message",
          "severity",
          "scope"
        ],
        "properties": {
          "id": {
            "description": "Id of the record",
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "app_name": {
            "description": "Name of integration app. Requires the *integration* to be included with the *include*-paramater",
            "type": "string",
            "format": "string",
            "example": "cool_wms"
          },
          "collection_entity_id": {
            "description": "Collection entity id",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "collection_name": {
            "description": "Name of collection",
            "type": "string",
            "format": "string",
            "enum": [
              "Order",
              "Lot",
              "Partner",
              "Sku"
            ],
            "example": "Order"
          },
          "created_by_id": {
            "description": "Id of the user that created the log entry",
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "example": 1234
          },
          "dev_data": {
            "description": "For internal use",
            "format": "",
            "readOnly": true,
            "example": ""
          },
          "entity_id": {
            "description": "Id of the source entity for the log entry. Name of model specified in *model_name*",
            "type": "string",
            "format": "uuid",
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "integration_id": {
            "description": "Id of the integration",
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
          },
          "log_message": {
            "description": "The message to log",
            "type": "string",
            "format": "string",
            "example": "A string"
          },
          "model_name": {
            "description": "The model name of the source entity id. See *entity_id*",
            "type": "string",
            "format": "string",
            "enum": [
              "Order",
              "OrderLotInbound",
              "OrderLotOutbound",
              "OrderServiceLine",
              "Sku",
              "Lot",
              "Partner",
              "PartnerLocation",
              "PartnerContact",
              "PartnerComment",
              "PartnerCertificate",
              "Trace"
            ],
            "example": "OrderLotInbound"
          },
          "scope": {
            "description": "Arbitrary category to quickly identify the log record",
            "type": "string",
            "format": "string",
            "example": "lot created"
          },
          "severity": {
            "description": "Serverity of the log record",
            "type": "string",
            "format": "string",
            "enum": [
              "warning",
              "error",
              "info",
              "debug"
            ],
            "example": "warning"
          },
          "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"
          }
        },
        "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 /integration-logs

Create new integration log entry

Description

Create a new integration log entry

Request body

Description

Target lot entry.

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

{
  "required": [
    "app_name",
    "log_message",
    "severity",
    "scope"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "app_name": {
      "description": "Name of integration app. Requires the *integration* to be included with the *include*-paramater",
      "type": "string",
      "format": "string",
      "example": "cool_wms"
    },
    "collection_entity_id": {
      "description": "Collection entity id",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "collection_name": {
      "description": "Name of collection",
      "type": "string",
      "format": "string",
      "enum": [
        "Order",
        "Lot",
        "Partner",
        "Sku"
      ],
      "example": "Order"
    },
    "created_by_id": {
      "description": "Id of the user that created the log entry",
      "type": "integer",
      "format": "int32",
      "readOnly": true,
      "example": 1234
    },
    "dev_data": {
      "description": "For internal use",
      "format": "",
      "readOnly": true,
      "example": ""
    },
    "entity_id": {
      "description": "Id of the source entity for the log entry. Name of model specified in *model_name*",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "integration_id": {
      "description": "Id of the integration",
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "log_message": {
      "description": "The message to log",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "model_name": {
      "description": "The model name of the source entity id. See *entity_id*",
      "type": "string",
      "format": "string",
      "enum": [
        "Order",
        "OrderLotInbound",
        "OrderLotOutbound",
        "OrderServiceLine",
        "Sku",
        "Lot",
        "Partner",
        "PartnerLocation",
        "PartnerContact",
        "PartnerComment",
        "PartnerCertificate",
        "Trace"
      ],
      "example": "OrderLotInbound"
    },
    "scope": {
      "description": "Arbitrary category to quickly identify the log record",
      "type": "string",
      "format": "string",
      "example": "lot created"
    },
    "severity": {
      "description": "Serverity of the log record",
      "type": "string",
      "format": "string",
      "enum": [
        "warning",
        "error",
        "info",
        "debug"
      ],
      "example": "warning"
    },
    "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"
    }
  },
  "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

{
  "properties": {
    "required": [
      "app_name",
      "log_message",
      "severity",
      "scope"
    ],
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "app_name": {
        "description": "Name of integration app. Requires the *integration* to be included with the *include*-paramater",
        "type": "string",
        "format": "string",
        "example": "cool_wms"
      },
      "collection_entity_id": {
        "description": "Collection entity id",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "collection_name": {
        "description": "Name of collection",
        "type": "string",
        "format": "string",
        "enum": [
          "Order",
          "Lot",
          "Partner",
          "Sku"
        ],
        "example": "Order"
      },
      "created_by_id": {
        "description": "Id of the user that created the log entry",
        "type": "integer",
        "format": "int32",
        "readOnly": true,
        "example": 1234
      },
      "dev_data": {
        "description": "For internal use",
        "format": "",
        "readOnly": true,
        "example": ""
      },
      "entity_id": {
        "description": "Id of the source entity for the log entry. Name of model specified in *model_name*",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "integration_id": {
        "description": "Id of the integration",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "log_message": {
        "description": "The message to log",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "model_name": {
        "description": "The model name of the source entity id. See *entity_id*",
        "type": "string",
        "format": "string",
        "enum": [
          "Order",
          "OrderLotInbound",
          "OrderLotOutbound",
          "OrderServiceLine",
          "Sku",
          "Lot",
          "Partner",
          "PartnerLocation",
          "PartnerContact",
          "PartnerComment",
          "PartnerCertificate",
          "Trace"
        ],
        "example": "OrderLotInbound"
      },
      "scope": {
        "description": "Arbitrary category to quickly identify the log record",
        "type": "string",
        "format": "string",
        "example": "lot created"
      },
      "severity": {
        "description": "Serverity of the log record",
        "type": "string",
        "format": "string",
        "enum": [
          "warning",
          "error",
          "info",
          "debug"
        ],
        "example": "warning"
      },
      "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"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

422

Has validation errors

500

internal server error