@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/inventory.yaml CHANGED
@@ -1,167 +1,215 @@
1
1
  definitions:
2
- Inventory:
2
+ # GetOnhandInventoryList
3
+ GetOnhandInventoryList:
3
4
  type: 'object'
4
5
  properties:
5
- id:
6
+ data:
7
+ type: 'array'
8
+ items:
9
+ type: 'object'
10
+ properties:
11
+ id:
12
+ type: 'string'
13
+ example: 'b60feaf2-1940-40cd-9c53-9e9ac072049d'
14
+ name:
15
+ type: 'string'
16
+ example: 'string'
17
+ palletId:
18
+ type: 'string'
19
+ example: 'string'
20
+ cartonId:
21
+ type: 'string'
22
+ example: 'string'
23
+ batchId:
24
+ type: 'string'
25
+ example: 'string'
26
+ packingType:
27
+ type: 'string'
28
+ example: 'string'
29
+ packingSize:
30
+ type: 'string'
31
+ example: 'string'
32
+ qty:
33
+ type: 'integer'
34
+ example: 0
35
+ expirationDate:
36
+ type: 'date'
37
+ example: ' '
38
+ weight:
39
+ type: 'integer'
40
+ format: 'double'
41
+ example: 0
42
+ lastSeq:
43
+ type: 'integer'
44
+ format: 'double'
45
+ example: 0
46
+ status:
47
+ type: 'string'
48
+ example: 'STORED'
49
+ product:
50
+ type: 'object'
51
+ properties:
52
+ sku:
53
+ type: 'string'
54
+ example: 'LB-18'
55
+ name:
56
+ type: 'string'
57
+ example: '50PCS PLASTIC LUNCH BOX'
58
+ description:
59
+ type: 'string'
60
+ example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
61
+ type:
62
+ type: 'string'
63
+ example: 'PLASTIC'
64
+ weightUnit:
65
+ type: 'string'
66
+ example: 'kg'
67
+ weight:
68
+ type: 'integer'
69
+ format: 'double'
70
+ example: 20.5
71
+ lengthUnit:
72
+ type: 'string'
73
+ example: 'cm'
74
+ width:
75
+ type: 'integer'
76
+ format: 'double'
77
+ example: 10.5
78
+ depth:
79
+ type: 'integer'
80
+ format: 'double'
81
+ example: 5
82
+ height:
83
+ type: 'integer'
84
+ format: 'double'
85
+ example: 6
86
+ location:
87
+ type: 'object'
88
+ properties:
89
+ name:
90
+ type: 'string'
91
+ example: '01-01-01-A'
92
+ type:
93
+ type: 'string'
94
+ example: 'SHELF'
95
+ zone:
96
+ type: 'string'
97
+ example: '05'
98
+ totalCount:
6
99
  type: 'integer'
7
- format: 'int64'
8
- name:
9
- type: 'string'
10
- palletId:
11
- type: 'string'
12
- cartonId:
13
- type: 'string'
14
- batchId:
15
- type: 'string'
16
- packingType:
17
- type: 'string'
18
- packingSize:
19
- type: 'string'
20
- zone:
21
- type: 'string'
22
- example: '05'
23
- description: 'zone location'
24
- qty:
100
+ example: 35
101
+ limit:
25
102
  type: 'integer'
26
- expirationDate:
27
- type: 'date'
28
- weight:
103
+ example: 100
104
+ offset:
29
105
  type: 'integer'
30
- format: 'float'
31
- lastSeq:
32
- type: 'integer'
33
- status:
34
- type: 'string'
35
- enum:
36
- - 'STORED'
37
- - 'TERMINATED'
38
- product:
39
- type: 'object'
40
- properties:
41
- sku:
42
- type: 'string'
43
- example: 'LB-18'
44
- description: 'value should be unique for all variations'
45
- name:
46
- type: 'string'
47
- example: '50PCS PLASTIC LUNCH BOX'
48
- description:
49
- type: 'string'
50
- example: 'Lid 5 Compartments HIRO Sekat Disposable Paper Recyclable biodegradable Microwavable'
51
- type:
52
- type: 'string'
53
- example: 'PLASTIC'
54
- packingType:
55
- type: 'string'
56
- example: 'CARTON'
57
- weightUnit:
58
- type: 'string'
59
- example: 'kg'
60
- weight:
61
- type: 'integer'
62
- format: 'double'
63
- example: '20.5'
64
- lengthUnit:
65
- type: 'string'
66
- example: 'cm'
67
- width:
68
- type: 'integer'
69
- format: 'double'
70
- example: '10.5'
71
- depth:
72
- type: 'integer'
73
- format: 'double'
74
- example: '5'
75
- height:
76
- type: 'integer'
77
- format: 'double'
78
- example: '6'
79
- location:
80
- type: 'object'
81
- properties:
82
- name:
83
- type: 'string'
84
- example: '01-01-01-A'
85
- type:
86
- type: 'string'
87
- example: 'SHELF'
106
+ example: 0
88
107
  xml:
89
- name: 'Inventory'
90
- InventoryProductGroup:
108
+ name: 'GetOnhandInventoryList'
109
+
110
+ # GetInventoryProductGroupList
111
+ GetInventoryProductGroupList:
91
112
  type: 'object'
92
113
  properties:
93
- batchId:
94
- type: 'string'
95
- packingType:
96
- type: 'string'
97
- packingSize:
98
- type: 'string'
99
- qty:
114
+ data:
115
+ type: 'array'
116
+ items:
117
+ type: 'object'
118
+ properties:
119
+ product:
120
+ type: 'object'
121
+ properties:
122
+ sku:
123
+ type: 'string'
124
+ example: 'LB-18'
125
+ name:
126
+ type: 'string'
127
+ example: 'LB-18'
128
+ description:
129
+ type: 'string'
130
+ example: 'LB-18'
131
+ type:
132
+ type: 'string'
133
+ example: 'SINGLE '
134
+ batchId:
135
+ type: 'string'
136
+ example: 'string'
137
+ packingType:
138
+ type: 'string'
139
+ example: 'string'
140
+ packingSize:
141
+ type: 'integer'
142
+ format: 'double'
143
+ example: 24
144
+ qty:
145
+ type: 'integer'
146
+ example: 0
147
+ uomValue:
148
+ type: 'integer'
149
+ format: 'double'
150
+ example: 0
151
+ uom:
152
+ type: 'string'
153
+ example: 'UNIT'
154
+ averageUnitCost:
155
+ type: 'integer'
156
+ format: 'double'
157
+ example: 24
158
+ totalCount:
159
+ type: 'integer'
160
+ example: 35
161
+ limit:
162
+ type: 'integer'
163
+ example: 100
164
+ offset:
100
165
  type: 'integer'
101
- averageUnitCost:
102
- type: 'float'
103
- example: 24
104
- product:
105
- type: 'object'
106
- properties:
107
- productSku:
108
- type: 'string'
109
- example: 'LB-18'
110
- description: 'value should be unique for all variations'
111
- batchId:
112
- type: 'string'
113
- type:
114
- type: 'string'
115
- example: 'PLASTIC'
116
- packingType:
117
- type: 'string'
118
- example: 'CARTON'
119
- packingSize:
120
- type: 'integer'
121
- example: 24
122
- remainQty:
123
- type: 'float'
124
- example: 24
125
- remainUomValue:
126
- type: 'float'
127
- example: 24
128
- uom:
129
- type: 'string'
130
- example: 'UNIT'
166
+ example: 0
131
167
  xml:
132
- name: 'InventoryProductGroup'
168
+ name: 'GetInventoryProductGroupList'
169
+
133
170
  paths:
134
- /warehouse/{warehouseId}/onhand-inventories:
171
+ # get-onhand-inventory-list
172
+ api/v1/warehouse/get-onhand-inventory-list:
135
173
  get:
136
174
  tags:
137
- - 'inventory'
138
- description: 'Use this API to get current onhand inventories from a specific company.'
139
- operationId: 'onhandInventories'
175
+ - 'Inventory'
176
+ summary: 'Get onhand inventory list.'
177
+ description: 'Get Onhand Inventory List.'
178
+ operationId: 'getOnhandInventoryList'
179
+ consumes:
180
+ - 'application/json'
140
181
  produces:
141
182
  - 'application/json'
142
183
  parameters:
143
- - in: 'path'
144
- name: 'warehouseId'
145
- required: true
184
+ - in: 'query'
185
+ name: 'bizplaceId'
146
186
  type: 'string'
147
- - name: 'skuId'
148
- in: 'query'
149
187
  required: true
188
+ - in: 'query'
189
+ name: 'sku'
150
190
  type: 'string'
151
- - name: 'batchId'
152
- in: 'query'
153
- required: true
191
+ - in: 'query'
192
+ name: 'batchId'
193
+ type: 'string'
194
+ - in: 'query'
195
+ name: 'fromDate'
196
+ type: 'string'
197
+ description: '(Must use in conjunction with “toDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
198
+ default: '7 days before current datetime.'
199
+ - in: 'query'
200
+ name: 'toDate'
154
201
  type: 'string'
202
+ description: '(Must use in conjunction with “fromDate”) ISO 8601 format in UTC time eg: 2022-07-25T03:40:04Z'
203
+ default: 'Current datetime.'
155
204
  - in: 'query'
156
- name: 'paginationEntriesPerPage'
157
- 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.'
205
+ name: 'limit'
158
206
  type: 'integer'
159
- format: 'uint32'
207
+ default: 100
208
+ max: 100
160
209
  - in: 'query'
161
- name: 'paginationOffset'
162
- 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.'
210
+ name: 'offset'
163
211
  type: 'integer'
164
- format: 'uint32'
212
+ default: 0
165
213
  responses:
166
214
  '200':
167
215
  description: 'successful operation'
@@ -170,62 +218,46 @@ paths:
170
218
  schema:
171
219
  type: 'array'
172
220
  items:
173
- $ref: '#/definitions/Inventory'
174
- '400':
175
- description: 'Bad request is sent'
176
- '401':
177
- description: 'Authentication Error'
178
- '404':
179
- description: 'Resource not found'
180
- '500':
181
- description: 'Server error'
182
- deprecated: false
183
- /warehouse/{warehouseId}/get-inventory-product-group:
221
+ $ref: '#/definitions/GetOnhandInventoryList'
222
+
223
+ # get-inventory-product-group-list
224
+ api/v1/warehouse/get-inventory-product-group-list:
184
225
  get:
185
226
  tags:
186
- - 'inventory'
187
- description: 'Use this API to get current inventories by product group from a specific company.'
188
- operationId: 'getInventoryProductGroup'
227
+ - 'Inventory'
228
+ summary: 'Get inventory product group list.'
229
+ description: 'Get Inventory Product Group List.'
230
+ operationId: 'getInventoryProductGroupList'
231
+ consumes:
232
+ - 'application/json'
189
233
  produces:
190
234
  - 'application/json'
191
235
  parameters:
192
- - in: 'path'
193
- name: 'warehouseId'
194
- required: true
236
+ - in: 'query'
237
+ name: 'bizplaceId'
195
238
  type: 'string'
196
- - name: 'skuId'
197
- in: 'query'
198
- required: false
239
+ required: true
240
+ - in: 'query'
241
+ name: 'sku'
199
242
  type: 'string'
200
- - name: 'batchId'
201
- in: 'query'
202
- required: false
243
+ - in: 'query'
244
+ name: 'batchId'
203
245
  type: 'string'
204
246
  - in: 'query'
205
- name: 'paginationEntriesPerPage'
206
- 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.'
247
+ name: 'limit'
207
248
  type: 'integer'
208
- format: 'uint32'
249
+ default: 100
250
+ max: 100
209
251
  - in: 'query'
210
- name: 'paginationOffset'
211
- 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.'
252
+ name: 'offset'
212
253
  type: 'integer'
213
- format: 'uint32'
254
+ default: 0
214
255
  responses:
215
256
  '200':
216
- description: 'Successful Operation'
257
+ description: 'successful operation'
217
258
  content:
218
259
  application/json:
219
260
  schema:
220
261
  type: 'array'
221
262
  items:
222
- $ref: '#/definitions/InventoryProductGroup'
223
- '400':
224
- description: 'Bad request is sent'
225
- '401':
226
- description: 'Authentication Error'
227
- '404':
228
- description: 'Resource not found'
229
- '500':
230
- description: 'Server error'
231
- deprecated: false
263
+ $ref: '#/definitions/GetInventoryProductGroupList'