Skip to content

Commit 90ed091

Browse files
Felipe-Alves-SampaioFelipe-Alves-Sampaio
authored
ShippingCompany/v1/1_000 (#1170)
* Criação da api de transportadora do Backoffice RM * Adição dos campos complementares na documentação.
1 parent 819160b commit 90ed091

File tree

2 files changed

+813
-0
lines changed

2 files changed

+813
-0
lines changed

‎jsonschema/apis/ShippingCompany_1_000.json

Lines changed: 367 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,367 @@
1+
{
2+
"openapi": "3.0.1",
3+
"servers": [
4+
{
5+
"description": "API para a entidade Transportadora",
6+
"url": "{{host}}/api/mov/v1",
7+
"variables": {
8+
"serverUrl": {
9+
"default": "localhost"
10+
},
11+
"serverHttpPort": {
12+
"default": "8080"
13+
}
14+
}
15+
}
16+
],
17+
"info": {
18+
"description": "API para a entidade Transportadora",
19+
"version": "1.000",
20+
"title": "Transportadora",
21+
"contact": {
22+
"name": "T-Talk",
23+
"url": "https://api.totvs.com.br",
24+
"email": "comiteintegracao@totvs.com.br"
25+
},
26+
"x-totvs": {
27+
"messageDocumentation": {
28+
"name": "ShippingCompany",
29+
"description": "API para a entidade Transportadora",
30+
"segment": "Serviços"
31+
},
32+
"productInformation": [
33+
{
34+
"product": "RM",
35+
"contact": "squad.crm@totvs.com.br",
36+
"description": "Cadastro de Transportadoras",
37+
"adapter": "mats050.prw"
38+
}
39+
]
40+
}
41+
},
42+
"paths": {
43+
"/ShippingCompany": {
44+
"get": {
45+
"tags": ["ShippingCompany"],
46+
"summary": "Retorna lista de Transportadoras",
47+
"x-totvs": {
48+
"productInformation": [
49+
{
50+
"product": "RM",
51+
"available": true,
52+
"note": "Este verbo esta disponivel com todos os parametros",
53+
"minimalVersion": "12.1.34"
54+
}
55+
]
56+
},
57+
"description": "Retorna lista completa de Transportadoras",
58+
"operationId": "getShippingCompany",
59+
"parameters": [
60+
{
61+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
62+
},
63+
{
64+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
65+
},
66+
{
67+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
68+
},
69+
{
70+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
71+
},
72+
{
73+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
74+
}
75+
],
76+
"responses": {
77+
"200": {
78+
"description": "Operação realizada com sucesso!",
79+
"content": {
80+
"application/json": {
81+
"schema": {
82+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/PagedShippingCompany"
83+
}
84+
}
85+
}
86+
},
87+
"400": {
88+
"description": "Erro na requisição!",
89+
"content": {
90+
"application/json": {
91+
"schema": {
92+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
93+
}
94+
}
95+
}
96+
}
97+
}
98+
},
99+
"post": {
100+
"tags": ["ShippingCompany"],
101+
"summary": "Inclui uma transportadora",
102+
"description": "Inclui uma Transportadora conforme dados enviados na requisição.",
103+
"operationId": "postShippingCompany",
104+
"x-totvs": {
105+
"productInformation": [
106+
{
107+
"product": "RM",
108+
"available": true,
109+
"note": "Este verbo esta disponível com o parametro Authorization",
110+
"minimalVersion": "12.1.34"
111+
}
112+
]
113+
},
114+
"parameters": [
115+
{
116+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
117+
},
118+
{
119+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
120+
}
121+
],
122+
"requestBody": {
123+
"description": "Transportadora a ser incluída.",
124+
"content": {
125+
"application/json": {
126+
"schema": {
127+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
128+
}
129+
}
130+
}
131+
},
132+
"responses": {
133+
"201": {
134+
"description": "Operação realizada com sucesso!",
135+
"content": {
136+
"application/json": {
137+
"schema": {
138+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
139+
}
140+
}
141+
}
142+
},
143+
"400": {
144+
"description": "Erro durante inclusão da Transportadora!",
145+
"content": {
146+
"application/json": {
147+
"schema": {
148+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
149+
}
150+
}
151+
}
152+
}
153+
}
154+
}
155+
},
156+
"/ShippingCompany/{InternalId}": {
157+
"get": {
158+
"tags": ["InternalId"],
159+
"summary": "Retorna a Transportadora pelo seu Internal Id",
160+
"description": "Retorna a Transportadora conforme dados enviados na requisição",
161+
"operationId": "getInternalId",
162+
"x-totvs": {
163+
"productInformation": [
164+
{
165+
"product": "RM",
166+
"available": true,
167+
"note": "Este verbo esta disponivel com todos os parametros",
168+
"minimalVersion": "12.1.34"
169+
}
170+
]
171+
},
172+
"parameters": [
173+
{
174+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
175+
},
176+
{
177+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order"
178+
},
179+
{
180+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page"
181+
},
182+
{
183+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize"
184+
},
185+
{
186+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
187+
},
188+
{
189+
"$ref": "#/components/parameters/InternalId"
190+
}
191+
],
192+
"responses": {
193+
"200": {
194+
"description": "Operação realizada com sucesso!",
195+
"content": {
196+
"application/json": {
197+
"schema": {
198+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
199+
}
200+
}
201+
}
202+
},
203+
"404": {
204+
"description": "Transportadora não localizada!",
205+
"content": {
206+
"application/json": {
207+
"schema": {
208+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
209+
}
210+
}
211+
}
212+
}
213+
}
214+
},
215+
"put": {
216+
"tags": ["InternalId"],
217+
"summary": "Altera uma transportadora",
218+
"description": "Atualiza cadastro de Transportadoras conforme dados enviados na requisição",
219+
"operationId": "putInternalId",
220+
"x-totvs": {
221+
"productInformation": [
222+
{
223+
"product": "RM",
224+
"available": true,
225+
"note": "Este verbo esta disponivel com todos os parametros",
226+
"minimalVersion": "12.1.34"
227+
}
228+
]
229+
},
230+
"parameters": [
231+
{
232+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
233+
},
234+
{
235+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields"
236+
},
237+
{
238+
"$ref": "#/components/parameters/InternalId"
239+
}
240+
],
241+
"requestBody": {
242+
"description": "Transportadora a ser atualizada.",
243+
"content": {
244+
"application/json": {
245+
"schema": {
246+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
247+
}
248+
}
249+
}
250+
},
251+
"responses": {
252+
"200": {
253+
"description": "Operação realizada com sucesso!",
254+
"content": {
255+
"application/json": {
256+
"schema": {
257+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
258+
}
259+
}
260+
}
261+
},
262+
"400": {
263+
"description": "Erro durante a alteração da Transportadora!",
264+
"content": {
265+
"application/json": {
266+
"schema": {
267+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
268+
}
269+
}
270+
}
271+
},
272+
"404": {
273+
"description": "Transportadora não localizada!",
274+
"content": {
275+
"application/json": {
276+
"schema": {
277+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
278+
}
279+
}
280+
}
281+
}
282+
}
283+
},
284+
"delete": {
285+
"tags": ["InternalId"],
286+
"summary": "Exclui uma transportadora",
287+
"description": "Exclui cadastro de Transportadora conforme dados enviados na requisição.",
288+
"operationId": "deleteInternalId",
289+
"x-totvs": {
290+
"productInformation": [
291+
{
292+
"product": "RM",
293+
"available": true,
294+
"note": "Este verbo esta disponível com os parâmetros Authorization e InternalId",
295+
"minimalVersion": "12.1.21"
296+
}
297+
]
298+
},
299+
"parameters": [
300+
{
301+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization"
302+
},
303+
{
304+
"$ref": "#/components/parameters/InternalId"
305+
}
306+
],
307+
"responses": {
308+
"200": {
309+
"description": "Operação realizada com sucesso!",
310+
"content": {
311+
"application/json": {
312+
"schema": {
313+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/ShippingCompany_1_000.json#/definitions/ShippingCompanyInfo"
314+
}
315+
}
316+
}
317+
},
318+
"400": {
319+
"description": "Erro durante a exclusão da transportadora!",
320+
"content": {
321+
"application/json": {
322+
"schema": {
323+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
324+
}
325+
}
326+
}
327+
},
328+
"404": {
329+
"description": "Transportadora não localizada!",
330+
"content": {
331+
"application/json": {
332+
"schema": {
333+
"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel"
334+
}
335+
}
336+
}
337+
}
338+
}
339+
}
340+
}
341+
},
342+
"components": {
343+
"parameters": {
344+
"InternalId": {
345+
"name": "InternalId",
346+
"in": "path",
347+
"required": true,
348+
"description": "Identificador único da Transportadora",
349+
"example": "1|00001",
350+
"schema": {
351+
"type": "string"
352+
},
353+
"x-totvs": {
354+
"productInformation": [
355+
{
356+
"product": "RM",
357+
"available": true,
358+
"note": "Informar os campos Código da coligada e Código da transportadora.",
359+
"minimalVersion": "12.1.34"
360+
}
361+
]
362+
}
363+
}
364+
},
365+
"schemas": {}
366+
}
367+
}

0 commit comments

Comments
 (0)