@things-factory/operato-hub 4.3.103 → 4.3.104

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/openapi/v1/authetication.yaml +108 -0
  2. package/openapi/v1/bizplace.yaml +74 -0
  3. package/openapi/v1/contact-point.yaml +258 -89
  4. package/openapi/v1/inbound.yaml +626 -304
  5. package/openapi/v1/inventory.yaml +211 -179
  6. package/openapi/v1/marketplace.yaml +843 -0
  7. package/openapi/v1/outbound.yaml +1311 -569
  8. package/openapi/v1/partner.yaml +80 -0
  9. package/openapi/v1/product.yaml +507 -175
  10. package/openapi/v1.yaml +39 -7
  11. package/package.json +3 -3
  12. package/openapi/v1/ecommerce.yaml +0 -549
package/openapi/v1/authetication.yaml ADDED
@@ -0,0 +1,108 @@
1
+ definitions:
2
+ # AccessToken
3
+ AccessToken:
4
+ type: 'object'
5
+ properties:
6
+ data:
7
+ type: 'object'
8
+ properties:
9
+ accessToken:
10
+ type: 'string'
11
+ example: 'newAccessToken'
12
+ refreshToken:
13
+ type: 'string'
14
+ example: 'newRefreshToken'
15
+ expires_in:
16
+ type: 'datetime'
17
+ exmale: ''
18
+ token_type:
19
+ type: 'string'
20
+ example: 'bearer'
21
+ center_id:
22
+ type: 'string'
23
+ example: ''
24
+
25
+ xml:
26
+ name: 'Token'
27
+
28
+ # RefreshToken
29
+ RefreshToken:
30
+ type: 'object'
31
+ properties:
32
+ data:
33
+ type: 'object'
34
+ properties:
35
+ accessToken:
36
+ type: 'string'
37
+ example: 'newAccessToken'
38
+ refreshToken:
39
+ type: 'string'
40
+ example: 'newRefreshToken'
41
+ xml:
42
+ name: 'RefreshToken'
43
+
44
+ paths:
45
+ # access-token
46
+ /access-token :
47
+ post:
48
+ tags:
49
+ - 'Authentication'
50
+ #replace the image here
51
+ summary: 'Access Token.'
52
+ description: '
53
+ ![Operato Auth 2.0](https://thumbs.dreamstime.com/b/example-red-tag-example-red-square-price-tag-117502755.jpg)
54
+ <br><br>
55
+ **How to Refresh Token :**
56
+ <br>
57
+ 1. Store refresh token in the system.
58
+ 2. Use refresh token to get the access token for every 28 days.
59
+ 3. For every refresh, user will get a new access token, and the expiry date of the access token.
60
+ 4. Once the refresh token expires, user is expected to execute the authorization process.
61
+ <br>
62
+ <br> Auth URL : <https://operatohub.com/oauth/authorize>
63
+ <br> Access Token URL : <https://operatohub.com/oauth/access-token>
64
+ <br> Video Tutorial : <https://drive.google.com/file/d/1s66WKqi35xYvucQUrKZhRcp5so5h5H8h/view>
65
+ <br><br><br>
66
+ `accessToken`, `refreshToken`, `expires_in`, `token_type`, `centerId` will be provided by going through this API
67
+ '
68
+ links: https://operatohub.com/oauth/authorize
69
+ operationId: 'accessToken'
70
+ responses:
71
+ '200':
72
+ description: 'success'
73
+ content:
74
+ application/json:
75
+ schema:
76
+ type: 'array'
77
+ items:
78
+ $ref: '#/definitions/AccessToken'
79
+
80
+ # refresh-token
81
+ /refresh-token :
82
+ post:
83
+ tags:
84
+ - 'Authentication'
85
+ summary: 'Refresh Token.'
86
+ description: 'Refresh token expiration period 1 year. Access token expiration period 30 days. Application has to make a refresh token call within 30 days to prevent any unexpected reject calls.'
87
+ operationId: 'refreshToken'
88
+ produces:
89
+ - 'application/json'
90
+ parameters:
91
+ - in: 'body'
92
+ name: 'body'
93
+ required: true
94
+ schema:
95
+ type: 'object'
96
+ properties:
97
+ refreshToken:
98
+ type: 'string'
99
+ example: 'samplesample'
100
+ responses:
101
+ '200':
102
+ description: 'success'
103
+ content:
104
+ application/json:
105
+ schema:
106
+ type: 'array'
107
+ items:
108
+ $ref: '#/definitions/RefreshToken'
package/openapi/v1/bizplace.yaml ADDED
@@ -0,0 +1,74 @@
1
+ definitions:
2
+ Bizplace:
3
+ type: 'object'
4
+ properties:
5
+ data:
6
+ type: 'array'
7
+ items:
8
+ type: 'object'
9
+ properties:
10
+ bizplace:
11
+ type: 'object'
12
+ properties:
13
+ id:
14
+ type: 'string'
15
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
16
+ name:
17
+ type: 'string'
18
+ example: 'XYZ'
19
+ description:
20
+ type: 'string'
21
+ example: 'XYZ'
22
+ address:
23
+ type: 'string'
24
+ example: 'xxxxxx'
25
+ postalCode:
26
+ type: 'string'
27
+ example: 'xxxxx'
28
+ extType:
29
+ type: 'string'
30
+ example: 'warehouse'
31
+ limit:
32
+ type: 'integer'
33
+ example: 1
34
+ offset:
35
+ type: 'integer'
36
+ example: 3
37
+ totalCount:
38
+ type: 'integer'
39
+ example: 76
40
+ xml:
41
+ name: 'Bizplace'
42
+
43
+ paths:
44
+ #get-bizlace-list
45
+ api/v1/company/get-bizplace-list:
46
+ get:
47
+ tags:
48
+ - 'Bizplace'
49
+ summary: 'Get list of bizplaces for that company.'
50
+ description: 'Get list of bizplaces for that company.'
51
+ operationId: 'getBizplaceList'
52
+ consumes:
53
+ - 'application/json'
54
+ produces:
55
+ - 'application/json'
56
+ parameters:
57
+ - in: 'query'
58
+ name: 'limit'
59
+ type: 'integer'
60
+ default: 50
61
+ max: 100
62
+ - in: 'query'
63
+ name: 'offset'
64
+ type: 'integer'
65
+ default: 0
66
+ responses:
67
+ '200':
68
+ description: 'successful operation'
69
+ content:
70
+ application/json:
71
+ schema:
72
+ type: 'array'
73
+ items:
74
+ $ref: '#/definitions/Bizplace'
package/openapi/v1/contact-point.yaml CHANGED
@@ -1,106 +1,284 @@
1
1
  definitions:
2
- ContactPoint:
2
+ # AddContactPointList
3
+ AddContactPoint:
3
4
  type: 'object'
4
5
  properties:
5
- name:
6
- type: 'string'
7
- example: 'ABC Trading Sdn Bhd'
8
- companyName:
9
- type: 'string'
10
- example: 'ABC Trading Sdn Bhd'
11
- email:
12
- type: 'string'
13
- example: 'abc@hatio.my'
14
- fax:
15
- type: 'string'
16
- phone:
17
- type: 'string'
18
- example: '011-11020304'
19
- accountNo:
20
- type: 'string'
21
- address:
22
- type: 'string'
23
- address2:
24
- type: 'string'
25
- city:
26
- type: 'string'
27
- postCode:
28
- type: 'string'
29
- type:
30
- type: 'string'
31
- enum:
32
- - 'WAREHOUSE'
33
- - 'SUPPLIER'
34
- - 'CUSTOMER'
6
+ data:
7
+ type: 'array'
8
+ items:
9
+ type: 'object'
10
+ properties:
11
+ name:
12
+ type: 'string'
13
+ required: true
14
+ example: 'ABC Trading Sdn Bhd'
15
+ description:
16
+ type: 'string'
17
+ example: 'desc'
18
+ companyName:
19
+ type: 'string'
20
+ example: 'ABC Trading Sdn Bhd'
21
+ email:
22
+ type: 'string'
23
+ required: true
24
+ example: 'abc@hatio.my'
25
+ fax:
26
+ type: 'string'
27
+ example: 'true'
28
+ phone:
29
+ type: 'string'
30
+ required: true
31
+ example: '011-11020304'
32
+ billingAddress:
33
+ type: 'string'
34
+ example: 'address'
35
+ accountNo:
36
+ type: 'string'
37
+ example: 'string'
38
+ address:
39
+ type: 'string'
40
+ required: true
41
+ example: 'string'
42
+ address2:
43
+ type: 'string'
44
+ example: 'string'
45
+ city:
46
+ type: 'string'
47
+ example: 'string'
48
+ state:
49
+ type: 'string'
50
+ example: 'string'
51
+ postCode:
52
+ type: 'string'
53
+ required: true
54
+ example: 'string'
55
+ type:
56
+ type: 'string'
57
+ required: true
58
+ enum:
59
+ - 'WAREHOUSE'
60
+ - 'SUPPLIER'
61
+ - 'CUSTOMER'
62
+ createdAt:
63
+ type: 'datetime'
64
+ example: '2022-08-17 04:47:14.228'
65
+ updatedAt:
66
+ type: 'datetime'
67
+ example: '2022-08-17 04:47:14.228'
68
+ domain:
69
+ type: 'object'
70
+ properties:
71
+ name:
72
+ type: 'string'
73
+ example: 'some name'
74
+ bizplace:
75
+ type: 'object'
76
+ properties:
77
+ name:
78
+ type: 'string'
79
+ example: 'some name 2'
80
+ creator:
81
+ type: 'object'
82
+ properties:
83
+ name:
84
+ type: 'string'
85
+ example: 'some name'
86
+ updater:
87
+ type: 'object'
88
+ properties:
89
+ name:
90
+ type: 'string'
91
+ example: 'updater name'
35
92
  xml:
36
- name: 'ContactPoint'
93
+ name: 'AddContactPoint'
94
+
95
+ # GetContactPointList
96
+ GetContactPointList:
97
+ type: 'object'
98
+ properties:
99
+ data:
100
+ type: 'array'
101
+ items:
102
+ type: 'object'
103
+ properties:
104
+ bizplace:
105
+ type: 'object'
106
+ properties:
107
+ id:
108
+ type: 'string'
109
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
110
+ name:
111
+ type: 'string'
112
+ example: 'XYZ'
113
+ name:
114
+ type: 'string'
115
+ example: 'ABC Trading Sdn Bhd'
116
+ companyName:
117
+ type: 'string'
118
+ example: 'ABC Trading Sdn Bhd'
119
+ email:
120
+ type: 'string'
121
+ example: 'abc@hatio.my'
122
+ fax:
123
+ type: 'string'
124
+ example: 'true'
125
+ phone:
126
+ type: 'string'
127
+ example: '011-11020304'
128
+ accountNo:
129
+ type: 'string'
130
+ example: 'string'
131
+ address:
132
+ type: 'string'
133
+ example: 'string'
134
+ address2:
135
+ type: 'string'
136
+ example: 'string'
137
+ city:
138
+ type: 'string'
139
+ example: 'string'
140
+ postCode:
141
+ type: 'string'
142
+ example: 'string'
143
+ type:
144
+ type: 'string'
145
+ enum:
146
+ - 'WAREHOUSE'
147
+ - 'SUPPLIER'
148
+ - 'CUSTOMER'
149
+ totalCount:
150
+ type: 'integer'
151
+ example: 1
152
+ limit:
153
+ type: 'integer'
154
+ example: 100
155
+ offset:
156
+ type: 'integer'
157
+ example: 0
158
+ xml:
159
+ name: 'GetContactPointList'
160
+
37
161
  paths:
38
- /warehouse/{warehouseId}/get-contact-point-list:
162
+ # add-contact-point
163
+ /api/v1/company/add-contact-points:
164
+ post:
165
+ tags:
166
+ - 'Contact Point'
167
+ summary: 'Add Contact Point(s).'
168
+ description: 'Add multiple contact point. (From Scope we should be able to determine this is for which company, from here API has to specify this is for which bizplace within the company to add).'
169
+ operationId: 'addContactPoint'
170
+ produces:
171
+ - 'application/json'
172
+ parameters:
173
+ - in: 'body'
174
+ name: 'body'
175
+ schema:
176
+ type: 'object'
177
+ properties:
178
+ bizplaceId:
179
+ type: 'string'
180
+ required: true
181
+ example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
182
+ data:
183
+ type: 'array'
184
+ items:
185
+ type: 'object'
186
+ properties:
187
+ name:
188
+ type: 'string'
189
+ required: true
190
+ example: 'ABC Trading Sdn Bhd'
191
+ description:
192
+ type: 'string'
193
+ example: 'desc'
194
+ companyName:
195
+ type: 'string'
196
+ example: 'ABC Trading Sdn Bhd'
197
+ email:
198
+ type: 'string'
199
+ required: true
200
+ example: 'abc@hatio.my'
201
+ fax:
202
+ type: 'string'
203
+ example: 'string'
204
+ phone:
205
+ type: 'string'
206
+ required: true
207
+ example: '011-11020304'
208
+ billingAddress:
209
+ type: 'string'
210
+ example: 'address'
211
+ accountNo:
212
+ type: 'string'
213
+ example: 'string'
214
+ address:
215
+ type: 'string'
216
+ required: true
217
+ example: 'string'
218
+ address2:
219
+ type: 'string'
220
+ example: 'string'
221
+ city:
222
+ type: 'string'
223
+ example: 'string'
224
+ state:
225
+ type: 'string'
226
+ example: 'string'
227
+ postCode:
228
+ type: 'string'
229
+ example: 'string'
230
+ type:
231
+ type: 'string'
232
+ required: true
233
+ enum:
234
+ - 'WAREHOUSE'
235
+ - 'SUPPLIER'
236
+ - 'CUSTOMER'
237
+ responses:
238
+ '200':
239
+ description: 'success'
240
+ content:
241
+ application/json:
242
+ schema:
243
+ type: 'array'
244
+ items:
245
+ $ref: '#/definitions/AddContactPoint'
246
+ # get-contact-point-list
247
+ /api/v1/company/get-contact-point-list:
39
248
  get:
40
249
  tags:
41
- - 'contactPoint'
42
- description: 'Use this API to get contact points in WMS.'
43
- operationId: 'getContactPointList'
250
+ - 'Contact Point'
251
+ summary: 'Get list of Contact Point(s).'
252
+ description: 'get list of contact point. Specify bizplace that is within this company.'
253
+ operationId: 'getContactPoint'
254
+ consumes:
255
+ - 'application/json'
44
256
  produces:
45
257
  - 'application/json'
46
258
  parameters:
47
- - in: 'path'
48
- name: 'warehouseId'
49
- required: true
259
+ - in: 'query'
260
+ name: 'bizplaceId'
50
261
  type: 'string'
262
+ description: 'Required to specify the bizplace to search.'
263
+ required: true
51
264
  - in: 'query'
52
265
  name: 'companyName'
53
- required: false
54
266
  type: 'string'
55
267
  - in: 'query'
56
268
  name: 'name'
57
- required: false
58
269
  type: 'string'
59
270
  - in: 'query'
60
271
  name: 'email'
61
- required: false
62
272
  type: 'string'
63
273
  - in: 'query'
64
- name: 'paginationEntriesPerPage'
65
- description: 'This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.'
274
+ name: 'limit'
66
275
  type: 'integer'
67
- format: 'uint32'
276
+ default: 100
277
+ max: 100
68
278
  - in: 'query'
69
- name: 'paginationOffset'
70
- description: 'Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.'
279
+ name: 'offset'
71
280
  type: 'integer'
72
- format: 'uint32'
73
- responses:
74
- '200':
75
- description: 'successful operation'
76
- content:
77
- application/json:
78
- schema:
79
- type: 'array'
80
- items:
81
- $ref: '#/definitions/ContactPoint'
82
- '400':
83
- description: 'Bad request is sent'
84
- '401':
85
- description: 'Authentication Error'
86
- '404':
87
- description: 'Resource not found'
88
- '500':
89
- description: 'Server error'
90
- deprecated: false
91
- /warehouse/{warehouseId}/add-contact-point:
92
- post:
93
- tags:
94
- - 'contactPoint'
95
- description: 'Use this API to create new contact points in WMS.'
96
- operationId: 'addContactPoint'
97
- produces:
98
- - 'application/json'
99
- parameters:
100
- - in: 'path'
101
- name: 'warehouseId'
102
- required: true
103
- type: 'string'
281
+ default: 0
104
282
  responses:
105
283
  '200':
106
284
  description: 'successful operation'
@@ -109,13 +287,4 @@ paths:
109
287
  schema:
110
288
  type: 'array'
111
289
  items:
112
- $ref: '#/definitions/ContactPoint'
113
- '400':
114
- description: 'Bad request is sent'
115
- '401':
116
- description: 'Authentication Error'
117
- '404':
118
- description: 'Resource not found'
119
- '500':
120
- description: 'Server error'
121
- deprecated: false
290
+ $ref: '#/definitions/GetContactPointList'