{ "item": [ { "id": "51dcf177-56cd-4b80-b041-897614e90912", "name": "Agendamento de Recebimento", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4981a80e-912a-40fa-acc1-68610268a3d1", "name": "Lista agendamentos de recebimento", "request": { "name": "Lista agendamentos de recebimento", "description": { "content": "Lista os agendamentos da empresa, ordenados por `StartTime` ascendente. Cada item traz cabeçalho (`StartTime`, `EndTime`, `ScheduleTitle`, `Comments`, `IDPurchase`) **e** dados resolvidos do recebimento amarrado (quando houver):\n\n- Fornecedor: `SupplierCpfCnpj`, `SupplierNameCorporateName`.\n- Nota fiscal: `serie`, `nNF`, `dhEmi` (emissão), `qVol` (volumes), `pesoB` (peso bruto, exposto como `Weight`).\n- Recebimento: `CheckinTimestamp`, `StatusPurchase`, `IDStatusPurchase`.\n- Agregados calculados: `ItemsQuantity` (soma de quantidades em `StockKeepingUnitMovement`) e `SkuQuantity` (SKUs distintos no recebimento).\n- `StockKeepingUnitPurchaseScheduleStatus` (`1`-`4`) + `StockKeepingUnitPurchaseScheduleStatusDescription` (`Recebido`, `Agendado`, `Atrasado`, `Não agendado`) — derivado de `CheckinTimestamp` e `EndTime` em relação ao momento atual: `Recebido` quando há check-in, `Agendado` quando o `EndTime` ainda não passou, `Atrasado` quando passou sem check-in, `Não agendado` quando não há recebimento amarrado.", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitPurchaseSchedule", "value": "2232", "description": "Filtra pelo identificador do agendamento de compra do SKU." }, { "disabled": false, "key": "IDPurchase", "value": "2232", "description": "Filtra pelo identificador da compra." }, { "disabled": false, "key": "StartTime", "value": "1980-02-08", "description": "Filtra agendamentos com `StartTime` a partir desta data (inclusive)." }, { "disabled": false, "key": "EndTime", "value": "1980-02-08", "description": "Filtra agendamentos com `EndTime` até o final desta data (inclusive)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d54d4b11-755d-4855-b4bd-1a60ddeb1631", "name": "Lista de agendamentos.", "originalRequest": { "url": { "path": [ "purchase", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitPurchaseSchedule", "value": "2232" }, { "key": "IDPurchase", "value": "2232" }, { "key": "StartTime", "value": "1980-02-08" }, { "key": "EndTime", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseSchedule\": 3911,\n \"IDCompany\": 3413,\n \"RecordTimestamp\": \"2004-12-11T21:03:45.378Z\",\n \"StartTime\": \"1974-03-22T00:27:34.319Z\",\n \"EndTime\": \"1980-04-04T21:06:45.795Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 4445,\n \"IDSupplier\": 9533,\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"serie\": \"string\",\n \"nNF\": \"string\",\n \"dhEmi\": \"1955-07-09T11:01:42.632Z\",\n \"qVol\": 5916.883914259932,\n \"Weight\": 3861.3731941636997,\n \"ItemsQuantity\": 4436.91091801681,\n \"SkuQuantity\": 7879,\n \"CheckinTimestamp\": \"1979-11-26T15:51:19.852Z\",\n \"IDStatusPurchase\": 1485,\n \"StatusPurchase\": \"string\",\n \"StockKeepingUnitPurchaseScheduleStatus\": 1,\n \"StockKeepingUnitPurchaseScheduleStatusDescription\": \"Atrasado\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseSchedule\": 9554,\n \"IDCompany\": 8284,\n \"RecordTimestamp\": \"1974-03-16T00:47:39.274Z\",\n \"StartTime\": \"2014-03-14T13:49:28.497Z\",\n \"EndTime\": \"1994-06-18T04:34:34.022Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 6530,\n \"IDSupplier\": 9712,\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"serie\": \"string\",\n \"nNF\": \"string\",\n \"dhEmi\": \"1999-11-01T22:49:37.421Z\",\n \"qVol\": 4590.904931748372,\n \"Weight\": 6512.174246166403,\n \"ItemsQuantity\": 4624.841011718539,\n \"SkuQuantity\": 3893,\n \"CheckinTimestamp\": \"1953-01-02T23:59:22.662Z\",\n \"IDStatusPurchase\": 1597,\n \"StatusPurchase\": \"string\",\n \"StockKeepingUnitPurchaseScheduleStatus\": 2,\n \"StockKeepingUnitPurchaseScheduleStatusDescription\": \"Atrasado\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b23e47-b581-4c53-bdae-59292b32fd3b", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitPurchaseSchedule", "value": "2232" }, { "key": "IDPurchase", "value": "2232" }, { "key": "StartTime", "value": "1980-02-08" }, { "key": "EndTime", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dff54284-397a-441e-9244-38b08773283f", "name": "Cria agendamento", "request": { "name": "Cria agendamento", "description": { "content": "Cria um agendamento de recebimento. Validações:\n\n- `StartTime` precisa ser menor ou igual a `EndTime` — caso contrário devolve `Data de início precisa ser menor que data de término`.\n- Quando `IDPurchase` é informado, o recebimento precisa existir na empresa **e** ainda não ter agendamento. Se já tiver, devolve `Recebimento já está agendado para `.\n- `IDPurchase` ausente cria **agendamento avulso** — um bloqueio na agenda sem recebimento associado.", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1993-11-20T16:12:21.401Z\",\n \"EndTime\": \"1954-08-13T11:41:04.538Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 3097\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "05dd4343-2faa-4a5b-a008-7d94feed485a", "name": "Agendamento criado.", "originalRequest": { "url": { "path": [ "purchase", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1993-11-20T16:12:21.401Z\",\n \"EndTime\": \"1954-08-13T11:41:04.538Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 3097\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseSchedule\": 6638,\n \"IDCompany\": 4025,\n \"RecordTimestamp\": \"2001-04-11T07:33:33.554Z\",\n \"StartTime\": \"1964-10-27T12:05:49.049Z\",\n \"EndTime\": \"1994-08-19T00:06:40.330Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 3202,\n \"IDSupplier\": 9317,\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"serie\": \"string\",\n \"nNF\": \"string\",\n \"dhEmi\": \"1972-09-04T11:09:20.383Z\",\n \"qVol\": 5855.0067398468955,\n \"Weight\": 7057.0699634498715,\n \"ItemsQuantity\": 8908.168891844409,\n \"SkuQuantity\": 9453,\n \"CheckinTimestamp\": \"1973-08-11T16:00:38.329Z\",\n \"IDStatusPurchase\": 608,\n \"StatusPurchase\": \"string\",\n \"StockKeepingUnitPurchaseScheduleStatus\": 1,\n \"StockKeepingUnitPurchaseScheduleStatusDescription\": \"Agendado\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aeb5fec-4942-40d1-875c-90f078df4a0e", "name": "Mensagens `[BadRequest]`:\n- `Data de início precisa ser menor que data de término`\n- `Recebimento já está agendado para `\n- `Recebimento não existe`\n- `Empresa não existe`", "originalRequest": { "url": { "path": [ "purchase", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1993-11-20T16:12:21.401Z\",\n \"EndTime\": \"1954-08-13T11:41:04.538Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 3097\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f5f2dc6-47b7-44a8-bff5-351e512362b5", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1993-11-20T16:12:21.401Z\",\n \"EndTime\": \"1954-08-13T11:41:04.538Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 3097\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16f47643-d3b2-436c-b3f3-11c27a3148dc", "name": "Atualiza agendamento", "request": { "name": "Atualiza agendamento", "description": { "content": "Atualização parcial do agendamento — apenas os campos enviados são aplicados. A validação de `StartTime` menor ou igual a `EndTime` só é feita quando as duas datas vêm na mesma chamada; enviar só uma delas passa sem checagem. Trocar `IDPurchase` exige que o novo recebimento exista na empresa e ainda não esteja agendado em outro registro.", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1981-06-09T23:29:18.293Z\",\n \"EndTime\": \"1961-12-12T20:43:21.498Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 410\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3397e170-0744-4243-8344-da53d8e6220e", "name": "Agendamento atualizado.", "originalRequest": { "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1981-06-09T23:29:18.293Z\",\n \"EndTime\": \"1961-12-12T20:43:21.498Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 410\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseSchedule\": 6638,\n \"IDCompany\": 4025,\n \"RecordTimestamp\": \"2001-04-11T07:33:33.554Z\",\n \"StartTime\": \"1964-10-27T12:05:49.049Z\",\n \"EndTime\": \"1994-08-19T00:06:40.330Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 3202,\n \"IDSupplier\": 9317,\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"serie\": \"string\",\n \"nNF\": \"string\",\n \"dhEmi\": \"1972-09-04T11:09:20.383Z\",\n \"qVol\": 5855.0067398468955,\n \"Weight\": 7057.0699634498715,\n \"ItemsQuantity\": 8908.168891844409,\n \"SkuQuantity\": 9453,\n \"CheckinTimestamp\": \"1973-08-11T16:00:38.329Z\",\n \"IDStatusPurchase\": 608,\n \"StatusPurchase\": \"string\",\n \"StockKeepingUnitPurchaseScheduleStatus\": 1,\n \"StockKeepingUnitPurchaseScheduleStatusDescription\": \"Agendado\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c5b3c10-7570-4236-b642-b2010eccd175", "name": "Mensagens `[BadRequest]`:\n- `Agendamento não existe`\n- `Data de início precisa ser menor que data de término`\n- `Recebimento não existe`\n- `Recebimento já está agendado para `", "originalRequest": { "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1981-06-09T23:29:18.293Z\",\n \"EndTime\": \"1961-12-12T20:43:21.498Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 410\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dfec2f2-138d-4e5d-beb4-895a4cfbffd2", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StartTime\": \"1981-06-09T23:29:18.293Z\",\n \"EndTime\": \"1961-12-12T20:43:21.498Z\",\n \"ScheduleTitle\": \"string\",\n \"Comments\": \"string\",\n \"IDPurchase\": 410\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24a02afc-bc93-415a-b72e-0f9634ff2cb7", "name": "Exclui agendamento", "request": { "name": "Exclui agendamento", "description": { "content": "Exclusão física. Sem regra de bloqueio — agendamento amarrado a recebimento já recebido pode ser apagado (mas geralmente se mantém para histórico).", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "72c34f01-0a8a-45ef-a592-3628656b778a", "name": "Agendamento excluído.", "originalRequest": { "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9da0064-b496-43ae-b3ed-c6cab321c527", "name": "`[BadRequest] - Agendamento não existe`.", "originalRequest": { "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2152449-a103-4a35-b667-fa5383138dac", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule", ":idstockkeepingunitpurchaseschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchaseschedule", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6f11443-6e02-4b0b-9a0b-501360c259a8", "name": "Lista configurações de agendamento de recebimento", "request": { "name": "Lista configurações de agendamento de recebimento", "description": { "content": "Lista as configurações de agendamento da empresa. Cada item traz o cabeçalho da configuração (duração, limites, antecedência, tolerância) **e** o array `StockKeepingUnitPurchaseScheduleConfigTimetable` com todas as faixas de horário por dia da semana já resolvidas (ordenadas por `WeekDay ASC, StartTime ASC`).", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule", "config" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitPurchaseScheduleConfig", "value": "2232", "description": "Filtra por id específico." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7982a108-1330-4201-847f-abdf9425fb98", "name": "Lista de configurações.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitPurchaseScheduleConfig", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseScheduleConfig\": 3020,\n \"IDCompany\": 8326,\n \"RecordTimestamp\": \"2004-02-04T20:30:54.409Z\",\n \"IDStockKeepingUnitDistributionCenter\": 1323,\n \"DistributionCenterName\": \"string\",\n \"ScheduleDurationMinutes\": \"string\",\n \"MaxItemsPerDay\": 8839,\n \"MaxSchedulePerDay\": 6840,\n \"ScheduleMaximumTimeAheadDay\": 2508,\n \"ScheduleMinimumAdvanceTimeHour\": 9162,\n \"HourDifferenceAllowed\": \"string\",\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 0,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 2,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseScheduleConfig\": 5228,\n \"IDCompany\": 1624,\n \"RecordTimestamp\": \"1972-01-06T00:28:05.160Z\",\n \"IDStockKeepingUnitDistributionCenter\": 3116,\n \"DistributionCenterName\": \"string\",\n \"ScheduleDurationMinutes\": \"string\",\n \"MaxItemsPerDay\": 8569,\n \"MaxSchedulePerDay\": 6460,\n \"ScheduleMaximumTimeAheadDay\": 8882,\n \"ScheduleMinimumAdvanceTimeHour\": 9827,\n \"HourDifferenceAllowed\": \"string\",\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 4,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 2,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fd480ac-c6c4-4fda-915d-7863693d4073", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitPurchaseScheduleConfig", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7272add4-61c2-4dcd-ad82-c474f2e464e5", "name": "Cria configuração de agendamento", "request": { "name": "Cria configuração de agendamento", "description": { "content": "Cria a configuração para um CD. Validações:\n- `IDStockKeepingUnitDistributionCenter` obrigatório e precisa pertencer à empresa.\n- **Um CD pode ter apenas 1 configuração** — segunda tentativa devolve `[BadRequest] - Já existe uma agenda para esse centro de distribuição`.\n- `StockKeepingUnitPurchaseScheduleConfigTimetable` (quando enviado) é um array de faixas de horário, cada uma com `WeekDay` (0-6), `StartTime` e `EndTime`. Quando omitido, a configuração é criada sem horários e o agendamento fica indisponível até o operador editar.", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 1157,\n \"ScheduleDurationMinutes\": 2443,\n \"MaxItemsPerDay\": 277,\n \"MaxSchedulePerDay\": 8230,\n \"ScheduleMaximumTimeAheadDay\": 1261,\n \"ScheduleMinimumAdvanceTimeHour\": 1468,\n \"HourDifferenceAllowed\": 5027,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 1,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 4,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "095da344-14dd-4f4e-acb9-b4598fe9f380", "name": "Configuração criada (formato da listagem).", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 9256,\n \"ScheduleDurationMinutes\": 8841,\n \"MaxItemsPerDay\": 6630,\n \"MaxSchedulePerDay\": 8686,\n \"ScheduleMaximumTimeAheadDay\": 7904,\n \"ScheduleMinimumAdvanceTimeHour\": 230,\n \"HourDifferenceAllowed\": 1259,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 5,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 4,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseScheduleConfig\": 4742,\n \"IDCompany\": 4139,\n \"RecordTimestamp\": \"1979-05-20T12:13:43.364Z\",\n \"IDStockKeepingUnitDistributionCenter\": 3157,\n \"DistributionCenterName\": \"string\",\n \"ScheduleDurationMinutes\": \"string\",\n \"MaxItemsPerDay\": 8583,\n \"MaxSchedulePerDay\": 3384,\n \"ScheduleMaximumTimeAheadDay\": 4755,\n \"ScheduleMinimumAdvanceTimeHour\": 4553,\n \"HourDifferenceAllowed\": \"string\",\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 3,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 1,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f937dc74-4c68-4eb5-9792-0754cd70836f", "name": "`[BadRequest] - Centro de distribuição precisa ser informado`; `[BadRequest] - Centro de distribuição não existe`; `[BadRequest] - Já existe uma agenda para esse centro de distribuição`; `[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 9256,\n \"ScheduleDurationMinutes\": 8841,\n \"MaxItemsPerDay\": 6630,\n \"MaxSchedulePerDay\": 8686,\n \"ScheduleMaximumTimeAheadDay\": 7904,\n \"ScheduleMinimumAdvanceTimeHour\": 230,\n \"HourDifferenceAllowed\": 1259,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 5,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 4,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c2fc85b-5cab-4bd6-bdc9-11439b1453fd", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 9256,\n \"ScheduleDurationMinutes\": 8841,\n \"MaxItemsPerDay\": 6630,\n \"MaxSchedulePerDay\": 8686,\n \"ScheduleMaximumTimeAheadDay\": 7904,\n \"ScheduleMinimumAdvanceTimeHour\": 230,\n \"HourDifferenceAllowed\": 1259,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 5,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 4,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01d3a6e6-c883-4821-b968-00f93708799b", "name": "Atualiza configuração de agendamento", "request": { "name": "Atualiza configuração de agendamento", "description": { "content": "Atualização parcial. Comportamento do `StockKeepingUnitPurchaseScheduleConfigTimetable`:\n- **Não enviado**: timetable atual fica intacta.\n- **Array vazio** (`[]`): **apaga** todas as faixas atuais — agendamento fica indisponível.\n- **Array preenchido**: **substitui** as faixas atuais (DELETE + INSERT em bloco).\n\nValidações: troca de `IDStockKeepingUnitDistributionCenter` exige que o novo CD não tenha outra configuração existente.", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 3418,\n \"ScheduleDurationMinutes\": 2021,\n \"MaxItemsPerDay\": 1531,\n \"MaxSchedulePerDay\": 2023,\n \"ScheduleMaximumTimeAheadDay\": 2091,\n \"ScheduleMinimumAdvanceTimeHour\": 9623,\n \"HourDifferenceAllowed\": 267,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 3,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 5,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6002c90f-603f-41a0-a70f-cec9779f39ce", "name": "Configuração atualizada.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 3984,\n \"ScheduleDurationMinutes\": 1921,\n \"MaxItemsPerDay\": 856,\n \"MaxSchedulePerDay\": 8320,\n \"ScheduleMaximumTimeAheadDay\": 3038,\n \"ScheduleMinimumAdvanceTimeHour\": 3217,\n \"HourDifferenceAllowed\": 8104,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 0,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 3,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseScheduleConfig\": 4742,\n \"IDCompany\": 4139,\n \"RecordTimestamp\": \"1979-05-20T12:13:43.364Z\",\n \"IDStockKeepingUnitDistributionCenter\": 3157,\n \"DistributionCenterName\": \"string\",\n \"ScheduleDurationMinutes\": \"string\",\n \"MaxItemsPerDay\": 8583,\n \"MaxSchedulePerDay\": 3384,\n \"ScheduleMaximumTimeAheadDay\": 4755,\n \"ScheduleMinimumAdvanceTimeHour\": 4553,\n \"HourDifferenceAllowed\": \"string\",\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 3,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 1,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa37885e-001f-44c2-a59d-ee969f204d5c", "name": "`[BadRequest] - Configuração agendamento não existe`; `[BadRequest] - Centro de distribuição não existe`; `[BadRequest] - Já existe uma agenda para esse centro de distribuição`.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 3984,\n \"ScheduleDurationMinutes\": 1921,\n \"MaxItemsPerDay\": 856,\n \"MaxSchedulePerDay\": 8320,\n \"ScheduleMaximumTimeAheadDay\": 3038,\n \"ScheduleMinimumAdvanceTimeHour\": 3217,\n \"HourDifferenceAllowed\": 8104,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 0,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 3,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e30be70-a625-47fc-a35a-7ca6f3975c33", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 3984,\n \"ScheduleDurationMinutes\": 1921,\n \"MaxItemsPerDay\": 856,\n \"MaxSchedulePerDay\": 8320,\n \"ScheduleMaximumTimeAheadDay\": 3038,\n \"ScheduleMinimumAdvanceTimeHour\": 3217,\n \"HourDifferenceAllowed\": 8104,\n \"StockKeepingUnitPurchaseScheduleConfigTimetable\": [\n {\n \"WeekDay\": 0,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n },\n {\n \"WeekDay\": 3,\n \"StartTime\": \"string\",\n \"EndTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b78a0e71-c06d-437d-a630-71ff920464d4", "name": "Exclui configuração de agendamento", "request": { "name": "Exclui configuração de agendamento", "description": { "content": "**Exclusão física**. As faixas de horário vinculadas são removidas automaticamente em cascata. Devolve a string literal `sucesso`.", "type": "text/plain" }, "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "235dfd35-a617-4f0a-b530-be1f7d16f84f", "name": "Configuração excluída.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fbe5d3b-37c5-47cd-b685-977891e5c60b", "name": "`[BadRequest] - Configuração agendamento não existe`.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dff2318-e979-4924-a2fa-358202d97c5e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "purchase", "schedule", "config", ":idstockkeepingunitpurchasescheduleconfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasescheduleconfig", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5f89dcd2-12c7-4cbe-abd2-eb272083a613", "name": "Armazéns", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f11d52a2-41aa-4aa4-a0bf-326831ef6331", "name": "Lista armazéns", "request": { "name": "Lista armazéns", "description": { "content": "Lista armazéns Ativos (`Status = 1`) da empresa, ordenados por `WarehouseName`. Inclui o nome resolvido do tipo (`TypeStockKeepingUnitWarehouse`), CD pai e empresa faturadora (`IDCompanyInvoice`). Respeita restrição de CDs do usuário.", "type": "text/plain" }, "url": { "path": [ "sku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitDistributionCenter", "value": "string", "description": "Filtra pelo identificador do centro de distribuição do SKU." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "536d997c-d1bd-466b-a8ef-3c241e3f23a7", "name": "Lista de armazéns.", "originalRequest": { "url": { "path": [ "sku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 7898,\n \"IDStockKeepingUnitDistributionCenter\": 9830,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 1,\n \"DefaultPurchase\": 0,\n \"Status\": 0,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 4211,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1950-12-16T17:32:28.617Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 9744,\n \"IDStockKeepingUnitDistributionCenter\": 466,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 0,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 1747,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1975-07-23T23:29:18.606Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "500b6635-1415-48cf-a6ec-f08b324e2f24", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db017996-9d60-4021-8a5b-2c43a1db3c0d", "name": "Cria armazém", "request": { "name": "Cria armazém", "description": { "content": "Cria um armazém dentro de um CD. Validações:\n- `IDStockKeepingUnitDistributionCenter` precisa pertencer à empresa.\n- `IDCompanyInvoice` (quando informado) precisa ser uma empresa associada à conta autenticada via `CompanyMain`.\n- Quando `Default = 1`, zera o `Default` dos demais armazéns da empresa.\n- Quando `DefaultPurchase = 1`, zera o `DefaultPurchase` dos demais armazéns.\n\nComportamento especial: o POST cria **simultaneamente** o armazém **e** um endereço padrão dentro dele em `StockKeepingUnitLocation` (Address = WarehouseName, Default = 1).", "type": "text/plain" }, "url": { "path": [ "sku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3e7b6b4e-2588-4bbf-8c32-db6de8d6e2f0", "name": "Armazém criado (lista completa).", "originalRequest": { "url": { "path": [ "sku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 7898,\n \"IDStockKeepingUnitDistributionCenter\": 9830,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 1,\n \"DefaultPurchase\": 0,\n \"Status\": 0,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 4211,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1950-12-16T17:32:28.617Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 9744,\n \"IDStockKeepingUnitDistributionCenter\": 466,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 0,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 1747,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1975-07-23T23:29:18.606Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5062f46-456b-446e-87da-84eab0f162e1", "name": "`[BadRequest] - Company not found`; `[BadRequest] - Faturador não existe`; `[BadRequest] - Centro de distribuição não existe`; `[BadRequest] - Could not add warehouse`; `[BadRequest] - Could not add location`.", "originalRequest": { "url": { "path": [ "sku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5b5e0a1-22ad-469a-8753-39ea13c3b7ed", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75d39ea0-62b3-4ceb-8ebd-81fd27ac9002", "name": "Atualiza armazém", "request": { "name": "Atualiza armazém", "description": { "content": "Atualização parcial. Mesmas validações do POST quando trocar CD ou faturador. Quando seta `Default=1` zera os demais armazéns.", "type": "text/plain" }, "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "04ebeb3d-da23-4692-886c-6a395871aa62", "name": "Armazém atualizado.", "originalRequest": { "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 7898,\n \"IDStockKeepingUnitDistributionCenter\": 9830,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 1,\n \"DefaultPurchase\": 0,\n \"Status\": 0,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 4211,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1950-12-16T17:32:28.617Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 9744,\n \"IDStockKeepingUnitDistributionCenter\": 466,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 0,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 1747,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1975-07-23T23:29:18.606Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a0f1575-00f1-4347-837f-3e9b873226bb", "name": "`[BadRequest] - Armazém não existe`; `[BadRequest] - Centro de distribuição não existe`; `[BadRequest] - Faturador não existe`.", "originalRequest": { "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43707623-0e1e-49fb-ad1e-5b5aa28cda03", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2036,\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"IDCompanyInvoice\": 8409,\n \"Default\": 1,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "742e7d22-b7fc-4adc-be6a-5a0393600031", "name": "Inativa armazém", "request": { "name": "Inativa armazém", "description": { "content": "**Soft delete** (`Status=0`, `SumQuantity=0`, `Default=0`). Bloqueada quando o armazém tem endereço cadastrado (`StockKeepingUnitLocation`) ou aparece como destino em de/para de armazém (`HubWarehouse`).", "type": "text/plain" }, "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "bb044890-2624-4e04-b241-5b71743f8570", "name": "Armazém inativado.", "originalRequest": { "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 7898,\n \"IDStockKeepingUnitDistributionCenter\": 9830,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 1,\n \"DefaultPurchase\": 0,\n \"Status\": 0,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 4211,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1950-12-16T17:32:28.617Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": \"string\",\n \"WarehouseName\": \"string\",\n \"IDCompany\": 9744,\n \"IDStockKeepingUnitDistributionCenter\": 466,\n \"DistributionCenterName\": \"string\",\n \"IDTypeStockKeepingUnitWarehouse\": \"\",\n \"TypeStockKeepingUnitWarehouse\": \"string\",\n \"Default\": 0,\n \"DefaultPurchase\": 1,\n \"Status\": 1,\n \"SumQuantity\": 0,\n \"IDCompanyInvoice\": 1747,\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1975-07-23T23:29:18.606Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6bea6ab-5081-46d8-8563-d47c69297dfe", "name": "`[BadRequest] - Armazém não existe`; `[BadRequest] - Armazém possui endereço cadastrado e não pode ser excluído`; `[BadRequest] - Armazém tem de/para de armazém e não pode ser excluído`.", "originalRequest": { "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "305302b7-0f21-4240-b14a-3ab04d2622e3", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "warehouse", ":idstockkeepingunitwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitwarehouse", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de938214-574f-4e39-886e-c113df1b360e", "name": "Lista saldos do SKU por armazém", "request": { "name": "Lista saldos do SKU por armazém", "description": { "content": "Lista o saldo do SKU em cada armazém ativo, com detalhamento de pedidos reservados, em manuseio, em produção, em recebimento, em pedido de compra e em ressuprimento. Respeita os centros de distribuição autorizados para o usuário: se `IDStockKeepingUnitDistributionCenter` incluir algum centro fora da lista autorizada, a resposta vem vazia (`[]`). Quando `IDTypeOrder` é informado, todas as quantidades saem reduzidas pela margem de segurança do tipo de pedido.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeOrder", "value": "2232", "description": "Quando informado, todas as quantidades da resposta saem reduzidas pela margem de estoque de segurança configurada no tipo de pedido. Tipo de pedido inexistente ou de outra empresa é tratado como margem zero." }, { "disabled": false, "key": "IDStockKeepingUnitDistributionCenter", "value": "string", "description": "Lista de centros de distribuição separados por vírgula. Restringe os armazéns retornados." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do SKU cujo saldo será detalhado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0b0e5b73-174e-42a3-b091-6a7cdf5ddbe1", "name": "Lista de armazéns com saldo do SKU. As quantidades vêm como texto, com o número de casas decimais configurado para a empresa.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeOrder", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do SKU cujo saldo será detalhado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 6219,\n \"WarehouseName\": \"string\",\n \"Default\": 9057,\n \"IDStockKeepingUnitDistributionCenter\": 5343,\n \"DistributionCenterName\": \"string\",\n \"QtyAvailable\": \"string\",\n \"QtyOnStock\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtyHandling\": \"string\",\n \"QtyBuyOrdem\": \"string\",\n \"QtyToReceipt\": \"string\",\n \"QtyProduction\": \"string\",\n \"QtyResupply\": \"string\",\n \"InventoryValue\": \"string\",\n \"CostAverage\": \"string\",\n \"QtyReservedOrders\": [\n {\n \"RecordTimestamp\": \"2003-09-19T14:17:25.565Z\",\n \"IDOrder\": 2444,\n \"IDStatusOrder\": 52,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 3787.9792345958595\n },\n {\n \"RecordTimestamp\": \"1998-04-06T06:51:59.424Z\",\n \"IDOrder\": 9222,\n \"IDStatusOrder\": 0,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 9051.946267398394\n }\n ],\n \"QtyHandlingOrders\": [\n {\n \"RecordTimestamp\": \"1973-07-05T01:30:09.369Z\",\n \"IDOrder\": 6416,\n \"IDStatusOrder\": 8711,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 5852.9527995927565\n },\n {\n \"RecordTimestamp\": \"2021-09-16T05:30:20.043Z\",\n \"IDOrder\": 695,\n \"IDStatusOrder\": 5577,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 4826.690638178666\n }\n ],\n \"QtyProductionOrders\": [\n {\n \"RecordTimestamp\": \"1972-09-24T08:53:47.125Z\",\n \"IDStockKeepingUnitProduction\": 1554,\n \"IDTypeStatusSkuProduction\": 4,\n \"TypeStatusSkuProduction\": \"string\",\n \"Quantity\": 9275.533354940444\n },\n {\n \"RecordTimestamp\": \"1997-09-23T21:08:40.437Z\",\n \"IDStockKeepingUnitProduction\": 2505,\n \"IDTypeStatusSkuProduction\": 4,\n \"TypeStatusSkuProduction\": \"string\",\n \"Quantity\": 7462.1198101175605\n }\n ],\n \"QtyBuyOrdemOrders\": [\n {\n \"RecordTimestamp\": \"1991-05-18T05:22:31.525Z\",\n \"IDBuyOrder\": 3357,\n \"IDStatusBuyOrder\": 6,\n \"StatusBuyOrder\": \"string\",\n \"Quantity\": 2612.1427203700496\n },\n {\n \"RecordTimestamp\": \"1974-09-03T23:31:59.618Z\",\n \"IDBuyOrder\": 6292,\n \"IDStatusBuyOrder\": 1,\n \"StatusBuyOrder\": \"string\",\n \"Quantity\": 2425.7424951479843\n }\n ],\n \"QtyToReceiptOrders\": [\n {\n \"RecordTimestamp\": \"1958-12-27T02:56:43.297Z\",\n \"IDPurchase\": 9872,\n \"IDStatusPurchase\": 0,\n \"StatusPurchase\": \"string\",\n \"Quantity\": 8484.784747174052\n },\n {\n \"RecordTimestamp\": \"2010-10-12T18:32:12.218Z\",\n \"IDPurchase\": 4627,\n \"IDStatusPurchase\": 0,\n \"StatusPurchase\": \"string\",\n \"Quantity\": 2620.868646417971\n }\n ],\n \"QtyToResupply\": [\n {\n \"RecordTimestamp\": \"2015-08-30T22:23:51.266Z\",\n \"IDStockKeepingUnitResupplyList\": 8330,\n \"IDResupplyStatus\": 2,\n \"StatusResupply\": \"string\",\n \"Quantity\": 8966.332309366251\n },\n {\n \"RecordTimestamp\": \"2019-03-05T10:28:58.584Z\",\n \"IDStockKeepingUnitResupplyList\": 5167,\n \"IDResupplyStatus\": 2,\n \"StatusResupply\": \"string\",\n \"Quantity\": 1897.8389568508703\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 3451,\n \"WarehouseName\": \"string\",\n \"Default\": 8430,\n \"IDStockKeepingUnitDistributionCenter\": 9952,\n \"DistributionCenterName\": \"string\",\n \"QtyAvailable\": \"string\",\n \"QtyOnStock\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtyHandling\": \"string\",\n \"QtyBuyOrdem\": \"string\",\n \"QtyToReceipt\": \"string\",\n \"QtyProduction\": \"string\",\n \"QtyResupply\": \"string\",\n \"InventoryValue\": \"string\",\n \"CostAverage\": \"string\",\n \"QtyReservedOrders\": [\n {\n \"RecordTimestamp\": \"2022-05-24T16:47:16.562Z\",\n \"IDOrder\": 5756,\n \"IDStatusOrder\": 0,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 2415.072218900769\n },\n {\n \"RecordTimestamp\": \"2026-09-20T15:26:38.042Z\",\n \"IDOrder\": 8449,\n \"IDStatusOrder\": 9,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 5552.535856620613\n }\n ],\n \"QtyHandlingOrders\": [\n {\n \"RecordTimestamp\": \"1950-11-17T04:06:57.208Z\",\n \"IDOrder\": 404,\n \"IDStatusOrder\": 5080,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 1699.2786358132062\n },\n {\n \"RecordTimestamp\": \"2008-03-02T05:01:06.320Z\",\n \"IDOrder\": 563,\n \"IDStatusOrder\": 8579,\n \"Order\": \"string\",\n \"StatusOrder\": \"string\",\n \"Quantity\": 6292.148854902\n }\n ],\n \"QtyProductionOrders\": [\n {\n \"RecordTimestamp\": \"1957-06-03T03:16:05.195Z\",\n \"IDStockKeepingUnitProduction\": 4443,\n \"IDTypeStatusSkuProduction\": 2,\n \"TypeStatusSkuProduction\": \"string\",\n \"Quantity\": 1978.4730400979433\n },\n {\n \"RecordTimestamp\": \"2014-02-01T05:14:40.623Z\",\n \"IDStockKeepingUnitProduction\": 3903,\n \"IDTypeStatusSkuProduction\": 4,\n \"TypeStatusSkuProduction\": \"string\",\n \"Quantity\": 509.88896012684745\n }\n ],\n \"QtyBuyOrdemOrders\": [\n {\n \"RecordTimestamp\": \"1990-06-30T04:42:21.302Z\",\n \"IDBuyOrder\": 1830,\n \"IDStatusBuyOrder\": 0,\n \"StatusBuyOrder\": \"string\",\n \"Quantity\": 3666.019341526134\n },\n {\n \"RecordTimestamp\": \"2016-03-22T10:10:50.681Z\",\n \"IDBuyOrder\": 9369,\n \"IDStatusBuyOrder\": 1,\n \"StatusBuyOrder\": \"string\",\n \"Quantity\": 4505.985537445845\n }\n ],\n \"QtyToReceiptOrders\": [\n {\n \"RecordTimestamp\": \"2005-10-29T04:21:57.339Z\",\n \"IDPurchase\": 4598,\n \"IDStatusPurchase\": 0,\n \"StatusPurchase\": \"string\",\n \"Quantity\": 7725.160945669531\n },\n {\n \"RecordTimestamp\": \"1968-02-25T07:31:21.304Z\",\n \"IDPurchase\": 5264,\n \"IDStatusPurchase\": 0,\n \"StatusPurchase\": \"string\",\n \"Quantity\": 7313.702322200466\n }\n ],\n \"QtyToResupply\": [\n {\n \"RecordTimestamp\": \"2005-06-12T17:05:42.997Z\",\n \"IDStockKeepingUnitResupplyList\": 2974,\n \"IDResupplyStatus\": 2,\n \"StatusResupply\": \"string\",\n \"Quantity\": 4113.090820190863\n },\n {\n \"RecordTimestamp\": \"2014-04-22T01:28:20.728Z\",\n \"IDStockKeepingUnitResupplyList\": 4770,\n \"IDResupplyStatus\": 3,\n \"StatusResupply\": \"string\",\n \"Quantity\": 9968.362317106506\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad6cbc08-b6d0-4121-9738-c98838a35cd4", "name": "Mensagem (prefixo `[BadRequest]`): `não localizado` — SKU não informado no caminho da URL.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeOrder", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do SKU cujo saldo será detalhado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de7676fb-837d-43b5-9468-57a9f90af5f6", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeOrder", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do SKU cujo saldo será detalhado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dc60412d-5a22-47dc-ad43-e9144ca9a9cf", "name": "Arquivos", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4c8056f5-160c-4ad5-993e-a75c25cf9121", "name": "Anexa arquivo a um consumidor", "request": { "name": "Anexa arquivo a um consumidor", "description": { "content": "Faz upload de um arquivo `multipart/form-data` e vincula ao consumidor informado em `IDConsumer`. O arquivo é armazenado em bucket privado e o sistema responde com o registro criado, a chave interna `Key` e uma URL pré-assinada `UrlFile` (validade 48h). Limite de 3 arquivos por consumidor — quando atingido, é preciso remover um arquivo antes de adicionar outro.", "type": "text/plain" }, "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "FileSource", "value": "Consumer", "description": "(Required) Origem do arquivo. Hoje só `Consumer` é aceito; outros valores resultam em `[BadRequest]`." }, { "disabled": false, "key": "IDConsumer", "value": "1603", "description": "(Required) Identificador do consumidor que receberá o arquivo. Validado contra a empresa autenticada (subdomínio)." }, { "disabled": false, "key": "IDTypeFile", "value": "8", "description": "(Required) Tipo do arquivo: `1`=Documento Fiscal PDF, `2`=Documento Fiscal XML, `3`=Boleto Bancário, `4`=Comprovante Pagamento, `5`=Carta de Correção PDF, `6`=Carta de Correção XML, `7`=Inutilização NF XML, `8`=Cancelamento NF XML." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Conteúdo binário do arquivo. O nome original (incluindo extensão) é preservado para inferir a extensão usada na chave do bucket." } ] } }, "response": [ { "id": "40f13b2b-f00b-4d4a-883c-a6513d7285a8", "name": "Arquivo armazenado com sucesso.", "originalRequest": { "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FileSource", "value": "Consumer" }, { "key": "IDConsumer", "value": "1603" }, { "key": "IDTypeFile", "value": "8" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Conteúdo binário do arquivo. O nome original (incluindo extensão) é preservado para inferir a extensão usada na chave do bucket.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"RecordTimestamp\": \"1961-04-17T04:20:36.767Z\",\n \"IDConsumerFile\": 3945,\n \"IDTypeFile\": 5,\n \"TypeFile\": \"string\",\n \"IDConsumer\": 2791,\n \"Key\": \"string\",\n \"UrlFile\": \"http://YxQauNremcwWIdFhv.hkxxqbgtJz.GUG0Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c6f4ee6-6e20-45de-a980-750f676ec757", "name": "Falha de validação. Mensagens possíveis: `[BadRequest] - Empresa não identificada no contexto da requisição.`, `[BadRequest] - IDConsumer é obrigatório.`, `[BadRequest] - IDTypeFile é obrigatório.`, `[BadRequest] - Consumidor não existe`, `[BadRequest] - Tipo de arquivo não existe`, `[BadRequest] - O consumidor já possui 3 arquivos vinculados. Remova um arquivo para adicionar outro.`, `[BadRequest] - Arquivo não enviado`, `[BadRequest] - Arquivo sem extensão`, `[BadRequest] - FileSource inválido`.", "originalRequest": { "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FileSource", "value": "Consumer" }, { "key": "IDConsumer", "value": "1603" }, { "key": "IDTypeFile", "value": "8" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Conteúdo binário do arquivo. O nome original (incluindo extensão) é preservado para inferir a extensão usada na chave do bucket.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7e695ca-a035-473c-8004-58965d192fb2", "name": "Erro interno. Falha ao gravar no bucket ou no banco.", "originalRequest": { "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FileSource", "value": "Consumer" }, { "key": "IDConsumer", "value": "1603" }, { "key": "IDTypeFile", "value": "8" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Conteúdo binário do arquivo. O nome original (incluindo extensão) é preservado para inferir a extensão usada na chave do bucket.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a995ba6-2616-496c-8c1c-fac9248bd752", "name": "Remove arquivo vinculado a um consumidor", "request": { "name": "Remove arquivo vinculado a um consumidor", "description": { "content": "Remove o vínculo de um arquivo de consumidor a partir do identificador `IDFile`. O registro é apagado mesmo que o objeto correspondente no bucket ainda exista (limpeza do bucket está atualmente desativada no sistema).", "type": "text/plain" }, "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "FileSource", "value": "Consumer", "description": "(Required) Origem do arquivo. Hoje só `Consumer` é aceito." }, { "disabled": false, "key": "IDConsumer", "value": "1603", "description": "(Required) Identificador do consumidor dono do arquivo." }, { "disabled": false, "key": "IDFile", "value": "1603", "description": "(Required) Identificador do arquivo a remover (`IDConsumerFile`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "6083f438-6f97-4a62-bf85-a4578f1e1ceb", "name": "Arquivo removido com sucesso. Retorna a string literal `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FileSource", "value": "Consumer" }, { "key": "IDConsumer", "value": "1603" }, { "key": "IDFile", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d49b4153-3afe-485e-97b8-14fccedf5f53", "name": "Falha de validação. Mensagens possíveis: `[BadRequest] - ID do arquivo não informado`, `[BadRequest] - Arquivo não informado`, `[BadRequest] - Arquivo não existe`, `[BadRequest] - FileSource inválido`.", "originalRequest": { "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FileSource", "value": "Consumer" }, { "key": "IDConsumer", "value": "1603" }, { "key": "IDFile", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9b38a1c-a45d-481c-b1d8-8bada8a4541b", "name": "Erro interno na execução da exclusão.", "originalRequest": { "url": { "path": [ "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FileSource", "value": "Consumer" }, { "key": "IDConsumer", "value": "1603" }, { "key": "IDFile", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fd95ce30-0e00-4a1b-bc51-01a0cc34fe80", "name": "Autenticação", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6679e7c9-4815-402e-8350-ef5c3c738a5e", "name": "Login por email/CPF/CNPJ e senha", "request": { "name": "Login por email/CPF/CNPJ e senha", "description": { "content": "Endpoint público. Autentica o usuário na conta identificada pelo subdomínio. O campo `email` aceita tanto o e-mail de login quanto o documento (CPF ou CNPJ, com ou sem máscara, incluindo CNPJ alfanumérico) — o formato é detectado automaticamente.\n\nAplica as regras de expiração de senha (parametrização **Validade da Senha (Dias)**), bloqueio temporário de 10 minutos após 3 tentativas falhas e verificação em duas etapas quando habilitada para o usuário. Na verificação por e-mail, um código de 6 dígitos válido por 5 minutos é enviado e a resposta pede o código; na verificação por aplicativo autenticador, o código informado em `mfacode` é validado, ou a resposta devolve `OtpAuthUrl` para o primeiro cadastro.\n\nUsuários com e-mail do domínio `@idworks.com.br` acessam qualquer conta, exceto as contas `idw` e `suporte`.", "type": "text/plain" }, "url": { "path": [ "user", "signin", "local" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"password\": \"string\",\n \"mfacode\": \"string\",\n \"expireinhour\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dc7d7fa5-456d-4085-af2f-d338b85fb8f3", "name": "Login concluído ou desafio de MFA emitido. Conforme o estado, o corpo é um `UserSigninResponse` (sucesso, com `token` JWT) ou um `UserSigninMFAChallenge` (cadastro/desafio de MFA pendente).", "originalRequest": { "url": { "path": [ "user", "signin", "local" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"password\": \"string\",\n \"mfacode\": \"string\",\n \"expireinhour\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"token\": \"string\",\n \"body\": {\n \"id\": 5878,\n \"email\": \"string\",\n \"UserName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"Salesman\": 6252,\n \"RestrictAccessSalesman\": 8391,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlMain\": \"string\",\n \"AccountNameMain\": \"string\",\n \"CompanyNameCorporateNameMain\": \"string\",\n \"ExternalDashboard\": \"string\",\n \"Theme\": \"string\",\n \"UserImageUrl\": \"string\",\n \"IDModuleFavorite\": [\n \"string\",\n \"string\"\n ],\n \"CompanyPaymentStatus\": 6282,\n \"ChatIA\": 0,\n \"IDCompanyMainShare\": 9304,\n \"CompanyMainShare\": \"string\",\n \"DaysBeforePasswordExpiration\": 9567,\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"Origin\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f489c1-50fa-4310-bbd6-3124723dbb4c", "name": "Requisição inválida. Mensagens conhecidas:\n- `[BadRequest] - Login informado não é um email válido nem documento`\n- `[BadRequest] - Erro ao enviar código por email`\n- `[BadRequest] - Erro ao validar expiração de senha`\n- `[BadRequest] - Retornar em instantes` (sistema temporariamente travado).", "originalRequest": { "url": { "path": [ "user", "signin", "local" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"password\": \"string\",\n \"mfacode\": \"string\",\n \"expireinhour\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "157a37f4-df0e-4888-ac71-d1f1058e5df5", "name": "`[NotFound] Verificar usuário, senha e subdomínio (url)` — usuário sem senha cadastrada.", "originalRequest": { "url": { "path": [ "user", "signin", "local" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"string\",\n \"password\": \"string\",\n \"mfacode\": \"string\",\n \"expireinhour\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e45b6c82-1f5a-4b84-b36a-73bf3d8bfaeb", "name": "Boleto Bancário", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e78bf1c9-26b8-4ca9-873d-543809a3bed7", "name": "Lista boletos bancários", "request": { "name": "Lista boletos bancários", "description": { "content": "Lista os boletos da empresa autenticada com dados do cliente, valor, vencimento, status (`TypeStatusBankSlip`), URL e código de barras gerados pelo banco. Cada linha traz também os flags `BankSlipUpdate` e `BankSlipCancel` (booleans calculados pelo sistema de acordo com o estado atual e o banco) — são eles que governam quais ações ficam habilitadas no frontend.", "type": "text/plain" }, "url": { "path": [ "charge", "bank-slip" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Número da página da listagem (1-based). Padrão `1`." }, { "disabled": false, "key": "IDStatusBankSlip", "value": "1,5", "description": "Status do boleto: `1` Aguardando pagamento, `2` Pago, `3` Pendente, `4` Cancelado, `5` Baixa manual, `6` Protesto." }, { "disabled": false, "key": "DateDueFrom", "value": "1980-02-08", "description": "Data de vencimento ≥ data." }, { "disabled": false, "key": "DateDueTo", "value": "1980-02-08", "description": "Data de vencimento ≤ data." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data de criação ≥ data." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data de criação ≤ data." }, { "disabled": false, "key": "ConsumerNameCorporateName", "value": "string", "description": "Nome / razão social do cliente (LIKE)." }, { "disabled": false, "key": "ConsumerCpfCnpj", "value": "string", "description": "CPF/CNPJ do cliente." }, { "disabled": false, "key": "ConsumerEmail", "value": "string", "description": "E-mail do cliente (LIKE)." }, { "disabled": false, "key": "IDOrder", "value": "1603", "description": "Pedido vinculado." }, { "disabled": false, "key": "TID", "value": "string", "description": "Identificador da transação no banco." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1a775332-a57f-48e9-bac7-9d7b345f1cbd", "name": "Array de boletos.", "originalRequest": { "url": { "path": [ "charge", "bank-slip" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "IDStatusBankSlip", "value": "6,2" }, { "key": "DateDueFrom", "value": "1980-02-08" }, { "key": "DateDueTo", "value": "1980-02-08" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "ConsumerEmail", "value": "string" }, { "key": "IDOrder", "value": "1603" }, { "key": "TID", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankSlip\": 5701,\n \"IDConsumer\": 7675,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"IDOrder\": 8753,\n \"Order\": \"string\",\n \"IDServiceOrder\": 2399,\n \"Value\": 6226.795595621781,\n \"ValuePaid\": 4172.011200374574,\n \"DateDue\": \"1958-05-21\",\n \"DatePaid\": \"1979-01-06\",\n \"IDStatusBankSlip\": 3,\n \"StatusBankSlip\": \"string\",\n \"BankSlipUrl\": \"http://qgiRGhxnuRRjNEWqJnN.xxRuhSaD.s54NDGMpHdZGd6AeuQmn9JUQxlAMuCNRJhQT\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUpdate\": false,\n \"BankSlipCancel\": false,\n \"TID\": \"string\",\n \"IDCompanyIntegration\": 122,\n \"CompanyIntegration\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"RecordTimestamp\": \"1965-02-19T02:47:21.023Z\"\n },\n {\n \"IDBankSlip\": 6105,\n \"IDConsumer\": 5361,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"IDOrder\": 8525,\n \"Order\": \"string\",\n \"IDServiceOrder\": 1759,\n \"Value\": 6837.561902318576,\n \"ValuePaid\": 764.5586421362638,\n \"DateDue\": \"2026-09-19\",\n \"DatePaid\": \"1988-05-09\",\n \"IDStatusBankSlip\": 5,\n \"StatusBankSlip\": \"string\",\n \"BankSlipUrl\": \"http://qEkWaCDPnbzvliXnlZJalRV.lglnjkLklP7+DlzIibn9kD0I.kyhN+\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUpdate\": false,\n \"BankSlipCancel\": false,\n \"TID\": \"string\",\n \"IDCompanyIntegration\": 178,\n \"CompanyIntegration\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"RecordTimestamp\": \"1947-10-11T23:06:53.568Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0cf3151c-be4e-4add-928f-8cc5b7bfe98e", "name": "Gera um novo boleto", "request": { "name": "Gera um novo boleto", "description": { "content": "Emite um boleto (ou link de pagamento, no caso da Cielo) na integração financeira indicada em `IDCompanyIntegration`. Em modo avulso os dados vêm do corpo; informando a query `idorder` ou `idserviceorder`, o corpo é ignorado e o sistema emite um boleto para cada recebimento do pedido ou da NFSe que ainda não tenha boleto e que aponte para uma integração financeira. Quando o boleto está vinculado a um pedido, o número do pedido é enviado ao emissor e aparece como número do documento no boleto. Disponível apenas para as integrações PagarMe, Banco Inter, Mercado Pago, Itaú e Cielo. Quando a integração estiver parametrizada para isso, o boleto também é enviado ao cliente por WhatsApp e/ou e-mail.", "type": "text/plain" }, "url": { "path": [ "charge", "bank-slip" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "idorder", "value": "1603", "description": "Identificador do pedido. Quando informado, o corpo da requisição é ignorado e é emitido um boleto para cada recebimento em aberto do pedido que ainda não tenha boleto. Grafado em minúsculas." }, { "disabled": false, "key": "idserviceorder", "value": "1603", "description": "Identificador da ordem de serviço. Quando informado, o corpo da requisição é ignorado e é emitido um boleto para cada recebimento da NFSe que ainda não tenha boleto. Equivalente ao `idorder`, mas para nota fiscal de serviço. Se as duas queries forem enviadas, `idorder` prevalece e a `idserviceorder` é ignorada. Grafado em minúsculas." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 9303,\n \"IDCompanyIntegration\": 858,\n \"Value\": 6010.91,\n \"DateDue\": \"2000-08-11\",\n \"Comments\": \"string\",\n \"IDAddress\": 4667,\n \"IDOrder\": 5985,\n \"IDServiceOrder\": 4517,\n \"IDAccountPayableReceivable\": 5431\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ff5ed923-3bb7-436f-b190-006e15b724d3", "name": "Boleto gerado. No modo avulso (sem as queries `idorder`/`idserviceorder` e sem `IDAccountPayableReceivable` no corpo), devolve um array com um objeto contendo o detalhe completo do boleto recém-criado: `IDBankSlip`, `BankSlipUrl`, `BankSlipBarCode`, `BankSlipBarCodeImageLine`, `TID`, `UniqueSequentialNumber`, `ExternalId`, `IDStatusBankSlip` (`1` Ag. Pagamento), `StatusBankSlip`, além dos dados do cliente e da integração. Quando uma das queries `idorder`/`idserviceorder` é usada ou o corpo traz `IDAccountPayableReceivable`, o corpo é apenas a string `Sucesso`, sem o boleto. Na integração Cielo, `TID` e `UniqueSequentialNumber` são preenchidos com o `ExternalId` do link gerado.", "originalRequest": { "url": { "path": [ "charge", "bank-slip" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "idorder", "value": "1603" }, { "key": "idserviceorder", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 9303,\n \"IDCompanyIntegration\": 858,\n \"Value\": 6010.91,\n \"DateDue\": \"2000-08-11\",\n \"Comments\": \"string\",\n \"IDAddress\": 4667,\n \"IDOrder\": 5985,\n \"IDServiceOrder\": 4517,\n \"IDAccountPayableReceivable\": 5431\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f5360fe-08be-4dfa-842a-5bfc4d717c41", "name": "Validação ou falha na emissão (prefixo `[BadRequest]`). Mensagens: `Empresa não encontrada`; `Integração não cadastrada`; `Integração não permite gerar boleto`; `Consumidor não cadastrado`; `Endereço não cadastrado`; `Recebimentos do pedido já tem boleto gerado ou não possuem integração com boleto/link` (apenas nos modos `idorder` e `idserviceorder`); `Não foi possível emitir o boleto. Tente novamente.` (falha de comunicação ao acionar o emissor); `Boleto emitido, mas não foi possível carregá-lo. Atualize a tela.` (emissão concluída, mas a releitura do boleto falhou). O emissor também pode devolver a própria mensagem de recusa dos dados.", "originalRequest": { "url": { "path": [ "charge", "bank-slip" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "idorder", "value": "1603" }, { "key": "idserviceorder", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 9303,\n \"IDCompanyIntegration\": 858,\n \"Value\": 6010.91,\n \"DateDue\": \"2000-08-11\",\n \"Comments\": \"string\",\n \"IDAddress\": 4667,\n \"IDOrder\": 5985,\n \"IDServiceOrder\": 4517,\n \"IDAccountPayableReceivable\": 5431\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ac7d5f2-abf7-4ef5-aa87-d6a043d0474c", "name": "Consulta status no banco e atualiza", "request": { "name": "Consulta status no banco e atualiza", "description": { "content": "Consulta a API do banco para buscar o status atualizado do boleto e atualiza no idworks. Chamado pelo ícone **Atualizar** da linha. Bloqueado pelo frontend quando o boleto já está pago (`IDStatusBankSlip=2`).", "type": "text/plain" }, "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "8eed0fa1-9958-41b0-8e2a-8f60c7d0c2fd", "name": "Status atualizado. Retorna a linha do boleto com os campos refrescados.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8e403df-d6c0-4921-bd4e-4cfe54a989bc", "name": "Falha na consulta ao banco.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8133c959-ced1-4b9e-ab8d-0095c95b8f12", "name": "Atualiza o boleto", "request": { "name": "Atualiza o boleto", "description": { "content": "Atualiza valor, vencimento ou observações do boleto. Quais campos são editáveis depende do banco — o frontend bloqueia o botão Editar quando `BankSlipUpdate=false`.", "type": "text/plain" }, "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Value\": 3219.6750556198685,\n \"DateDue\": \"2017-12-15\",\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6f1d27ca-25a8-4522-b72b-a1c0161fc364", "name": "Boleto atualizado.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Value\": 3219.6750556198685,\n \"DateDue\": \"2017-12-15\",\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0809bcfb-1e7d-4462-a4e8-af315f530e1d", "name": "Banco recusou alteração ou campos inválidos.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Value\": 3219.6750556198685,\n \"DateDue\": \"2017-12-15\",\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "752cf4f0-32be-44cd-aeae-a2d9ff962a83", "name": "Cancela o boleto (com ou sem dar baixa)", "request": { "name": "Cancela o boleto (com ou sem dar baixa)", "description": { "content": "Cancela o boleto junto ao emissor. Sem `ValuePaid`/`DatePaid` o boleto é apenas cancelado e a conta a receber vinculada permanece em aberto; informando os dois, o boleto passa para `5` Baixa manual e o pagamento é registrado — usado quando o cliente já pagou por outro meio. Nesse modo de baixa, o lançamento financeiro só acontece quando existe uma conta a receber ainda em aberto (`0` Aberto, `1` Vencido ou `6` Vence hoje) amarrada ao boleto e uma conta bancária associada à integração; se qualquer uma das duas faltar, o boleto é baixado mas nenhum pagamento é lançado. O cancelamento só existe nas integrações Itaú e Banco Inter, e o boleto precisa estar em `1` Ag. Pagamento ou `3` Pendente.", "type": "text/plain" }, "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ValuePaid", "value": "4625.784441141443", "description": "Valor pago — quando informado junto com `DatePaid`, ativa o modo Dar Baixa e Cancelar." }, { "disabled": false, "key": "DatePaid", "value": "1980-02-08", "description": "Data do pagamento — obrigatória junto com `ValuePaid`." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "DELETE", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2912170e-0684-4444-99d1-58dfc304c50c", "name": "Boleto cancelado (e pagamento registrado quando aplicável). Retorna um array com um objeto — o detalhe completo do boleto já atualizado, com os mesmos campos de `GET /charge/bank-slip/{idbankslip}`. O detalhe é lido sem reconsultar o emissor.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ValuePaid", "value": "4625.784441141443" }, { "key": "DatePaid", "value": "1980-02-08" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08d3019f-2d66-4484-8fc9-d1abf03836d0", "name": "Mensagens (prefixo `[BadRequest]`):\n- `Boleto não encontrado`\n- `Status boleto não permite cancelar`\n- `Integração não cadastrada`\n- `Integração não tem recurso de cancelamento`\n- `Não foi possível cancelar o boleto. Tente novamente.` — falha de rede ou tempo esgotado ao acionar o emissor.\n- `Boleto cancelado, mas não foi possível carregá-lo. Atualize a tela.` — cancelamento concluído, mas a releitura do boleto falhou.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ValuePaid", "value": "4625.784441141443" }, { "key": "DatePaid", "value": "1980-02-08" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idbankslip", "description": "(Required) Identificador do boleto." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8739d361-8cd9-45ef-be96-d35ff2e3f1a3", "name": "Cria um pedido a partir de boleto pago", "request": { "name": "Cria um pedido a partir de boleto pago", "description": { "content": "Gera um pedido a partir de um boleto avulso já pago. O boleto precisa estar em `2` Pago e ainda não ter pedido vinculado. O pedido nasce com o cliente do boleto, o tipo de pedido padrão ativo da empresa, a integração interna idworks e um pagamento de boleto já lançado com o `TID`/`NSU` e o valor do boleto. Ao final, o boleto fica vinculado ao pedido criado.", "type": "text/plain" }, "url": { "path": [ "charge", "bank-slip", ":idbankslip", "order" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankslip", "description": "(Required) Identificador do boleto bancário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "375c26b2-e319-46a4-a223-5edf4eb6f278", "name": "Pedido criado. Retorna o detalhe completo do pedido novo.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip", "order" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankslip", "description": "(Required) Identificador do boleto bancário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a00bdc0-b599-49da-95d0-b7774d497f7e", "name": "Configuração da empresa incompleta. Mensagens reais: `[BadRequest] - IDTypeOrder não existe` (tipo de pedido padrão não cadastrado), `[BadRequest] - IDCompanyIntegration não existe` (integração Stark não cadastrada), `[BadRequest] - IDTypePayment não existe` (tipo de pagamento de boleto ativo não cadastrado).\n- `[BadRequest] - Não foi possível gerar o pedido do boleto. Tente novamente.` (falha de comunicação ao criar o pedido — o pedido NÃO foi criado)\n- `[BadRequest] - Pedido gerado, mas não foi possível carregá-lo. Atualize a tela.` (o pedido FOI criado — recarregue a tela em vez de repetir a chamada)", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip", "order" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankslip", "description": "(Required) Identificador do boleto bancário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01138fab-8d80-45ba-b624-8d9a0ed9973c", "name": "Boleto inválido para criação de pedido. Mensagens reais: `[NotFound] - Boleto não existe`, `[NotFound] - Boleto não está pago`, `[NotFound] - Boleto já tem pedido criado`.", "originalRequest": { "url": { "path": [ "charge", "bank-slip", ":idbankslip", "order" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankslip", "description": "(Required) Identificador do boleto bancário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b1225aeb-2ed6-4073-8ce5-2abbcd9e4840", "name": "CT-e", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5d596c89-cb4b-4a94-ba2c-91dd07170f06", "name": "Lista o feed de CT-e", "request": { "name": "Lista o feed de CT-e", "description": { "content": "Lista os CT-e emitidos contra o CNPJ da empresa, baixados automaticamente da SEFAZ. Para cada CT-e, traz: dados do documento (`CarrierInvoice`), descrição do tipo (`CtTpCteDescription`), situação SEFAZ (`SitCteDescription`), tomador (`CtTomaDescription`), serviço prestado (`CttpServDescription`), pedido vinculado (`Order`) resolvido pela chave da NF-e citada, eventual conta a pagar associada (`IDAccountPayableReceivable`) resolvida por fornecedor + `CTeNumber`, peso do pedido vs. peso cobrado e diferenças (`OrderWeight`, `WeightCharged`, `WeightDifference`), valores de frete e impostos, e URLs assinadas para XML/DANFE (`XmlFile`, `XmlDanfe`).\n\nQuando o filtro `FreightConciliation=1` é informado, o sistema retorna uma listagem alternativa que cruza com o leilão de frete e expõe o campo calculado `IDStatusShippingAuctionDif` (`1` = simulado < cobrado, `2` = simulado > cobrado, `3` = empate), filtrável pelo parâmetro de mesmo nome. Útil para análise de divergência de frete.\n\nPaginação: **1000 por página** (`Page=N` → offset `N*1000`). Ordenação: uma linha por CT-e (`IDCarrierInvoice`); na listagem padrão os registros vêm ordenados de forma crescente por `IDCarrierInvoice`, garantindo paginação estável entre páginas. No modo `FreightConciliation=1` não há ordenação explícita.", "type": "text/plain" }, "url": { "path": [ "cte" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Página 0-indexada. Offset = `Page * 1000`." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "1603", "description": "Empresa faturadora destinatária do CT-e (`IDCompanyInvoice`)." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "`CTeDate` ≥ data." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "`CTeDate` ≤ data + ` 23:59:59`." }, { "disabled": false, "key": "Order", "value": "string", "description": "Número do pedido vinculado (`Order`)." }, { "disabled": false, "key": "IDOrder", "value": "1603", "description": "Código interno do pedido vinculado (`IDOrder`)." }, { "disabled": false, "key": "InvoiceNumber", "value": "2232", "description": "Número da NF-e de produto citada no CT-e. Extraído das posições 26 a 34 da chave de acesso (`InvoiceAccessKey`)." }, { "disabled": false, "key": "InvoiceAccessKey", "value": "stringstringstringstringstringstringstringst", "description": "Chave de acesso da NF-e de produto citada (44 dígitos)." }, { "disabled": false, "key": "SupplierNameCorporateName", "value": "string", "description": "Nome/razão social da transportadora emissora do CT-e (LIKE)." }, { "disabled": false, "key": "IDCarrier", "value": "1603", "description": "Transportadora cadastrada com integração ativa (`IDSupplier` com `TypeCarrier`)." }, { "disabled": false, "key": "CTeSit", "value": "3", "description": "Situação SEFAZ: `1` Uso autorizado, `3` CT-e Cancelada (`SitCte`)." }, { "disabled": false, "key": "CTeType", "value": "1", "description": "Tipo: `0` Normal, `1` Complementar, `2` Anulação, `3` Substituição, `4` Fatura (`CtTpCte`)." }, { "disabled": false, "key": "CTeToma", "value": "1", "description": "Tipo de tomador do frete: `0` Remetente, `1` Expedidor, `2` Recebedor, `3` Destinatário, `4` Outros (`CtToma`)." }, { "disabled": false, "key": "FreightConciliation", "value": "1", "description": "`1` ativa o modo de conciliação de frete: cruza o frete total cobrado no CT-e com o valor simulado no leilão de frete e habilita o filtro `IDStatusShippingAuctionDif`." }, { "disabled": false, "key": "IDStatusShippingAuctionDif", "value": "3", "description": "Aplicável apenas com `FreightConciliation=1`. Filtra pelo resultado da comparação: `1` simulado < cobrado, `2` simulado > cobrado, `3` empate." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c100b2f0-77c9-40b6-b59b-dbb8c9f92032", "name": "Array de CT-e. Quando nenhum casa com os filtros, retorna `[]`. Cada item segue o schema `CarrierInvoiceFeedItem`.", "originalRequest": { "url": { "path": [ "cte" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "IDCompanyInvoice", "value": "1603" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Order", "value": "string" }, { "key": "IDOrder", "value": "1603" }, { "key": "InvoiceNumber", "value": "2232" }, { "key": "InvoiceAccessKey", "value": "stringstringstringstringstringstringstringst" }, { "key": "SupplierNameCorporateName", "value": "string" }, { "key": "IDCarrier", "value": "1603" }, { "key": "CTeSit", "value": "3" }, { "key": "CTeType", "value": "1" }, { "key": "CTeToma", "value": "1" }, { "key": "FreightConciliation", "value": "1" }, { "key": "IDStatusShippingAuctionDif", "value": "3" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierInvoice\": 1527,\n \"IDCompany\": 83,\n \"IDCompanyInvoice\": 730,\n \"AccountName\": \"string\",\n \"CompanyInvoiceAccountName\": \"string\",\n \"IDOrder\": 4913,\n \"Order\": \"string\",\n \"IDConsumer\": 3103,\n \"ConsumerReceiverName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"IDCarrier\": 5715,\n \"CTeDate\": \"1984-01-22T20:33:14.733Z\",\n \"RecordTimestamp\": \"1963-01-06T21:37:02.595Z\",\n \"CTeNumber\": 3758,\n \"CTeAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"NSU\": 3545,\n \"CorreiosSRO\": \"string\",\n \"CTeSit\": 1,\n \"SitCteDescription\": \"Uso autorizado\",\n \"CTeType\": 1,\n \"CtTpCteDescription\": \"string\",\n \"CTeToma\": 0,\n \"CtTomaDescription\": \"string\",\n \"CTetpServ\": 1560,\n \"CttpServDescription\": \"string\",\n \"InvoiceAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"InvoiceNumber\": 7771,\n \"InvoiceSerie\": 1164,\n \"Comments\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"WeightCharged\": 2736.499896859266,\n \"OrderWeight\": 2406.835011794715,\n \"WeightDifference\": 4186.83403423876,\n \"ValueShipping\": 6746.468518238984,\n \"ValueGrisInsurance\": 5704.3345834781785,\n \"ValueICMS\": 4056.112919822188,\n \"ValueISS\": 4758.471105028381,\n \"ValueTotalService\": 5629.764276574836,\n \"ValueRate\": 8946.39798340764,\n \"OrderValueShipping\": 91.82525605865965,\n \"ValueShippingNet\": 5273.709368857795,\n \"ValueShippingAuction\": 1993.1797331528078,\n \"ValueShippingAuctionNet\": 4716.876928939253,\n \"IDStatusShippingAuctionDif\": 2,\n \"PriceSellingTotal\": 9018.160387279666,\n \"IDAccountPayableReceivable\": 5857,\n \"XmlFile\": \"http://hjCUDKrcih.hfcR9-pEOx3Uo8XR6FkqcbUpjX5rVnFlFTf,XgK2hqbFoLLSeZBoy7d\",\n \"XmlDanfe\": \"http://kTgslWSJGpqYFUlch.lbcyeIyoRH\"\n },\n {\n \"IDCarrierInvoice\": 4977,\n \"IDCompany\": 7608,\n \"IDCompanyInvoice\": 6112,\n \"AccountName\": \"string\",\n \"CompanyInvoiceAccountName\": \"string\",\n \"IDOrder\": 7484,\n \"Order\": \"string\",\n \"IDConsumer\": 4192,\n \"ConsumerReceiverName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"IDCarrier\": 806,\n \"CTeDate\": \"2010-11-30T02:06:53.997Z\",\n \"RecordTimestamp\": \"1948-05-08T22:44:29.538Z\",\n \"CTeNumber\": 3578,\n \"CTeAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"NSU\": 4192,\n \"CorreiosSRO\": \"string\",\n \"CTeSit\": 1,\n \"SitCteDescription\": \"CT-e Cancelada\",\n \"CTeType\": 2,\n \"CtTpCteDescription\": \"string\",\n \"CTeToma\": 1,\n \"CtTomaDescription\": \"string\",\n \"CTetpServ\": 4019,\n \"CttpServDescription\": \"string\",\n \"InvoiceAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"InvoiceNumber\": 9282,\n \"InvoiceSerie\": 7946,\n \"Comments\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"WeightCharged\": 5403.4706488246175,\n \"OrderWeight\": 1200.8634036071885,\n \"WeightDifference\": 534.8250754412409,\n \"ValueShipping\": 3061.9452120171654,\n \"ValueGrisInsurance\": 9937.365180302797,\n \"ValueICMS\": 9097.444971988096,\n \"ValueISS\": 3030.514589165858,\n \"ValueTotalService\": 9366.630763927713,\n \"ValueRate\": 7576.529983864777,\n \"OrderValueShipping\": 3909.048518745821,\n \"ValueShippingNet\": 7707.779431816622,\n \"ValueShippingAuction\": 7451.920449072771,\n \"ValueShippingAuctionNet\": 4687.557884131715,\n \"IDStatusShippingAuctionDif\": 1,\n \"PriceSellingTotal\": 1234.3427530172103,\n \"IDAccountPayableReceivable\": 1626,\n \"XmlFile\": \"http://Xc.erfxVDwq7\",\n \"XmlDanfe\": \"http://bzZibzBYeTPILQWyewuAKSHiTP.wfbipGDkZNgTFGzE8K5FEVl6ivcZM9z1YTq9phJdM\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d012778-8d21-4bea-aedc-8bab58e7408c", "name": "Serve XML/PDF individual de um CT-e", "request": { "name": "Serve XML/PDF individual de um CT-e", "description": { "content": "Serve o XML (`Type=XML`) ou o PDF da DANFE (`Type=PDF`) de um CT-e individual. Não é chamado diretamente pelo frontend — as URLs já vêm prontas no corpo de `GET /cte` nos campos `XmlFile` (XML) e `XmlDanfe` (PDF), assinadas com o `token` do contexto do usuário.", "type": "text/plain" }, "url": { "path": [ "cte", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Folder", "value": "Cte", "description": "(Required) Pasta no S3 — sempre `Cte`." }, { "disabled": false, "key": "Type", "value": "XML", "description": "(Required) `XML` devolve o arquivo XML do CT-e; `PDF` devolve o PDF da DANFE." }, { "disabled": false, "key": "token", "value": "string", "description": "(Required) Token de autenticação do usuário (já incluído nas URLs geradas por `GET /cte`)." }, { "disabled": false, "key": "File", "value": "string", "description": "(Required) Nome do arquivo no S3 — `.xml`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "c969b45f-3939-4013-8d05-36e9531d075b", "name": "Conteúdo binário (XML ou PDF).", "originalRequest": { "url": { "path": [ "cte", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Folder", "value": "Cte" }, { "key": "Type", "value": "XML" }, { "key": "token", "value": "string" }, { "key": "File", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0adf8ee1-a9f3-4789-99d6-c87ef9c8eb06", "name": "Baixa XML de vários CT-e em lote", "request": { "name": "Baixa XML de vários CT-e em lote", "description": { "content": "Empacota em um único arquivo `.zip` os XMLs dos CT-e informados e devolve uma URL temporária de download, válida por 2 dias. A mesma URL é enviada por e-mail ao usuário autenticado; quando o modelo de e-mail não está disponível, o envio é ignorado e a URL continua sendo devolvida na resposta. Só entram no pacote os CT-e que já têm chave de acesso registrada — se nenhum dos documentos informados tiver, a chamada falha.", "type": "text/plain" }, "url": { "path": [ "cte", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n 1630\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e08f2d5-de91-41ac-a2a0-8a6c3d106e5c", "name": "URL temporária de download do arquivo `.zip`, válida por 2 dias. Devolvida mesmo quando o e-mail de aviso não pôde ser enviado.", "originalRequest": { "url": { "path": [ "cte", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 1630\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"http://MGyvSv.nedf2CLEQ7bXzxrOZTOjfy+rfLOqdKqiUdsSY\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0238603e-b04f-4346-b97c-7506b532e693", "name": "Mensagens `[BadRequest]`:\n- `Usuário não localizado` — usuário autenticado sem cadastro ativo.\n- `Nenhum CT-e com chave de acesso encontrado para os documentos informados`\n- `Falha ao montar o arquivo de CT-e: `\n- `Falha ao subir o arquivo de CT-e: `\n- `Falha ao gerar o link de download: `", "originalRequest": { "url": { "path": [ "cte", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 1630\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f4187ea-f724-481f-a46a-8273fe72c171", "name": "Erro interno não tratado durante a montagem do pacote ou no envio do e-mail de aviso (mensagens sem prefixo padrão, inclusive `catched error: ...`).", "originalRequest": { "url": { "path": [ "cte", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 1630\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7aa1f444-9cc3-41cb-9a0d-800613e2110d", "name": "Cadastro de Clientes", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9dc0aec7-a553-402c-b484-06f3cfc8b83c", "name": "Lista clientes", "request": { "name": "Lista clientes", "description": { "content": "Lista os clientes da empresa autenticada, com métricas agregadas: receita total (soma dos valores das contas a receber vinculadas), quantidade total de pedidos do cliente, receita de NFs de serviço emitidas (`ServiceOrder` em status `IDStatusInvoice=3`) e vendedores vinculados (lista de `UserName` via `ConsumerSalesman`). Paginação fixa em **3000 por página** (`Page=N` → offset `N*3000`). Por padrão, o sistema filtra por `StatusConsumer IN (1,2,3)` — clientes Deletados (`StatusConsumer=0`) não aparecem.\n\n**Restrição de vendedor**: quando `Salesman=1` e `RestrictAccessSalesman=1`, o sistema restringe a listagem aos clientes vinculados ao usuário logado em `ConsumerSalesman`.", "type": "text/plain" }, "url": { "path": [ "consumer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Página 0-indexada. Offset = `Page * 3000`." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca rápida unificada — testa o termo contra `ConsumerNameCorporateName` (LIKE), `ConsumerCpfCnpj` (apenas dígitos, ≥10 caracteres), `ConsumerEmail` (LIKE) e `IDConsumer` (apenas dígitos)." }, { "disabled": false, "key": "ConsumerNameCorporateName", "value": "string", "description": "Busca textual no nome / razão social (LIKE)." }, { "disabled": false, "key": "ConsumerCpfCnpj", "value": "string", "description": "CPF/CNPJ. O sistema normaliza para apenas dígitos antes da consulta (aceita formato com pontuação)." }, { "disabled": false, "key": "ConsumerEmail", "value": "string", "description": "E-mail (LIKE)." }, { "disabled": false, "key": "ConsumerTelephone", "value": "string", "description": "Telefone. O sistema normaliza para apenas dígitos." }, { "disabled": false, "key": "IDTypeStatusConsumer", "value": "1,2,3", "description": "Status do cliente. Aceita CSV (ex.: `1,2,3`). Valores: `0` Deletado, `1` Ativo, `2` Inativo, `3` Inadimplente. Default `1,2,3` (não traz Deletados)." }, { "disabled": false, "key": "ConsumerPriority", "value": "2232", "description": "Prioridade interna (`ConsumerPriority`)." }, { "disabled": false, "key": "IDSalesman", "value": "string", "description": "Vendedor vinculado. CSV aceito. Filtra apenas clientes com o vendedor informado em `ConsumerSalesman`." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Filtra clientes com `RecordTimestamp` a partir desta data (inclusive)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Filtra clientes com `RecordTimestamp` até o final desta data (inclusive)." }, { "disabled": false, "key": "SinceDateLastRecordModification", "value": "1978-04-10T08:52:42.717Z", "description": "Pega apenas clientes modificados após o timestamp informado. Útil para sincronizações incrementais." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d1c9da6b-b495-47b7-90eb-d2c0c802f984", "name": "Array de clientes.", "originalRequest": { "url": { "path": [ "consumer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "Search", "value": "string" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "ConsumerEmail", "value": "string" }, { "key": "ConsumerTelephone", "value": "string" }, { "key": "IDTypeStatusConsumer", "value": "1,2,3" }, { "key": "ConsumerPriority", "value": "2232" }, { "key": "IDSalesman", "value": "string" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "SinceDateLastRecordModification", "value": "1978-04-10T08:52:42.717Z" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 3489,\n \"AccountName\": \"string\",\n \"ConsumerType\": 2,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"IDTypeStatusConsumer\": 1,\n \"TypeStatusConsumer\": \"string\",\n \"ConsumerPriority\": 6704,\n \"RecordTimestamp\": \"1979-12-30T15:33:24.208Z\",\n \"DateLastRecordModification\": \"1969-08-31T22:25:53.425Z\",\n \"OrderQuantity\": 6101,\n \"OrderRevenueValueTotal\": 5529.210676467231,\n \"ServiceOrderRevenueValueTotal\": 677.7927830575914,\n \"Salesman\": \"string\"\n },\n {\n \"IDConsumer\": 5840,\n \"AccountName\": \"string\",\n \"ConsumerType\": 2,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"IDTypeStatusConsumer\": 1,\n \"TypeStatusConsumer\": \"string\",\n \"ConsumerPriority\": 4280,\n \"RecordTimestamp\": \"1986-11-20T15:23:01.855Z\",\n \"DateLastRecordModification\": \"1975-04-14T19:13:20.015Z\",\n \"OrderQuantity\": 3534,\n \"OrderRevenueValueTotal\": 9806.13373390792,\n \"ServiceOrderRevenueValueTotal\": 6083.300758205796,\n \"Salesman\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0dda7f7-e3f7-4867-8b27-66854a43123d", "name": "Cria um cliente", "request": { "name": "Cria um cliente", "description": { "content": "Cria um cliente (pessoa física, jurídica ou estrangeiro) no cadastro central. Usado pelo modal Novo Cliente, pelo PDV e pela importação em massa via planilha (uma chamada por linha). Quando `ConsumerType=2`, o sistema consulta a base pública de CNPJ e sobrescreve razão social, nome fantasia, e-mail, telefone e data de início de atividade com o que vier de lá, além de cadastrar automaticamente o endereço e a inscrição estadual ativa da UF; se a consulta falhar ou não responder em 5 segundos, o cliente é criado normalmente apenas com os dados enviados. Não é possível ter dois clientes ativos com o mesmo CPF/CNPJ. Quando o usuário autenticado é vendedor (`Salesman=1`), ele já é vinculado ao cliente criado.", "type": "text/plain" }, "url": { "path": [ "consumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ConsumerType\": 2,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerBirthDate\": \"2005-11-07\",\n \"Comments\": \"string\",\n \"NfeCommentsConsumer\": \"string\",\n \"NfeSuframa\": \"200123456\",\n \"IDTypeConsumerClassification\": 1,\n \"ConsumerPriority\": 2,\n \"IDCarrier\": 3371,\n \"IDCompanySalesPolicy\": 4310\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "12bad444-9ad1-4aa6-81fd-2d7f844b9143", "name": "Cliente criado. Retorna um array com o detalhe completo do cliente recém-criado (mesmo formato do `GET /consumer/{idconsumer}`), com o `IDConsumer` atribuído. Quando a consulta automática do CNPJ devolve endereço, ele já vem cadastrado no cliente nesta mesma resposta.", "originalRequest": { "url": { "path": [ "consumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ConsumerType\": 2,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerBirthDate\": \"2005-11-07\",\n \"Comments\": \"string\",\n \"NfeCommentsConsumer\": \"string\",\n \"NfeSuframa\": \"200123456\",\n \"IDTypeConsumerClassification\": 1,\n \"ConsumerPriority\": 2,\n \"IDCarrier\": 3371,\n \"IDCompanySalesPolicy\": 4310\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3002ae0-86b9-4204-a63e-d10071de4aed", "name": "Erros (prefixo `[BadRequest]`):\n- `Já existe um cliente com esse CPF/CNPJ`\n- `Email não é válido `\n- `Prioridade pedido precisa ser entre 0 e 10`\n- `Classificação cliente não existe`\n- `Transportadora não existe`\n- `Política comercial não existe`\n- `Empresa não existe`\n- `Problema ao adicionar cliente`\n- `Inscrição SUFRAMA precisa ter 8 ou 9 dígitos`\n- `Inscrição SUFRAMA só pode ser informada para pessoa jurídica`", "originalRequest": { "url": { "path": [ "consumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ConsumerType\": 2,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerBirthDate\": \"2005-11-07\",\n \"Comments\": \"string\",\n \"NfeCommentsConsumer\": \"string\",\n \"NfeSuframa\": \"200123456\",\n \"IDTypeConsumerClassification\": 1,\n \"ConsumerPriority\": 2,\n \"IDCarrier\": 3371,\n \"IDCompanySalesPolicy\": 4310\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25dc5000-cc11-4e9b-86cb-00185aa60fc2", "name": "Detalhe do cliente", "request": { "name": "Detalhe do cliente", "description": { "content": "Retorna o cadastro completo do cliente (dados básicos + dados fiscais + métricas agregadas). Endpoints separados servem cada bloco do detalhe (`/consumer/{idconsumer}/address`, `/consumer/{idconsumer}/salesman`, `/consumer/{idconsumer}/credit`, `/consumer/{idconsumer}/voucher`).", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Restringe o saldo de vale retornado (`ConsumerVoucherValue`) a um faturador específico. Só é considerado quando a empresa está configurada para restringir vale por faturador; caso contrário é ignorado." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "dc54df84-f01a-4bcb-b249-9f995467e8c1", "name": "Detalhe do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ccdd679-183b-4d8e-8f25-30cf463bad4b", "name": "`[NotFound] - Cliente não encontrado`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94fe86a7-97c4-499f-bf80-32b3859b21d8", "name": "Atualiza dados do cliente", "request": { "name": "Atualiza dados do cliente", "description": { "content": "Atualiza os dados básicos do cliente — apenas os campos enviados são alterados, com uma exceção importante: `ConsumerBirthDate` é sempre gravado, e omiti-lo do corpo apaga a data já cadastrada. Envie sempre o valor atual desse campo quando quiser preservá-lo. Os blocos do detalhe (endereços, vendedores, vales) têm endpoints próprios. Cada alteração é registrada no histórico do cliente com o valor anterior e o novo, e não é possível deixar dois clientes ativos com o mesmo CPF/CNPJ.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ConsumerType\": 1,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerBirthDate\": \"1973-07-19\",\n \"Comments\": \"string\",\n \"NfeCommentsConsumer\": \"string\",\n \"NfeSuframa\": \"200123456\",\n \"StatusConsumer\": 3,\n \"IDTypeConsumerClassification\": 7,\n \"ConsumerPriority\": 7,\n \"IDCarrier\": 6537,\n \"IDCompanySalesPolicy\": 9015\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b9696617-adde-409d-9bf8-f56c872252a6", "name": "Cliente atualizado. Retorna um array com o detalhe completo do cliente já atualizado, no mesmo formato de `GET /consumer/{idconsumer}`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ConsumerType\": 1,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerBirthDate\": \"1973-07-19\",\n \"Comments\": \"string\",\n \"NfeCommentsConsumer\": \"string\",\n \"NfeSuframa\": \"200123456\",\n \"StatusConsumer\": 3,\n \"IDTypeConsumerClassification\": 7,\n \"ConsumerPriority\": 7,\n \"IDCarrier\": 6537,\n \"IDCompanySalesPolicy\": 9015\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3b095d8-bf48-4c85-bb27-be4f2fd1f6ec", "name": "Erros (prefixo `[BadRequest]`):\n- `Cliente não existe`\n- `Já existe um cliente com esse CPF/CNPJ`\n- `Email não é válido `\n- `Prioridade pedido precisa ser entre 0 e 10`\n- `Status consumidor não encontrado`\n- `Classificação cliente não existe`\n- `Transportadora não existe`\n- `Política comercial não existe`\n- `Inscrição SUFRAMA precisa ter 8 ou 9 dígitos`\n- `Inscrição SUFRAMA só pode ser informada para pessoa jurídica`", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ConsumerType\": 1,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerBirthDate\": \"1973-07-19\",\n \"Comments\": \"string\",\n \"NfeCommentsConsumer\": \"string\",\n \"NfeSuframa\": \"200123456\",\n \"StatusConsumer\": 3,\n \"IDTypeConsumerClassification\": 7,\n \"ConsumerPriority\": 7,\n \"IDCarrier\": 6537,\n \"IDCompanySalesPolicy\": 9015\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0889dd80-58ae-4593-82f4-17e9813c0d9d", "name": "Remove cliente (soft delete)", "request": { "name": "Remove cliente (soft delete)", "description": { "content": "Marca o cliente como **Deletado** (`StatusConsumer=0`). **Não apaga fisicamente** — preserva histórico de pedidos, contas a receber e NFs emitidas. O cliente deixa de aparecer na listagem padrão (que filtra `StatusConsumer IN (1,2,3)`).", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "2235b5a4-8bdb-441b-a943-52d378a6c430", "name": "Cliente marcado como deletado.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b314535d-5848-4ba8-bc12-af91938f476d", "name": "Cliente tem vínculos ativos que impedem a remoção.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f162b1a-d617-4db9-8233-d9af2e5bc51a", "name": "Cliente não encontrado.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b427510f-1557-43d4-9442-b621c7e66d1c", "name": "Lista os endereços do cliente", "request": { "name": "Lista os endereços do cliente", "description": { "content": "Retorna todos os endereços ativos (`StatusAddress=1`) cadastrados para o cliente.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "address" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "08557b6f-de37-458a-81f6-75ad49e720f9", "name": "Lista de endereços ativos. Pode vir vazia.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDAddress\": 5466,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2977,\n \"StatusAddress\": 2559,\n \"RecordTimestamp\": \"2017-02-02T05:03:35.416Z\",\n \"IDCountry\": 657,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 1269,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 464,\n \"StatusAddress\": 4780,\n \"RecordTimestamp\": \"1994-07-09T22:44:21.157Z\",\n \"IDCountry\": 6350,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c735453f-91b5-455b-932b-2eeed1bc4288", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c9819d3-0863-4d4e-a443-5b5cb7d3326f", "name": "Cadastra um endereço para o cliente", "request": { "name": "Cadastra um endereço para o cliente", "description": { "content": "Cria um novo endereço. Para `IDCountry=1` (Brasil), o sistema consulta a base de CEP para resolver o código IBGE do município; sem retorno da consulta, o cadastro falha. Para `IDCountry` diferente de `1`, valida o país e força `ShippingState=EX` e `ShippingCity=EXTERIOR`. Inscrição estadual em Minas Gerais é normalizada com zeros à esquerda até 13 dígitos (exceto `ISENTO`). Atualiza `DateLastRecordModification` do cliente.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "address" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ShippingCity\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"IDCountry\": 1,\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"bJZ7shXcbGMs@h.gkge\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f38ae7dd-ec94-44af-9bb8-67b0c7f9c100", "name": "Endereço criado. Retorna o detalhe completo do cliente (mesmo shape de `GET /consumer/{idconsumer}`).", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingCity\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"IDCountry\": 1,\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"bJZ7shXcbGMs@h.gkge\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 4517,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"2012-04-08\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 0,\n \"Address\": [\n {\n \"IDAddress\": 610,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 1606,\n \"StatusAddress\": 8275,\n \"RecordTimestamp\": \"2004-05-13T13:57:02.639Z\",\n \"IDCountry\": 1574,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3309,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7684,\n \"StatusAddress\": 6468,\n \"RecordTimestamp\": \"1990-11-09T03:09:05.576Z\",\n \"IDCountry\": 2814,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2767,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2021-02-21T05:28:42.040Z\"\n },\n {\n \"IDConsumerContact\": 1122,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2014-10-25T21:10:11.561Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 3720,\n \"IDTypePayment\": 277,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 859.44,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3551.23,\n \"CreditValueLeft\": 9482.74\n },\n {\n \"IDConsumerCredit\": 6227,\n \"IDTypePayment\": 4186,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3777.41,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5733.86,\n \"CreditValueLeft\": 680.49\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 7439,\n \"IDAcess\": 5486,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2006-02-08T19:06:38.558Z\"\n },\n {\n \"IDConsumerSalesman\": 4615,\n \"IDAcess\": 2044,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-07-30T15:35:55.076Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": 54.0214876528311,\n \"key_3\": 1140\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\"\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 2368\n },\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 8447,\n \"key_3\": \"string\",\n \"key_4\": true\n }\n ],\n \"ConsumerVoucherValue\": 5315.86,\n \"OrderQuantity\": 2016,\n \"OrderRevenueValueTotal\": 4130.66,\n \"RecordTimestamp\": \"2008-10-12T23:48:09.607Z\",\n \"DateLastRecordModification\": \"1997-09-05T16:52:04.014Z\"\n },\n {\n \"IDConsumer\": 3125,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"2021-09-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 0,\n \"Address\": [\n {\n \"IDAddress\": 1821,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 3644,\n \"StatusAddress\": 3251,\n \"RecordTimestamp\": \"1979-10-29T23:45:19.893Z\",\n \"IDCountry\": 3078,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 4586,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7112,\n \"StatusAddress\": 9029,\n \"RecordTimestamp\": \"2023-04-30T17:03:16.178Z\",\n \"IDCountry\": 9351,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 5959,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1975-07-24T02:43:15.609Z\"\n },\n {\n \"IDConsumerContact\": 4889,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1996-06-08T22:07:59.765Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 2122,\n \"IDTypePayment\": 9013,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4105.21,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 4833.37,\n \"CreditValueLeft\": 2680.2400000000002\n },\n {\n \"IDConsumerCredit\": 9228,\n \"IDTypePayment\": 3030,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 5762.32,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 7847.17,\n \"CreditValueLeft\": 2973.26\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3706,\n \"IDAcess\": 1886,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1955-09-25T00:48:32.500Z\"\n },\n {\n \"IDConsumerSalesman\": 1277,\n \"IDAcess\": 531,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1964-04-28T06:48:29.303Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": 7062.078016409115\n },\n {\n \"key_0\": 7740\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 544.2393608043661\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n ],\n \"ConsumerVoucherValue\": 1508.71,\n \"OrderQuantity\": 6163,\n \"OrderRevenueValueTotal\": 632.02,\n \"RecordTimestamp\": \"1998-04-21T01:51:15.673Z\",\n \"DateLastRecordModification\": \"1977-12-28T08:09:19.103Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25204bd6-8074-4cff-b0c2-0baeb70d5140", "name": "Validações: `[BadRequest] - Consumidor não existe` (cliente não pertence à empresa autenticada); `[BadRequest] - IDCountry não existe` (país informado não está cadastrado em `TypeCountry`).", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingCity\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"IDCountry\": 1,\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"bJZ7shXcbGMs@h.gkge\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ae07d44d-3487-4ba1-bb20-a8ff269af583", "name": "`erro consultar cep` quando a consulta de CEP não retorna resultado. Demais erros internos com prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingCity\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"IDCountry\": 1,\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"bJZ7shXcbGMs@h.gkge\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a75398eb-e588-4991-bcef-374e5f373488", "name": "Detalha um endereço do cliente", "request": { "name": "Detalha um endereço do cliente", "description": { "content": "Retorna os dados de um endereço específico. Só retorna endereços ativos (`StatusAddress=1`).", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e4e406e6-9908-4137-8037-83ca085736b8", "name": "Endereço encontrado. Vem vazio quando não há endereço ativo com o id informado.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDAddress\": 5466,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2977,\n \"StatusAddress\": 2559,\n \"RecordTimestamp\": \"2017-02-02T05:03:35.416Z\",\n \"IDCountry\": 657,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 1269,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 464,\n \"StatusAddress\": 4780,\n \"RecordTimestamp\": \"1994-07-09T22:44:21.157Z\",\n \"IDCountry\": 6350,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d4dd5eb-22e0-4346-8f06-4dac91276e00", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "134b5b31-167b-4016-8ab5-351bba7e7acd", "name": "Atualiza um endereço do cliente", "request": { "name": "Atualiza um endereço do cliente", "description": { "content": "Atualização parcial — apenas os campos enviados são gravados. Quando `IDCountry` muda para um valor diferente de `1`, o sistema valida o país e força `ShippingState=EX` e `ShippingCity=EXTERIOR`. Para `IDCountry=1` (default quando omitido), dispara consulta de CEP para recalcular o código IBGE. Inscrição estadual em Minas Gerais é normalizada com zeros à esquerda até 13 dígitos. Atualiza `DateLastRecordModification` do cliente.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCountry\": 2270,\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingCity\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "79f1e2b5-8bbd-4ee0-82b3-5997da73563f", "name": "Endereço atualizado. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCountry\": 2270,\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingCity\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f682b919-559f-4907-934d-a8e6aa9043c0", "name": "Validações: `[BadRequest] - Endereço não existe` (endereço não pertence ao cliente ou à empresa autenticada); `[BadRequest] - País não existe`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCountry\": 2270,\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingCity\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81df1f70-b477-41f7-b9f7-7924d585b5f4", "name": "Mensagem retornada pela consulta de CEP quando ela falha. Demais erros com prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCountry\": 2270,\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingCity\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ConsumerStateInscription\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2aa6ef61-4ec4-4684-8bea-93cb609c2c4d", "name": "Remove um endereço do cliente", "request": { "name": "Remove um endereço do cliente", "description": { "content": "Marca o endereço como inativo (`StatusAddress=0`). O registro fica preservado para histórico de pedidos antigos.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "06f57beb-7aae-4472-b16e-7565e42d3719", "name": "Endereço removido. Retorna a lista atualizada de endereços ativos do cliente (mesmo shape de `GET /consumer/{idconsumer}/address`).", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDAddress\": 5466,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2977,\n \"StatusAddress\": 2559,\n \"RecordTimestamp\": \"2017-02-02T05:03:35.416Z\",\n \"IDCountry\": 657,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 1269,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 464,\n \"StatusAddress\": 4780,\n \"RecordTimestamp\": \"1994-07-09T22:44:21.157Z\",\n \"IDCountry\": 6350,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "787ec5ab-64ff-461b-8b29-d28e65643265", "name": "`[BadRequest] - Consumer Address não existe` quando o endereço não pertence ao cliente ou à empresa autenticada.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58e9cc82-7874-4cbd-8dda-fd9ca8de846f", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "address", ":idaddress" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaddress", "description": "(Required) Identificador do endereço." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "616cc276-c494-41c7-937e-54b45deae03a", "name": "Cadastra um contato para o cliente", "request": { "name": "Cadastra um contato para o cliente", "description": { "content": "Cria um contato vinculado ao cliente. Aceita também a chave `ContactTelephon` (typo histórico) como fallback para `ContactTelephone`. Se `LegalRepresentative` não for enviado, é gravado como `0`.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d3c14a3b-b723-424a-b45e-eb049165662d", "name": "Contato criado. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eecf103-8189-45db-8760-66ed935749c0", "name": "`[BadRequest] - Consumidor não existe` quando o cliente não pertence à empresa autenticada.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62c7cba8-129b-4cb8-9bfd-aabc8028a31f", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c470ce17-4ede-45aa-8a11-bac783a8929d", "name": "Atualiza um contato do cliente", "request": { "name": "Atualiza um contato do cliente", "description": { "content": "Atualização parcial — apenas os campos enviados são gravados no banco.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 5932\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7ba5f339-7377-4d61-9326-4c8d203aeffa", "name": "Contato atualizado. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 5932\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79f3fb15-508d-4d14-ab86-c12b74f92e90", "name": "`[BadRequest] - Cliente não existe` quando o contato não pertence ao cliente ou à empresa autenticada.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 5932\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6d08e686-0c2e-4abf-b1d1-181e3456b141", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 5932\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd5f8924-5e9a-47bc-9765-075bb9d3bef0", "name": "Remove um contato do cliente", "request": { "name": "Remove um contato do cliente", "description": { "content": "Exclui fisicamente o contato.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ba230294-da3b-4b93-84b3-e4dee9718b68", "name": "Contato removido. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4e00c3-20cd-4fc3-aaaf-bfbf4f9e0d91", "name": "`[BadRequest] - Consumidor não existe` quando o cliente não pertence à empresa autenticada.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a3532a7e-f51d-42c5-a4d5-f0d6c6fa6621", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "contact", ":idconsumercontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "762d8312-f9c2-4e4e-892a-830abd3c7030", "name": "Cadastra um limite de crédito para o cliente", "request": { "name": "Cadastra um limite de crédito para o cliente", "description": { "content": "Cria um limite de crédito vinculado a uma forma de pagamento. Cada cliente pode ter no máximo um crédito por forma de pagamento — tentar cadastrar uma segunda entrada na mesma forma é rejeitado. A operação é registrada no histórico de alterações do cliente (`ConsumerLog`).", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6eddd890-72be-4a21-af10-c6a3597eca9c", "name": "Crédito cadastrado. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4188962-2077-45c5-a7e6-16ac304c1dcf", "name": "Validações: `[BadRequest] - Cliente não encontrado`; `[BadRequest] - Tipo Pagamento não cadastrado` (forma de pagamento não existe ou não pertence à empresa); `[BadRequest] - Já existe essa forma de crédito cadastrada para o cliente`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b74fc97-d9fd-483a-ae9a-1782b2781a79", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a74984b-194c-4819-83e4-3b12cf995a5e", "name": "Atualiza um limite de crédito do cliente", "request": { "name": "Atualiza um limite de crédito do cliente", "description": { "content": "Atualiza valor, forma de pagamento e condições comerciais do crédito. Não pode trocar `IDTypePayment` para uma forma já usada em outro crédito do mesmo cliente. A operação é registrada no histórico de alterações do cliente.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3b00b1dd-da62-4f2e-9b9e-94a967cbc84a", "name": "Crédito atualizado. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa34a1d-8624-4586-a7c7-efeb0fb841c8", "name": "Validações: `[BadRequest] - Cliente não encontrado` (crédito não pertence ao cliente ou à empresa); `[BadRequest] - Tipo Pagamento não cadastrado`; `[BadRequest] - Já existe essa forma de crédito cadastrada para o cliente`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "197eb6af-a1cd-42ac-8724-54800d002170", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 1481,\n \"CreditValue\": 3742.73,\n \"CommercialConditions\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d34941a8-662b-4aca-b880-c38d2802fdc7", "name": "Remove um limite de crédito do cliente", "request": { "name": "Remove um limite de crédito do cliente", "description": { "content": "Exclui o registro de crédito. A exclusão é registrada no histórico de alterações do cliente com o valor e a forma de pagamento removidos.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "478ca1d3-3bd8-41a4-a928-b994d61e7b72", "name": "Crédito removido. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80a2d5ba-ab0c-418b-a903-8caf8e1be30e", "name": "`[BadRequest] - Crédito cliente não encontrado` quando o crédito não pertence ao cliente ou à empresa autenticada.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc300037-761f-48f0-aecf-f47a6b4ddf6d", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "credit", ":idconsumercredit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumercredit", "description": "(Required) Identificador do registro de crédito." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e861198a-0e41-4b09-8755-4326c12d975a", "name": "Lista os movimentos de vale do cliente", "request": { "name": "Lista os movimentos de vale do cliente", "description": { "content": "Retorna todos os movimentos de vale (entradas e saídas) do cliente, ordenados por data de gravação decrescente. Inclui o saldo acumulado por cliente + faturador (`BalanceValue`) calculado em janela ordenada.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "voucher" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra os movimentos pelo faturador (empresa que detém o saldo). Quando ausente, retorna movimentos de todos os faturadores do cliente." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f95b43bf-a43f-4121-8208-0e44c11328bd", "name": "Lista de movimentos de vale.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "voucher" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumerVoucher\": 4249,\n \"IDConsumer\": 3122,\n \"IDOrder\": 9544,\n \"Value\": 1430.04,\n \"IDTypeAccount\": 0,\n \"RecordUserCreated\": 2167,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 8828,\n \"RecordTimestamp\": \"2004-09-15T08:43:11.612Z\",\n \"AccountName\": \"string\",\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"BalanceValue\": 3550.73\n },\n {\n \"IDConsumerVoucher\": 8000,\n \"IDConsumer\": 1906,\n \"IDOrder\": 9403,\n \"Value\": 91.95,\n \"IDTypeAccount\": 0,\n \"RecordUserCreated\": 7192,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 538,\n \"RecordTimestamp\": \"1997-05-11T02:02:05.637Z\",\n \"AccountName\": \"string\",\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"BalanceValue\": 6610.95\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704ed6c1-545e-4b1f-8baf-44ba89c472d1", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "voucher" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c057c3e-c35f-4869-8b7b-3b1631afc60d", "name": "Gera um vale para o cliente", "request": { "name": "Gera um vale para o cliente", "description": { "content": "Registra um movimento de entrada (`IDTypeAccount=0`) — credita um vale a favor do cliente. O valor precisa ser numérico e estritamente positivo. Quando `IDCompanyInvoice` é informado e difere da empresa do cliente, o faturador é validado como faturador filho (`CompanyMain`); ausente, o vale é vinculado à própria empresa do cliente. A operação é registrada no histórico de alterações do cliente (`ConsumerLog`).", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Value\": 6618.360000000001,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 7122\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "645d4fff-d716-4f8e-943a-3a40b8c5137e", "name": "Vale criado. Retorna a lista atualizada de movimentos de vale do cliente (mesmo shape de `GET /consumer/{idconsumer}/voucher`).", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Value\": 6618.360000000001,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 7122\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumerVoucher\": 4249,\n \"IDConsumer\": 3122,\n \"IDOrder\": 9544,\n \"Value\": 1430.04,\n \"IDTypeAccount\": 0,\n \"RecordUserCreated\": 2167,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 8828,\n \"RecordTimestamp\": \"2004-09-15T08:43:11.612Z\",\n \"AccountName\": \"string\",\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"BalanceValue\": 3550.73\n },\n {\n \"IDConsumerVoucher\": 8000,\n \"IDConsumer\": 1906,\n \"IDOrder\": 9403,\n \"Value\": 91.95,\n \"IDTypeAccount\": 0,\n \"RecordUserCreated\": 7192,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 538,\n \"RecordTimestamp\": \"1997-05-11T02:02:05.637Z\",\n \"AccountName\": \"string\",\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"BalanceValue\": 6610.95\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56f9725d-5f27-47b2-a64a-2a40080a3e66", "name": "Validações: `[BadRequest] - precisa informar um valor válido para gerar vale` (valor não numérico); `[BadRequest] - precisa informar um valor positivo para gerar vale`; `[BadRequest] - Cliente não existe`; `[BadRequest] - Faturador não existe`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Value\": 6618.360000000001,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 7122\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d87024e3-6969-4f6d-9d10-bd7432cb4d58", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Value\": 6618.360000000001,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 7122\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b1d7a4d-8608-4cbb-9a90-24e7825ea447", "name": "Remove um vale do cliente", "request": { "name": "Remove um vale do cliente", "description": { "content": "Exclui um movimento de vale do cliente. A exclusão só é aceita quando o saldo de vale do cliente — soma de todas as entradas menos todas as saídas — for maior ou igual ao valor do movimento que se quer excluir; caso contrário o valor já foi (parcial ou totalmente) utilizado e a operação é bloqueada. A verificação é feita sobre o saldo consolidado do cliente e vale para qualquer movimento, inclusive os de saída. A exclusão é registrada no histórico de alterações do cliente com o valor do vale removido; o `Comments` enviado é acrescentado a esse registro.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "voucher", ":idconsumervoucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumervoucher", "description": "(Required) Identificador do movimento de vale." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c401e3f5-3056-4579-94f9-6d65f49774f8", "name": "Vale removido. Retorna a lista atualizada de movimentos de vale do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "voucher", ":idconsumervoucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumervoucher", "description": "(Required) Identificador do movimento de vale." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumerVoucher\": 4249,\n \"IDConsumer\": 3122,\n \"IDOrder\": 9544,\n \"Value\": 1430.04,\n \"IDTypeAccount\": 0,\n \"RecordUserCreated\": 2167,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 8828,\n \"RecordTimestamp\": \"2004-09-15T08:43:11.612Z\",\n \"AccountName\": \"string\",\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"BalanceValue\": 3550.73\n },\n {\n \"IDConsumerVoucher\": 8000,\n \"IDConsumer\": 1906,\n \"IDOrder\": 9403,\n \"Value\": 91.95,\n \"IDTypeAccount\": 0,\n \"RecordUserCreated\": 7192,\n \"Comments\": \"string\",\n \"IDCompanyInvoice\": 538,\n \"RecordTimestamp\": \"1997-05-11T02:02:05.637Z\",\n \"AccountName\": \"string\",\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"BalanceValue\": 6610.95\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a74d82e-1f73-46a6-902e-70290cd35f15", "name": "Mensagens (prefixo `[BadRequest]`): `Vale cliente não existe`; `Vale não pode ser excluído pois já teve seu valor (parcial ou total) utilizado`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "voucher", ":idconsumervoucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumervoucher", "description": "(Required) Identificador do movimento de vale." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "637898da-e3bb-4372-8d1b-fe9fe0ca4176", "name": "Vincula um vendedor ao cliente", "request": { "name": "Vincula um vendedor ao cliente", "description": { "content": "Associa um vendedor (`IDAcess` ativo da mesma empresa do cliente) ao cliente. A combinação cliente + vendedor é única; um vínculo já existente é atualizado em vez de duplicado (upsert). A operação é registrada no histórico de alterações do cliente.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "salesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDAcess\": 8642\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3f093781-56e1-430b-91de-87ec9362198a", "name": "Vínculo registrado. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "salesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDAcess\": 8642\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f40bbb-465a-42fd-b6fe-02f35e82142a", "name": "Validações: `[BadRequest] - Cliente não existe`; `[BadRequest] - Vendedor não existe` (`IDAcess` não pertence à empresa do cliente ou o vínculo `UserCompany` está inativo).", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "salesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDAcess\": 8642\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a8942f6e-a6eb-4455-8016-e5dc2b5bea92", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "salesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDAcess\": 8642\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3cf1914-821f-418c-a7e3-ba8295964d3f", "name": "Remove o vínculo de vendedor do cliente", "request": { "name": "Remove o vínculo de vendedor do cliente", "description": { "content": "Exclui o vínculo cliente-vendedor. A operação é registrada no histórico de alterações do cliente, incluindo o login do vendedor removido.", "type": "text/plain" }, "url": { "path": [ "consumer", ":idconsumer", "salesman", ":idconsumersalesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumersalesman", "description": "(Required) Identificador do vínculo cliente-vendedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "83f566c1-472d-4dce-a75c-796ff2a61a7c", "name": "Vínculo removido. Retorna o detalhe completo do cliente.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "salesman", ":idconsumersalesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumersalesman", "description": "(Required) Identificador do vínculo cliente-vendedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDConsumer\": 2032,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1947-02-07\",\n \"ConsumerType\": 1,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 2401,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 7006,\n \"StatusAddress\": 4327,\n \"RecordTimestamp\": \"1996-08-21T11:43:37.158Z\",\n \"IDCountry\": 8950,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 3311,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 8565,\n \"StatusAddress\": 3286,\n \"RecordTimestamp\": \"1962-02-22T10:50:21.368Z\",\n \"IDCountry\": 3728,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2354,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2019-03-14T16:02:02.353Z\"\n },\n {\n \"IDConsumerContact\": 2651,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"1948-09-25T11:33:50.244Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 9359,\n \"IDTypePayment\": 7933,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 197.11,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3053.02,\n \"CreditValueLeft\": 1511.83\n },\n {\n \"IDConsumerCredit\": 4635,\n \"IDTypePayment\": 3896,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3774.73,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 5570.6900000000005,\n \"CreditValueLeft\": 4099.04\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 3966,\n \"IDAcess\": 1194,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-01-22T06:09:01.426Z\"\n },\n {\n \"IDConsumerSalesman\": 511,\n \"IDAcess\": 6466,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2023-11-23T12:48:01.998Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": 962.4439399905316\n },\n {\n \"key_0\": true,\n \"key_1\": 6399.782752917092\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 3032.611308614628\n },\n {\n \"key_0\": 7172.990817802507,\n \"key_1\": 5365\n }\n ],\n \"ConsumerVoucherValue\": 8203.03,\n \"OrderQuantity\": 1874,\n \"OrderRevenueValueTotal\": 9187.08,\n \"RecordTimestamp\": \"1997-02-16T23:48:03.010Z\",\n \"DateLastRecordModification\": \"1949-02-10T04:58:11.272Z\"\n },\n {\n \"IDConsumer\": 6200,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerTradeName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"ConsumerBirthDate\": \"1968-12-18\",\n \"ConsumerType\": 3,\n \"NfeSuframa\": \"string\",\n \"StatusConsumer\": 3,\n \"Address\": [\n {\n \"IDAddress\": 3332,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 5242,\n \"StatusAddress\": 2429,\n \"RecordTimestamp\": \"1987-10-16T21:03:23.360Z\",\n \"IDCountry\": 7920,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n },\n {\n \"IDAddress\": 8066,\n \"ConsumerStateInscription\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingStreet\": \"string\",\n \"ShippingIbgeCode\": 2939,\n \"StatusAddress\": 4306,\n \"RecordTimestamp\": \"1970-08-23T10:44:40.222Z\",\n \"IDCountry\": 8014,\n \"Country\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\"\n }\n ],\n \"Contacts\": [\n {\n \"IDConsumerContact\": 2660,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2023-04-30T01:54:12.830Z\"\n },\n {\n \"IDConsumerContact\": 7138,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"LegalRepresentative\": 0,\n \"RecordTimestamp\": \"2002-07-18T11:59:13.865Z\"\n }\n ],\n \"ConsumerCredit\": [\n {\n \"IDConsumerCredit\": 4907,\n \"IDTypePayment\": 3966,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 3517.63,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 8539.76,\n \"CreditValueLeft\": 1573.8\n },\n {\n \"IDConsumerCredit\": 3573,\n \"IDTypePayment\": 497,\n \"TypePaymentDescription\": \"string\",\n \"CreditValue\": 4226.25,\n \"CommercialConditions\": \"string\",\n \"CreditValueUsed\": 3488.21,\n \"CreditValueLeft\": 6654.91\n }\n ],\n \"ConsumerSalesman\": [\n {\n \"IDConsumerSalesman\": 6625,\n \"IDAcess\": 8970,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"1954-11-18T13:30:08.508Z\"\n },\n {\n \"IDConsumerSalesman\": 743,\n \"IDAcess\": 7196,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestamp\": \"2014-08-17T14:24:29.370Z\"\n }\n ],\n \"ConsumerLog\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 8875.855474333766,\n \"key_1\": true\n }\n ],\n \"ConsumerFile\": [\n {\n \"key_0\": 6571,\n \"key_1\": 8036\n },\n {\n \"key_0\": 5260.11717186287\n }\n ],\n \"ConsumerVoucherValue\": 9291.25,\n \"OrderQuantity\": 1533,\n \"OrderRevenueValueTotal\": 1011.72,\n \"RecordTimestamp\": \"2013-10-23T07:55:12.260Z\",\n \"DateLastRecordModification\": \"2019-02-26T19:26:32.632Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89df704e-1e87-4ac9-b931-658ee55c908e", "name": "`[BadRequest] - Vendedor associado ao cliente não existe` quando o vínculo não pertence ao cliente ou à empresa autenticada.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "salesman", ":idconsumersalesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumersalesman", "description": "(Required) Identificador do vínculo cliente-vendedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2179642-c57d-4b0b-80fc-9d83bed1e6b6", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "consumer", ":idconsumer", "salesman", ":idconsumersalesman" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idconsumer", "description": "(Required) Identificador do cliente." }, { "disabled": false, "type": "any", "value": "2232", "key": "idconsumersalesman", "description": "(Required) Identificador do vínculo cliente-vendedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "91d9fc52-9fad-4907-b757-2abeb4b93daf", "name": "Cadastro de Fornecedores", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8b0b1e66-e279-46fb-ae44-dac496b49633", "name": "Lista fornecedores e transportadoras", "request": { "name": "Lista fornecedores e transportadoras", "description": { "content": "Retorna o catálogo de fornecedores (e transportadoras — compartilham o mesmo cadastro) da empresa autenticada. Apenas cadastros ativos (`SupplierStatus=1`) entram na resposta. Aceita filtros por categoria, tipo de fornecedor, CPF/CNPJ, sinal de leilão de frete e nome; aceita ainda uma busca textual genérica (`Search`) que cruza nome, e-mail, CPF/CNPJ e id.\n\nQuando o usuário tem categorias de fornecedor vinculadas em **Configurações → Usuários** **e** a parametrização **Permitir visualizar registros apenas fornecedores vinculados ao usuário** está ativada, o resultado é automaticamente restrito a essas categorias. Paginação por `Page` com 2000 itens por página.", "type": "text/plain" }, "url": { "path": [ "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "0", "description": "Página (2000 itens por página)." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca textual genérica. O texto é separado em letras (nome/e-mail) e dígitos (CPF/CNPJ/id) e cruzado contra `SupplierNameCorporateName`, `SupplierEmail`, `SupplierCpfCnpj` e `IDSupplier`." }, { "disabled": false, "key": "SupplierNameCorporateName", "value": "string", "description": "Filtra pelo nome ou razão social (LIKE)." }, { "disabled": false, "key": "SupplierCpfCnpj", "value": "string", "description": "Filtra pelo CPF ou CNPJ (LIKE, somente dígitos)." }, { "disabled": false, "key": "IDSupplierCategory", "value": "string", "description": "Filtra por uma ou mais categorias de fornecedor. Lista separada por vírgula." }, { "disabled": false, "key": "IDTypeSupplier", "value": "2232", "description": "Filtra pelo tipo de fornecedor (vinculado à categoria)." }, { "disabled": false, "key": "CarrierAuction", "value": "1", "description": "Filtra transportadoras que participam (1) ou não (0) do leilão de frete." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "682f8b44-4023-4839-b86a-7e472b8d4c81", "name": "Lista de fornecedores ativos.", "originalRequest": { "url": { "path": [ "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "Search", "value": "string" }, { "key": "SupplierNameCorporateName", "value": "string" }, { "key": "SupplierCpfCnpj", "value": "string" }, { "key": "IDSupplierCategory", "value": "string" }, { "key": "IDTypeSupplier", "value": "2232" }, { "key": "CarrierAuction", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 589,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 1,\n \"SupplierEmail\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"IDSupplierCategory\": 3328,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 3948,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 4903,\n \"PixKey\": \"string\",\n \"IDTypeAccountPayableReceivable\": 3298,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDCarrierType\": 6300,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDCarrierGateway\": 1067,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 1606,\n \"CarrierModal\": \"string\",\n \"CarrierAuction\": 9475,\n \"CarrierRateUploadStatusDescription\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1\n },\n {\n \"IDSupplier\": 2144,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 2,\n \"SupplierEmail\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"IDSupplierCategory\": 7885,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 9549,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 1683,\n \"PixKey\": \"string\",\n \"IDTypeAccountPayableReceivable\": 178,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDCarrierType\": 7542,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDCarrierGateway\": 3084,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 8417,\n \"CarrierModal\": \"string\",\n \"CarrierAuction\": 7379,\n \"CarrierRateUploadStatusDescription\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e0666de-dfa2-4c81-b2e3-26445249aecb", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "Search", "value": "string" }, { "key": "SupplierNameCorporateName", "value": "string" }, { "key": "SupplierCpfCnpj", "value": "string" }, { "key": "IDSupplierCategory", "value": "string" }, { "key": "IDTypeSupplier", "value": "2232" }, { "key": "CarrierAuction", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06ee207e-9bb6-4ea4-8204-63fef9082503", "name": "Cadastra um fornecedor", "request": { "name": "Cadastra um fornecedor", "description": { "content": "Cria um novo fornecedor (ou transportadora — depende da categoria informada). Quando `SupplierCpfCnpj` é informado, o sistema tenta consultar a base pública de CNPJ (`publica.cnpj.ws`) com timeout de 5 s. Se a consulta retornar com sucesso (típico para CNPJ válido), os campos de endereço, telefone, e-mail, razão social, nome fantasia, inscrição estadual e data de início de atividade são **sobrescritos** com os dados da Receita — qualquer valor enviado no corpo para esses campos é ignorado. Em caso de falha (CPF, CNPJ inexistente, timeout, indisponibilidade do serviço externo), o sistema cai de volta para os valores do corpo.\n\n`SupplierCpfCnpj` aceita **CNPJ alfanumérico** (válido a partir de 2026): o valor é convertido para maiúsculas e as letras são preservadas como parte do documento. Quando o valor é apenas numérico, ficam apenas os dígitos. Em ambos os casos o documento é completado com zeros à esquerda até 11 caracteres (CPF) ou 14 (CNPJ).\n\nQuando a parametrização **Bloquear cadastro duplicado de fornecedor** (`BlockDuplicateSupplier`, grupo *Fornecedor*) está ativada, o sistema bloqueia o cadastro se já existir outro fornecedor ativo com o mesmo CPF/CNPJ.\n\nOs parâmetros de transportadora `IDCarrierGateway` e `IDCarrierType` são aceitos no corpo mas **não são gravados na criação** — defina-os depois, em `PUT /supplier/{idsupplier}`.\n\nA resposta é o detalhe completo do fornecedor recém-criado (mesmo formato de `GET /supplier/{idsupplier}`).", "type": "text/plain" }, "url": { "path": [ "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 5785,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1972-10-06\",\n \"IDSupplierCivilStatus\": 2,\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 5918,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"SupplierProductLeadTimeDays\": 3807,\n \"SupplierProductReliability\": 1943,\n \"CarrierAuction\": 311,\n \"CarrierAuctionPenalty\": 137,\n \"CarrierAdditionalBusinessDays\": 4173,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 5313,\n \"CarrierCubageKmM\": 6874.167252268592,\n \"CarrierCubageFreeWeight\": 5424.845969406857,\n \"PrintDanfeA4\": 7845,\n \"LabelAndDanfeSamePage\": 8189,\n \"CarrierCollectionListEmail\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b429239e-4a9f-4743-a5dc-bbdad360e10b", "name": "Fornecedor criado. Retorna o cadastro completo.", "originalRequest": { "url": { "path": [ "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 5785,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1972-10-06\",\n \"IDSupplierCivilStatus\": 2,\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 5918,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"SupplierProductLeadTimeDays\": 3807,\n \"SupplierProductReliability\": 1943,\n \"CarrierAuction\": 311,\n \"CarrierAuctionPenalty\": 137,\n \"CarrierAdditionalBusinessDays\": 4173,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 5313,\n \"CarrierCubageKmM\": 6874.167252268592,\n \"CarrierCubageFreeWeight\": 5424.845969406857,\n \"PrintDanfeA4\": 7845,\n \"LabelAndDanfeSamePage\": 8189,\n \"CarrierCollectionListEmail\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 8144,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 1,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1991-08-30\",\n \"IDSupplierCivilStatus\": 3,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 1106,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 3899,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 7492,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 3334,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 3965,\n \"SupplierProductLeadTimeDays\": 7591,\n \"SupplierProductReliability\": 639,\n \"IDCompanyIntegration\": 6592,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 6828,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1,\n \"IDCarrierType\": 6027,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 2663,\n \"IDCarrierGateway\": 3731,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 7211,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 2257,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 4711,\n \"CarrierAuctionPenalty\": 9518.219621853572,\n \"CarrierAdditionalBusinessDays\": 7127,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 9761,\n \"CarrierCubageKmM\": 3273,\n \"CarrierCubageFreeWeight\": 46.913765963594315,\n \"CarrierPriceRounding\": 406.66086582733965,\n \"CarrierOrdersLimitPerCollection\": 5903,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 4524,\n \"CarrierRateUploadStatus\": 0,\n \"CarrierRateUploadStatusDescription\": \"Processando\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 1,\n \"PrintDanfeA4\": 0,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 0,\n \"RecordTimestamp\": \"2021-02-23T07:50:32.552Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 3386,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1995-12-10T03:21:09.852Z\"\n },\n {\n \"IDSuppliersContact\": 3044,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"2015-06-18T06:06:45.007Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 5341,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 8598,\n \"RangeFinal\": 3964,\n \"CurrentRange\": 2178,\n \"DiffRange\": 4850\n },\n {\n \"IDCorreiosSroRange\": 8354,\n \"Status\": 1,\n \"Prefix\": \"string\",\n \"RangeInitial\": 6915,\n \"RangeFinal\": 782,\n \"CurrentRange\": 2917,\n \"DiffRange\": 5645\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 5629,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1998-06-13T16:25:12.760Z\",\n \"Main\": 1\n },\n {\n \"IDCarrierTableUpload\": 7886,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1948-11-03T13:45:43.991Z\",\n \"Main\": 1\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 9250,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 5059.156651581522,\n \"RecordTimestamp\": \"1996-03-01T08:20:16.044Z\"\n },\n {\n \"IDTypeCostCenter\": 8742,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 6873.244364549616,\n \"RecordTimestamp\": \"1963-06-19T10:11:25.696Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e142269-c6e0-43ed-819c-aae62d4bbc44", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Já existe um fornecedor com esse CPF/CNPJ` (quando `BlockDuplicateSupplier=1`)\n- `Categoria fornecedor não existe`\n- `Empresa não existe`", "originalRequest": { "url": { "path": [ "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 5785,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1972-10-06\",\n \"IDSupplierCivilStatus\": 2,\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 5918,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"SupplierProductLeadTimeDays\": 3807,\n \"SupplierProductReliability\": 1943,\n \"CarrierAuction\": 311,\n \"CarrierAuctionPenalty\": 137,\n \"CarrierAdditionalBusinessDays\": 4173,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 5313,\n \"CarrierCubageKmM\": 6874.167252268592,\n \"CarrierCubageFreeWeight\": 5424.845969406857,\n \"PrintDanfeA4\": 7845,\n \"LabelAndDanfeSamePage\": 8189,\n \"CarrierCollectionListEmail\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c86e5348-834e-4e46-a7cd-4087061443ec", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 5785,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1972-10-06\",\n \"IDSupplierCivilStatus\": 2,\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 5918,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"SupplierProductLeadTimeDays\": 3807,\n \"SupplierProductReliability\": 1943,\n \"CarrierAuction\": 311,\n \"CarrierAuctionPenalty\": 137,\n \"CarrierAdditionalBusinessDays\": 4173,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 5313,\n \"CarrierCubageKmM\": 6874.167252268592,\n \"CarrierCubageFreeWeight\": 5424.845969406857,\n \"PrintDanfeA4\": 7845,\n \"LabelAndDanfeSamePage\": 8189,\n \"CarrierCollectionListEmail\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e594603-6daf-49dc-a281-e3ecf29848f6", "name": "Detalha um fornecedor ou transportadora", "request": { "name": "Detalha um fornecedor ou transportadora", "description": { "content": "Retorna o cadastro completo de um fornecedor. O mesmo cadastro também é usado para transportadoras — os campos com prefixo `Carrier*` ficam preenchidos apenas quando o fornecedor opera como transportadora.\n\nA resposta inclui descrições resolvidas dos relacionamentos (categoria, tipo de fornecedor, integração, banco, estado civil, plano de contas), uma lista de contatos, faixas de SRO dos Correios (transportadoras), uploads de tabela de frete (transportadoras), centros de custo padrão para os títulos gerados e um campo textual com o status do último upload de tabela de frete.\n\nNão retorna erro quando o id não existe ou não pertence à empresa — a resposta é `200 []`.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ee42d3e6-71da-4f22-83e2-2f82c5e7485a", "name": "Fornecedor encontrado (array com 1 item) ou array vazio quando o id não pertence à empresa autenticada.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 5725,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 1,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1951-05-19\",\n \"IDSupplierCivilStatus\": 2,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 8671,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7129,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 8283,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 5488,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 7879,\n \"SupplierProductLeadTimeDays\": 8701,\n \"SupplierProductReliability\": 1112,\n \"IDCompanyIntegration\": 8031,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 2491,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1,\n \"IDCarrierType\": 9534,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 2900,\n \"IDCarrierGateway\": 7931,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 9474,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 3233,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 5468,\n \"CarrierAuctionPenalty\": 2134.0723880243195,\n \"CarrierAdditionalBusinessDays\": 5802,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 733,\n \"CarrierCubageKmM\": 5290,\n \"CarrierCubageFreeWeight\": 9930.502282038457,\n \"CarrierPriceRounding\": 371.69074070499744,\n \"CarrierOrdersLimitPerCollection\": 1157,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 851,\n \"CarrierRateUploadStatus\": 1,\n \"CarrierRateUploadStatusDescription\": \"Sucesso\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 0,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 1,\n \"RecordTimestamp\": \"1954-01-25T22:07:56.838Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 1180,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"2013-09-17T13:41:01.157Z\"\n },\n {\n \"IDSuppliersContact\": 5253,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1991-10-05T13:49:30.861Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 8283,\n \"Status\": 1,\n \"Prefix\": \"string\",\n \"RangeInitial\": 4887,\n \"RangeFinal\": 9833,\n \"CurrentRange\": 6487,\n \"DiffRange\": 6891\n },\n {\n \"IDCorreiosSroRange\": 1823,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 2485,\n \"RangeFinal\": 6723,\n \"CurrentRange\": 6571,\n \"DiffRange\": 9102\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 1481,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1963-11-11T04:01:32.076Z\",\n \"Main\": 1\n },\n {\n \"IDCarrierTableUpload\": 9907,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"2006-02-09T11:32:58.094Z\",\n \"Main\": 0\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 2801,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 5208.700023527457,\n \"RecordTimestamp\": \"1975-11-27T13:09:06.130Z\"\n },\n {\n \"IDTypeCostCenter\": 5898,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 6049.338296252194,\n \"RecordTimestamp\": \"1972-09-28T15:26:47.981Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 0\n },\n {\n \"IDSupplier\": 786,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 7,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1963-02-20\",\n \"IDSupplierCivilStatus\": 1,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 2736,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 3450,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 9909,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 4413,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 1175,\n \"SupplierProductLeadTimeDays\": 8786,\n \"SupplierProductReliability\": 7207,\n \"IDCompanyIntegration\": 8956,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 5256,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1,\n \"IDCarrierType\": 8400,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 1288,\n \"IDCarrierGateway\": 3622,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 8056,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 7850,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 7575,\n \"CarrierAuctionPenalty\": 8483.264153805294,\n \"CarrierAdditionalBusinessDays\": 7172,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 4494,\n \"CarrierCubageKmM\": 8935,\n \"CarrierCubageFreeWeight\": 8688.999089779987,\n \"CarrierPriceRounding\": 9718.510799279793,\n \"CarrierOrdersLimitPerCollection\": 7112,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 6591,\n \"CarrierRateUploadStatus\": 3,\n \"CarrierRateUploadStatusDescription\": \"Erro\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 1,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 0,\n \"RecordTimestamp\": \"1985-10-12T12:51:50.403Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 1452,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1967-07-26T14:36:46.887Z\"\n },\n {\n \"IDSuppliersContact\": 967,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"2007-03-18T12:24:56.500Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 7269,\n \"Status\": 1,\n \"Prefix\": \"string\",\n \"RangeInitial\": 4645,\n \"RangeFinal\": 1399,\n \"CurrentRange\": 2237,\n \"DiffRange\": 1785\n },\n {\n \"IDCorreiosSroRange\": 9674,\n \"Status\": 1,\n \"Prefix\": \"string\",\n \"RangeInitial\": 6067,\n \"RangeFinal\": 1583,\n \"CurrentRange\": 8523,\n \"DiffRange\": 2592\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 6926,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1993-01-11T10:41:55.836Z\",\n \"Main\": 0\n },\n {\n \"IDCarrierTableUpload\": 9396,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1973-10-17T08:25:31.212Z\",\n \"Main\": 1\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 4518,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 6943.379108017484,\n \"RecordTimestamp\": \"2017-03-24T13:26:03.046Z\"\n },\n {\n \"IDTypeCostCenter\": 9655,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 1567.1143880552506,\n \"RecordTimestamp\": \"2004-09-24T10:51:38.564Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 0\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1b9a8a5-e361-4c93-86ad-7f3db431d599", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69900ee3-b74d-471b-9a61-6e7435fffdeb", "name": "Atualiza um fornecedor", "request": { "name": "Atualiza um fornecedor", "description": { "content": "Atualiza parcialmente o cadastro do fornecedor — apenas os campos enviados no corpo são alterados. As validações disparam quando os campos correspondentes vêm preenchidos:\n\n- Se `SupplierCpfCnpj` mudar **e** a parametrização **Bloquear cadastro duplicado de fornecedor** estiver ativa, o sistema bloqueia o salvamento quando já existe outro fornecedor ativo com o mesmo documento. O campo aceita **CNPJ alfanumérico** (válido a partir de 2026): o valor é convertido para maiúsculas, as letras são preservadas como parte do documento e o resultado é completado com zeros à esquerda até 11 caracteres (CPF) ou 14 (CNPJ).\n- Se `IDSupplierCategory` for informado, a categoria precisa pertencer à empresa autenticada.\n- Se `IDTypeAccountPayableReceivable` for informado, o plano de contas precisa existir na empresa.\n- Se `IDCompanyLabel` mudar, o template de etiqueta precisa pertencer à empresa autenticada ou à empresa-padrão de etiquetas (id 54) e ser do tipo etiqueta de transportadora.\n- Se `CarrierAuction=1` e o fornecedor ainda não tinha `CarrierQuotationExternalId`, o sistema atribui um id sequencial dentro da empresa.\n\nSempre que o cadastro muda para/de transportadora, a lista de transportadoras de leilão de frete é regravada.\n\n**Atenção:** `SupplierBirthDate` é a única exceção à atualização parcial — o campo é gravado em toda chamada, então omiti-lo, ou enviá-lo vazio, apaga a data já cadastrada. Reenvie o valor atual sempre que salvar.\n\nA resposta é o detalhe completo do fornecedor atualizado.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 6662,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1980-09-27\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 8032,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 2855,\n \"PrintDanfe\": 1964,\n \"PrintDanfeA4\": 8421,\n \"LabelAndDanfeSamePage\": 28,\n \"ManualLabel\": 2038,\n \"IDCompanyIntegration\": 4718,\n \"IDCompanyLabel\": 5467,\n \"IDTypeAccountPayableReceivable\": 2471,\n \"SupplierProductLeadTimeDays\": 7297,\n \"SupplierProductReliability\": 496,\n \"CarrierAuction\": 3589,\n \"CarrierAuctionPenalty\": 7357,\n \"IDCarrierGateway\": 1,\n \"IDCarrierType\": 8236,\n \"IDCarrierModal\": 4234,\n \"CarrierShippingIdRule\": 207,\n \"CarrierAdditionalBusinessDays\": 3789,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 7545,\n \"CarrierCubageKmM\": 1516.0768674518965,\n \"CarrierCubageFreeWeight\": 792.5627852825489,\n \"CarrierPriceRounding\": 4655.3067975267595,\n \"CarrierOrdersLimitPerCollection\": 3030,\n \"CarrierCollectionListEmail\": \"string\",\n \"IgnoreCollectionList\": 5645,\n \"ContentDeclarationStates\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4ec26905-00b0-4841-aa2c-ddfd526521a4", "name": "Fornecedor atualizado.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 665,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1963-02-21\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 8710,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 8555,\n \"PrintDanfe\": 9126,\n \"PrintDanfeA4\": 4425,\n \"LabelAndDanfeSamePage\": 6388,\n \"ManualLabel\": 8945,\n \"IDCompanyIntegration\": 2977,\n \"IDCompanyLabel\": 1287,\n \"IDTypeAccountPayableReceivable\": 8416,\n \"SupplierProductLeadTimeDays\": 7261,\n \"SupplierProductReliability\": 9738,\n \"CarrierAuction\": 6207,\n \"CarrierAuctionPenalty\": 1881,\n \"IDCarrierGateway\": 2,\n \"IDCarrierType\": 1315,\n \"IDCarrierModal\": 1118,\n \"CarrierShippingIdRule\": 7191,\n \"CarrierAdditionalBusinessDays\": 5383,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 1312,\n \"CarrierCubageKmM\": 1890.4323440665016,\n \"CarrierCubageFreeWeight\": 4559.21387871997,\n \"CarrierPriceRounding\": 7321.1976208001,\n \"CarrierOrdersLimitPerCollection\": 7436,\n \"CarrierCollectionListEmail\": \"string\",\n \"IgnoreCollectionList\": 698,\n \"ContentDeclarationStates\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 2230,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 6,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1971-08-25\",\n \"IDSupplierCivilStatus\": 4,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 7210,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7094,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 3400,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 7106,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 8869,\n \"SupplierProductLeadTimeDays\": 7152,\n \"SupplierProductReliability\": 5415,\n \"IDCompanyIntegration\": 6802,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 323,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 0,\n \"IDCarrierType\": 3082,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 6195,\n \"IDCarrierGateway\": 5407,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 5234,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 704,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 2398,\n \"CarrierAuctionPenalty\": 4516.143675017095,\n \"CarrierAdditionalBusinessDays\": 2989,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 7290,\n \"CarrierCubageKmM\": 4064,\n \"CarrierCubageFreeWeight\": 3197.8786348179387,\n \"CarrierPriceRounding\": 9670.29743927252,\n \"CarrierOrdersLimitPerCollection\": 3636,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 2769,\n \"CarrierRateUploadStatus\": 1,\n \"CarrierRateUploadStatusDescription\": \"Erro\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 1,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 0,\n \"RecordTimestamp\": \"1967-01-23T19:38:19.905Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 2073,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1961-04-21T15:30:42.313Z\"\n },\n {\n \"IDSuppliersContact\": 5969,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1951-09-20T03:17:53.641Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 1643,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 1550,\n \"RangeFinal\": 3519,\n \"CurrentRange\": 9494,\n \"DiffRange\": 6903\n },\n {\n \"IDCorreiosSroRange\": 1448,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 2600,\n \"RangeFinal\": 4573,\n \"CurrentRange\": 5299,\n \"DiffRange\": 961\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 3195,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1970-09-02T23:35:29.344Z\",\n \"Main\": 1\n },\n {\n \"IDCarrierTableUpload\": 9626,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1978-01-18T23:10:07.315Z\",\n \"Main\": 0\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 6531,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 7556.665600723039,\n \"RecordTimestamp\": \"2016-11-12T10:31:13.654Z\"\n },\n {\n \"IDTypeCostCenter\": 504,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 8605.462978466407,\n \"RecordTimestamp\": \"2002-07-13T02:32:50.735Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eec28a9c-17de-4f04-8eaa-37312134821a", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Fornecedor não existe`\n- `Categoria fornecedor não existe`\n- `Já existe um fornecedor com esse CPF/CNPJ`\n- `Plano de contas não existe`\n- `Etiqueta não existe`", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 665,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1963-02-21\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 8710,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 8555,\n \"PrintDanfe\": 9126,\n \"PrintDanfeA4\": 4425,\n \"LabelAndDanfeSamePage\": 6388,\n \"ManualLabel\": 8945,\n \"IDCompanyIntegration\": 2977,\n \"IDCompanyLabel\": 1287,\n \"IDTypeAccountPayableReceivable\": 8416,\n \"SupplierProductLeadTimeDays\": 7261,\n \"SupplierProductReliability\": 9738,\n \"CarrierAuction\": 6207,\n \"CarrierAuctionPenalty\": 1881,\n \"IDCarrierGateway\": 2,\n \"IDCarrierType\": 1315,\n \"IDCarrierModal\": 1118,\n \"CarrierShippingIdRule\": 7191,\n \"CarrierAdditionalBusinessDays\": 5383,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 1312,\n \"CarrierCubageKmM\": 1890.4323440665016,\n \"CarrierCubageFreeWeight\": 4559.21387871997,\n \"CarrierPriceRounding\": 7321.1976208001,\n \"CarrierOrdersLimitPerCollection\": 7436,\n \"CarrierCollectionListEmail\": \"string\",\n \"IgnoreCollectionList\": 698,\n \"ContentDeclarationStates\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed84ed1e-d21b-45de-b8f1-5269284d9ae4", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 665,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1963-02-21\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierPIS\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 8710,\n \"PixKey\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 8555,\n \"PrintDanfe\": 9126,\n \"PrintDanfeA4\": 4425,\n \"LabelAndDanfeSamePage\": 6388,\n \"ManualLabel\": 8945,\n \"IDCompanyIntegration\": 2977,\n \"IDCompanyLabel\": 1287,\n \"IDTypeAccountPayableReceivable\": 8416,\n \"SupplierProductLeadTimeDays\": 7261,\n \"SupplierProductReliability\": 9738,\n \"CarrierAuction\": 6207,\n \"CarrierAuctionPenalty\": 1881,\n \"IDCarrierGateway\": 2,\n \"IDCarrierType\": 1315,\n \"IDCarrierModal\": 1118,\n \"CarrierShippingIdRule\": 7191,\n \"CarrierAdditionalBusinessDays\": 5383,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 1312,\n \"CarrierCubageKmM\": 1890.4323440665016,\n \"CarrierCubageFreeWeight\": 4559.21387871997,\n \"CarrierPriceRounding\": 7321.1976208001,\n \"CarrierOrdersLimitPerCollection\": 7436,\n \"CarrierCollectionListEmail\": \"string\",\n \"IgnoreCollectionList\": 698,\n \"ContentDeclarationStates\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e9144eb-fa16-4f4f-8dcd-d06e7d8b74a4", "name": "Exclui (inativa) um fornecedor", "request": { "name": "Exclui (inativa) um fornecedor", "description": { "content": "Marca o fornecedor como inativo e limpa os vínculos com integração (`IDCompanyIntegration`) e leilão de frete (`CarrierAuction`). Não há exclusão física do registro: o `SupplierStatus` passa para **0** quando o fornecedor nunca teve título a pagar/receber, ou para **2** quando já existe pelo menos um título vinculado — isso preserva o histórico financeiro mas remove o fornecedor das listas ativas.\n\nA resposta é a lista atualizada de fornecedores (mesmo formato de `GET /supplier`).", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "eb003bff-bf66-47b7-8f6d-e8d3a72a4e5c", "name": "Fornecedor inativado. Retorna a lista de fornecedores ativos atualizada.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 589,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 1,\n \"SupplierEmail\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"IDSupplierCategory\": 3328,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 3948,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 4903,\n \"PixKey\": \"string\",\n \"IDTypeAccountPayableReceivable\": 3298,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDCarrierType\": 6300,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDCarrierGateway\": 1067,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 1606,\n \"CarrierModal\": \"string\",\n \"CarrierAuction\": 9475,\n \"CarrierRateUploadStatusDescription\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1\n },\n {\n \"IDSupplier\": 2144,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 2,\n \"SupplierEmail\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"IDSupplierCategory\": 7885,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 9549,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"string\",\n \"BankCode\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 1683,\n \"PixKey\": \"string\",\n \"IDTypeAccountPayableReceivable\": 178,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDCarrierType\": 7542,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDCarrierGateway\": 3084,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 8417,\n \"CarrierModal\": \"string\",\n \"CarrierAuction\": 7379,\n \"CarrierRateUploadStatusDescription\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65a42fc-c481-4b69-960c-3d4a4d603736", "name": "Fornecedor não localizado. Mensagem: `[BadRequest] - Supplier não existe`.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1deff945-66a7-4d2e-ae1b-2fea2f108285", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (ou transportadora — compartilham o mesmo cadastro)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67a59748-3311-47f0-aca9-91027c236924", "name": "Adiciona um contato ao fornecedor", "request": { "name": "Adiciona um contato ao fornecedor", "description": { "content": "Cria um contato (pessoa física) vinculado ao fornecedor. A resposta é o detalhe completo do fornecedor atualizado, com a nova entrada já visível em `Contacts[]`.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "194cac7d-7832-45cd-b065-cca909a72962", "name": "Contato criado. Retorna o detalhe atualizado do fornecedor.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 2230,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 6,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1971-08-25\",\n \"IDSupplierCivilStatus\": 4,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 7210,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7094,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 3400,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 7106,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 8869,\n \"SupplierProductLeadTimeDays\": 7152,\n \"SupplierProductReliability\": 5415,\n \"IDCompanyIntegration\": 6802,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 323,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 0,\n \"IDCarrierType\": 3082,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 6195,\n \"IDCarrierGateway\": 5407,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 5234,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 704,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 2398,\n \"CarrierAuctionPenalty\": 4516.143675017095,\n \"CarrierAdditionalBusinessDays\": 2989,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 7290,\n \"CarrierCubageKmM\": 4064,\n \"CarrierCubageFreeWeight\": 3197.8786348179387,\n \"CarrierPriceRounding\": 9670.29743927252,\n \"CarrierOrdersLimitPerCollection\": 3636,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 2769,\n \"CarrierRateUploadStatus\": 1,\n \"CarrierRateUploadStatusDescription\": \"Erro\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 1,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 0,\n \"RecordTimestamp\": \"1967-01-23T19:38:19.905Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 2073,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1961-04-21T15:30:42.313Z\"\n },\n {\n \"IDSuppliersContact\": 5969,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1951-09-20T03:17:53.641Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 1643,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 1550,\n \"RangeFinal\": 3519,\n \"CurrentRange\": 9494,\n \"DiffRange\": 6903\n },\n {\n \"IDCorreiosSroRange\": 1448,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 2600,\n \"RangeFinal\": 4573,\n \"CurrentRange\": 5299,\n \"DiffRange\": 961\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 3195,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1970-09-02T23:35:29.344Z\",\n \"Main\": 1\n },\n {\n \"IDCarrierTableUpload\": 9626,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1978-01-18T23:10:07.315Z\",\n \"Main\": 0\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 6531,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 7556.665600723039,\n \"RecordTimestamp\": \"2016-11-12T10:31:13.654Z\"\n },\n {\n \"IDTypeCostCenter\": 504,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 8605.462978466407,\n \"RecordTimestamp\": \"2002-07-13T02:32:50.735Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed498e3d-c91c-4fce-99be-fc1edbd3cbde", "name": "Fornecedor não localizado. Mensagem: `[BadRequest] - Fornecedor não existe`.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e5b12d3-cf20-47d3-b297-df0d10716032", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71dffe46-d15e-4e59-8aed-6e8f30c31f3b", "name": "Atualiza um contato do fornecedor", "request": { "name": "Atualiza um contato do fornecedor", "description": { "content": "Atualiza parcialmente um contato — apenas os campos enviados no corpo são alterados. A resposta é o detalhe completo do fornecedor atualizado.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2a07e20-7080-4313-b948-ca3109cdae08", "name": "Contato atualizado.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 2230,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 6,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1971-08-25\",\n \"IDSupplierCivilStatus\": 4,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 7210,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7094,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 3400,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 7106,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 8869,\n \"SupplierProductLeadTimeDays\": 7152,\n \"SupplierProductReliability\": 5415,\n \"IDCompanyIntegration\": 6802,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 323,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 0,\n \"IDCarrierType\": 3082,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 6195,\n \"IDCarrierGateway\": 5407,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 5234,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 704,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 2398,\n \"CarrierAuctionPenalty\": 4516.143675017095,\n \"CarrierAdditionalBusinessDays\": 2989,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 7290,\n \"CarrierCubageKmM\": 4064,\n \"CarrierCubageFreeWeight\": 3197.8786348179387,\n \"CarrierPriceRounding\": 9670.29743927252,\n \"CarrierOrdersLimitPerCollection\": 3636,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 2769,\n \"CarrierRateUploadStatus\": 1,\n \"CarrierRateUploadStatusDescription\": \"Erro\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 1,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 0,\n \"RecordTimestamp\": \"1967-01-23T19:38:19.905Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 2073,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1961-04-21T15:30:42.313Z\"\n },\n {\n \"IDSuppliersContact\": 5969,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1951-09-20T03:17:53.641Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 1643,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 1550,\n \"RangeFinal\": 3519,\n \"CurrentRange\": 9494,\n \"DiffRange\": 6903\n },\n {\n \"IDCorreiosSroRange\": 1448,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 2600,\n \"RangeFinal\": 4573,\n \"CurrentRange\": 5299,\n \"DiffRange\": 961\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 3195,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1970-09-02T23:35:29.344Z\",\n \"Main\": 1\n },\n {\n \"IDCarrierTableUpload\": 9626,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1978-01-18T23:10:07.315Z\",\n \"Main\": 0\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 6531,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 7556.665600723039,\n \"RecordTimestamp\": \"2016-11-12T10:31:13.654Z\"\n },\n {\n \"IDTypeCostCenter\": 504,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 8605.462978466407,\n \"RecordTimestamp\": \"2002-07-13T02:32:50.735Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42df029b-eb26-48f9-8de0-af293114853d", "name": "Fornecedor ou contato não encontrados. Mensagem: `[BadRequest] - Fornecedor não existe`.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcf6c1f9-b46b-446a-9294-232cf28ef626", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93f820c8-eed1-4320-9514-a57bd3419f4d", "name": "Remove um contato do fornecedor", "request": { "name": "Remove um contato do fornecedor", "description": { "content": "Apaga fisicamente o contato. A resposta é o detalhe completo do fornecedor atualizado, já sem o contato removido.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "204a78b3-0af3-4649-9b72-4642ea21766b", "name": "Contato removido. Retorna o detalhe atualizado do fornecedor.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 2230,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 6,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1971-08-25\",\n \"IDSupplierCivilStatus\": 4,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 7210,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7094,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 3400,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 7106,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 8869,\n \"SupplierProductLeadTimeDays\": 7152,\n \"SupplierProductReliability\": 5415,\n \"IDCompanyIntegration\": 6802,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 323,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 0,\n \"IDCarrierType\": 3082,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 6195,\n \"IDCarrierGateway\": 5407,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 5234,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 704,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 2398,\n \"CarrierAuctionPenalty\": 4516.143675017095,\n \"CarrierAdditionalBusinessDays\": 2989,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 7290,\n \"CarrierCubageKmM\": 4064,\n \"CarrierCubageFreeWeight\": 3197.8786348179387,\n \"CarrierPriceRounding\": 9670.29743927252,\n \"CarrierOrdersLimitPerCollection\": 3636,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 2769,\n \"CarrierRateUploadStatus\": 1,\n \"CarrierRateUploadStatusDescription\": \"Erro\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 1,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 0,\n \"RecordTimestamp\": \"1967-01-23T19:38:19.905Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 2073,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1961-04-21T15:30:42.313Z\"\n },\n {\n \"IDSuppliersContact\": 5969,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1951-09-20T03:17:53.641Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 1643,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 1550,\n \"RangeFinal\": 3519,\n \"CurrentRange\": 9494,\n \"DiffRange\": 6903\n },\n {\n \"IDCorreiosSroRange\": 1448,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 2600,\n \"RangeFinal\": 4573,\n \"CurrentRange\": 5299,\n \"DiffRange\": 961\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 3195,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1970-09-02T23:35:29.344Z\",\n \"Main\": 1\n },\n {\n \"IDCarrierTableUpload\": 9626,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1978-01-18T23:10:07.315Z\",\n \"Main\": 0\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 6531,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 7556.665600723039,\n \"RecordTimestamp\": \"2016-11-12T10:31:13.654Z\"\n },\n {\n \"IDTypeCostCenter\": 504,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 8605.462978466407,\n \"RecordTimestamp\": \"2002-07-13T02:32:50.735Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee3fc4f3-8a65-48e5-8fab-e8880e04c0f5", "name": "Fornecedor não localizado. Mensagem: `[BadRequest] - Fornecedor não existe`.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07fbb89b-4d27-4502-969a-af95df9979d2", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "contact", ":idsupplierscontact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsupplierscontact", "description": "(Required) Identificador do contato." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b56d1e05-acc5-43ea-9d8e-682cabfbbd86", "name": "Define o rateio padrão de centros de custo do fornecedor", "request": { "name": "Define o rateio padrão de centros de custo do fornecedor", "description": { "content": "Substitui (apaga e regrava) o rateio padrão de centros de custo aplicado nos títulos gerados a partir deste fornecedor. O corpo é um **array** de pares `IDTypeCostCenter` + `ValueRatio`, onde a soma de `ValueRatio` precisa fechar em **1** (100%). Quando o array é vazio (`[]`), o rateio padrão é removido. Todos os centros de custo precisam existir na empresa.\n\nO comportamento é atômico: o sistema valida primeiro a soma e os centros, depois apaga o rateio anterior e insere o novo de uma vez. A resposta é a string `\"sucesso\"` quando o array é vazio, ou o detalhe completo do fornecedor atualizado quando há centros a gravar.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 6110,\n \"ValueRatio\": 9958.649168949945\n },\n {\n \"IDTypeCostCenter\": 7136,\n \"ValueRatio\": 3518.9773432699158\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "69e4c5d4-e77b-49b7-baf9-b0fa9e1afe7b", "name": "Rateio aplicado. Retorna o detalhe atualizado do fornecedor, ou a string `\"sucesso\"` quando o rateio foi removido (array vazio).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 7520,\n \"ValueRatio\": 31.091165509484764\n },\n {\n \"IDTypeCostCenter\": 6544,\n \"ValueRatio\": 1549.472228656521\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSupplier\": 5725,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 1,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1951-05-19\",\n \"IDSupplierCivilStatus\": 2,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 8671,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7129,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 8283,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 5488,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 7879,\n \"SupplierProductLeadTimeDays\": 8701,\n \"SupplierProductReliability\": 1112,\n \"IDCompanyIntegration\": 8031,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 2491,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1,\n \"IDCarrierType\": 9534,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 2900,\n \"IDCarrierGateway\": 7931,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 9474,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 3233,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 5468,\n \"CarrierAuctionPenalty\": 2134.0723880243195,\n \"CarrierAdditionalBusinessDays\": 5802,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 733,\n \"CarrierCubageKmM\": 5290,\n \"CarrierCubageFreeWeight\": 9930.502282038457,\n \"CarrierPriceRounding\": 371.69074070499744,\n \"CarrierOrdersLimitPerCollection\": 1157,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 851,\n \"CarrierRateUploadStatus\": 1,\n \"CarrierRateUploadStatusDescription\": \"Sucesso\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 0,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 1,\n \"RecordTimestamp\": \"1954-01-25T22:07:56.838Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 1180,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"2013-09-17T13:41:01.157Z\"\n },\n {\n \"IDSuppliersContact\": 5253,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1991-10-05T13:49:30.861Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 8283,\n \"Status\": 1,\n \"Prefix\": \"string\",\n \"RangeInitial\": 4887,\n \"RangeFinal\": 9833,\n \"CurrentRange\": 6487,\n \"DiffRange\": 6891\n },\n {\n \"IDCorreiosSroRange\": 1823,\n \"Status\": 0,\n \"Prefix\": \"string\",\n \"RangeInitial\": 2485,\n \"RangeFinal\": 6723,\n \"CurrentRange\": 6571,\n \"DiffRange\": 9102\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 1481,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1963-11-11T04:01:32.076Z\",\n \"Main\": 1\n },\n {\n \"IDCarrierTableUpload\": 9907,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"2006-02-09T11:32:58.094Z\",\n \"Main\": 0\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 2801,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 5208.700023527457,\n \"RecordTimestamp\": \"1975-11-27T13:09:06.130Z\"\n },\n {\n \"IDTypeCostCenter\": 5898,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 6049.338296252194,\n \"RecordTimestamp\": \"1972-09-28T15:26:47.981Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 0\n },\n {\n \"IDSupplier\": 786,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierTradeName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"SupplierType\": 7,\n \"SupplierStateInscription\": \"string\",\n \"SupplierCityInscription\": \"string\",\n \"SupplierIdentityNumber\": \"string\",\n \"SupplierBirthDate\": \"1963-02-20\",\n \"IDSupplierCivilStatus\": 1,\n \"TypeCivilStatusName\": \"string\",\n \"SupplierTelephone\": \"string\",\n \"SupplierEmail\": \"string\",\n \"SupplierLogoUrl\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDSupplierCategory\": 2736,\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 3450,\n \"TypeSupplier\": \"string\",\n \"IDTypeAccountPayableReceivable\": 9909,\n \"TypeAccountPaybleDescription\": \"string\",\n \"BankCode\": \"str\",\n \"Bank\": \"string\",\n \"BankAgency\": \"string\",\n \"BankCheckingAccount\": \"string\",\n \"BankCheckingAccountType\": 4413,\n \"PixKey\": \"string\",\n \"SupplierPIS\": \"string\",\n \"Comments\": \"string\",\n \"DefaultPurchase\": 1175,\n \"SupplierProductLeadTimeDays\": 8786,\n \"SupplierProductReliability\": 7207,\n \"IDCompanyIntegration\": 8956,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyLabel\": 5256,\n \"LabelName\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierStatus\": 1,\n \"IDCarrierType\": 8400,\n \"TypeCarrier\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"IDTypeCompanyIntegration\": 1288,\n \"IDCarrierGateway\": 3622,\n \"CarrierGateway\": \"string\",\n \"IDCarrierModal\": 8056,\n \"CarrierModal\": \"string\",\n \"CarrierLabelType\": 7850,\n \"CarrierShippingIdRule\": \"string\",\n \"CarrierAuction\": 7575,\n \"CarrierAuctionPenalty\": 8483.264153805294,\n \"CarrierAdditionalBusinessDays\": 7172,\n \"CarrierShippingCutTime\": \"string\",\n \"CarrierICMSIncluded\": 4494,\n \"CarrierCubageKmM\": 8935,\n \"CarrierCubageFreeWeight\": 8688.999089779987,\n \"CarrierPriceRounding\": 9718.510799279793,\n \"CarrierOrdersLimitPerCollection\": 7112,\n \"CarrierCollectionListEmail\": \"string\",\n \"CarrierQuotationExternalId\": 6591,\n \"CarrierRateUploadStatus\": 3,\n \"CarrierRateUploadStatusDescription\": \"Erro\",\n \"ContentDeclarationStates\": [\n \"st\",\n \"st\"\n ],\n \"PrintDanfe\": 1,\n \"PrintDanfeA4\": 1,\n \"ManualLabel\": 0,\n \"IgnoreCollectionList\": 0,\n \"RecordTimestamp\": \"1985-10-12T12:51:50.403Z\",\n \"Contacts\": [\n {\n \"IDSuppliersContact\": 1452,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"1967-07-26T14:36:46.887Z\"\n },\n {\n \"IDSuppliersContact\": 967,\n \"ContactName\": \"string\",\n \"ContactEmail\": \"string\",\n \"ContactTelephone\": \"string\",\n \"ContactResponsability\": \"string\",\n \"RecordTimestamp\": \"2007-03-18T12:24:56.500Z\"\n }\n ],\n \"CorreiosSRO\": [\n {\n \"IDCorreiosSroRange\": 7269,\n \"Status\": 1,\n \"Prefix\": \"string\",\n \"RangeInitial\": 4645,\n \"RangeFinal\": 1399,\n \"CurrentRange\": 2237,\n \"DiffRange\": 1785\n },\n {\n \"IDCorreiosSroRange\": 9674,\n \"Status\": 1,\n \"Prefix\": \"string\",\n \"RangeInitial\": 6067,\n \"RangeFinal\": 1583,\n \"CurrentRange\": 8523,\n \"DiffRange\": 2592\n }\n ],\n \"CarrierTableUpload\": [\n {\n \"IDCarrierTableUpload\": 6926,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1993-01-11T10:41:55.836Z\",\n \"Main\": 0\n },\n {\n \"IDCarrierTableUpload\": 9396,\n \"FileName\": \"string\",\n \"UrlFile\": \"string\",\n \"RecordTimestamp\": \"1973-10-17T08:25:31.212Z\",\n \"Main\": 1\n }\n ],\n \"SuppliersCostCenter\": [\n {\n \"IDTypeCostCenter\": 4518,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 6943.379108017484,\n \"RecordTimestamp\": \"2017-03-24T13:26:03.046Z\"\n },\n {\n \"IDTypeCostCenter\": 9655,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"ValueRatio\": 1567.1143880552506,\n \"RecordTimestamp\": \"2004-09-24T10:51:38.564Z\"\n }\n ],\n \"LabelAndDanfeSamePage\": 0\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "212164fa-607b-4f0d-b417-87e644b32075", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Fornecedor não existe`\n- `Rateio precisa somar 100%`\n- `Precisa enviar ao menos um centro de custo`\n- `Centro de custo(s) não localizado(s): `", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 7520,\n \"ValueRatio\": 31.091165509484764\n },\n {\n \"IDTypeCostCenter\": 6544,\n \"ValueRatio\": 1549.472228656521\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "911e1c04-67de-4e7f-a2ec-942ebc2ceaab", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 7520,\n \"ValueRatio\": 31.091165509484764\n },\n {\n \"IDTypeCostCenter\": 6544,\n \"ValueRatio\": 1549.472228656521\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54ba65be-9978-4692-9ac3-bdfc125b620b", "name": "Sobe ou troca o logotipo do fornecedor", "request": { "name": "Sobe ou troca o logotipo do fornecedor", "description": { "content": "Aceita duas formas de envio do logotipo:\n\n- **Upload multipart** (`multipart/form-data` com campo `file`) — sobe o arquivo direto do cliente.\n- **URL externa** (`application/json` com `{ \"Url\": \"...\" }`) — o sistema baixa a imagem da URL informada e grava no S3.\n\nNos dois casos a imagem é salva no bucket público do idworks (`https://public.idworks.com.br/Image/Suppliers/...`) com um nome único, e o campo `SupplierLogoUrl` do fornecedor é atualizada. A resposta é um corpo vazio com status HTTP — `200` em sucesso, `404` se o fornecedor não existe, `400` se a URL informada não retorna a imagem.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Arquivo de imagem (PNG/JPG)." } ] } }, "response": [ { "id": "45f71883-2f2b-432c-bca0-1c5ff0fb02fe", "name": "Logotipo aplicado (corpo vazio).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "985ef227-cd20-4779-b8ae-5f229f1b4a52", "name": "Falha ao baixar imagem da URL informada. Mensagem: `[BadRequest] - erro ao baixar imagem`.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba0609b6-b689-4d11-9099-cae7cab89f02", "name": "Fornecedor não encontrado (corpo vazio).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c97f5c67-30f0-439f-8370-492dc881c2c4", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3d7f9f3-7ac0-4112-947f-547fccd3a1c6", "name": "Gera etiqueta personalizada do fornecedor (ZPL ou PDF)", "request": { "name": "Gera etiqueta personalizada do fornecedor (ZPL ou PDF)", "description": { "content": "Gera a etiqueta de identificação do fornecedor conforme o modelo configurado em `IDCompanyLabel`. Retorna PDF (convertido via Labelary) por padrão, ou ZPL bruto quando `Zpl=1` / arquivo `.zpl` quando `Download=1`.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier", "label" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyLabel", "value": "1603", "description": "(Required) Identificador do modelo de etiqueta cadastrado para a empresa." }, { "disabled": false, "key": "Download", "value": "1", "description": "`1` baixa o arquivo `.zpl` direto." }, { "disabled": false, "key": "Zpl", "value": "1", "description": "`1` retorna o ZPL bruto (válido quando `Download=0`)." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": null }, "response": [ { "id": "72bb9cd0-27d2-4d9f-b815-9f3478ef385d", "name": "Etiqueta gerada. Tipo do conteúdo varia conforme `Download`/`Zpl`: `application/pdf` (padrão), `application/epl2` (`Download=1`) ou ZPL puro como texto (`Download=0` + `Zpl=1`).", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "label" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyLabel", "value": "1603" }, { "key": "Download", "value": "1" }, { "key": "Zpl", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b98d39b-ce34-4589-bdf3-442e1197e60c", "name": "Falha de validação. Mensagens possíveis: `Parâmetros inválidos, obrigatório informar account e IDCompanyLabel`, `Fornecedor não encontrado`, `Problema ao gerar etiqueta`.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "label" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyLabel", "value": "1603" }, { "key": "Download", "value": "1" }, { "key": "Zpl", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f90f9e2-19d7-44bb-9ff3-7aea969bd8d0", "name": "Erro interno na geração da etiqueta.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "label" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyLabel", "value": "1603" }, { "key": "Download", "value": "1" }, { "key": "Zpl", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be3a4230-a354-478b-b712-62829f7cbc35", "name": "Baixa o arquivo de tabela de frete do transportador", "request": { "name": "Baixa o arquivo de tabela de frete do transportador", "description": { "content": "Devolve, como anexo `.xlsx`, o arquivo de tabela de frete (`CarrierTableUpload`) anteriormente importado para o transportador (fornecedor com perfil de carrier). O `idsupplier` no path identifica o transportador e `IDFile` aponta o registro específico do upload a recuperar.", "type": "text/plain" }, "url": { "path": [ "supplier", ":idsupplier", "template" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDFile", "value": "1603", "description": "(Required) Identificador do upload da tabela (`IDCarrierTableUpload`)." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (transportador)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "method": "GET", "auth": null }, "response": [ { "id": "2af0f864-23e3-4b72-a024-04501053a1e5", "name": "Arquivo `.xlsx` da tabela de frete pronto para download.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "template" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDFile", "value": "1603" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (transportador)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "141b3e56-07fc-40b7-b0a1-ad2fc76428a0", "name": "Arquivo não encontrado. Mensagens possíveis: `[BadRequest] - Arquivo não encontrado`, `[NotFound] - Arquivo não encontrado S3`.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "template" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDFile", "value": "1603" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (transportador)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "651d74a4-a6ac-412f-8db5-0dbbf1027205", "name": "Erro interno ao recuperar o arquivo do bucket.", "originalRequest": { "url": { "path": [ "supplier", ":idsupplier", "template" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDFile", "value": "1603" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idsupplier", "description": "(Required) Identificador do fornecedor (transportador)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "479d8b1d-65ff-4303-a629-42239e77bf6f", "name": "Cadastro de Usuários", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "dbe0516b-9afe-43c6-b664-d9cb4b947fb6", "name": "Lista os relatórios já gerados pelo usuário", "request": { "name": "Lista os relatórios já gerados pelo usuário", "description": { "content": "Retorna o histórico de relatórios que **o usuário autenticado** gerou — ordenado pela data de criação descendente. Cada item traz o tipo de relatório (`TypeCompanyReport`), os filtros usados (`Query`), o status (`Status`: pendente, processando, concluído, erro), comentários, link de download (`Link`, preenchido quando o processamento termina) e a data/hora da geração.", "type": "text/plain" }, "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b476955f-b704-46ac-9d03-f3f5fe7e7449", "name": "Histórico de relatórios do usuário.", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUserReport\": 511,\n \"IDCompany\": 8788,\n \"IDTypeCompanyReport\": 3327,\n \"TypeCompanyReport\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeStatusUserReport\": 2,\n \"Status\": \"string\",\n \"Query\": \"string\",\n \"SendEmail\": 1,\n \"Link\": \"string\",\n \"Comments\": \"string\",\n \"RecordTimestamp\": \"1985-12-06T06:57:49.102Z\",\n \"RecordUserCreated\": 4894\n },\n {\n \"IDUserReport\": 1864,\n \"IDCompany\": 3203,\n \"IDTypeCompanyReport\": 8269,\n \"TypeCompanyReport\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeStatusUserReport\": 1,\n \"Status\": \"string\",\n \"Query\": \"string\",\n \"SendEmail\": 1,\n \"Link\": \"string\",\n \"Comments\": \"string\",\n \"RecordTimestamp\": \"1947-06-22T00:03:53.046Z\",\n \"RecordUserCreated\": 1048\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c03079a-8074-410a-854e-bb62d0b71614", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f743464b-0ed2-4db8-ac33-77f7c1a69646", "name": "Enfileira a geração de um relatório", "request": { "name": "Enfileira a geração de um relatório", "description": { "content": "Cria um pedido de geração de relatório para o tipo (`IDTypeCompanyReport`) e filtros (`Query`) informados. O processamento é **assíncrono**: a API registra o pedido com status `1` (Processando) e devolve imediatamente o histórico atualizado de relatórios do usuário. Quando a geração termina, o arquivo fica disponível em `Link` e o status passa para `2` (Gerado) ou `3` (Sem dados). Os relatórios de uma mesma empresa são processados em sequência, um de cada vez.\n\n**Duplicidade**: o pedido é bloqueado se já existe um relatório do **mesmo tipo**, com a **mesma** `Query`, do **mesmo usuário**, ainda sem arquivo pronto e com status `1` (Processando), criado nas **últimas 3 horas** — para evitar gerar o mesmo relatório duas vezes em paralelo. Mensagem: `Relatório já está em processamento, favor aguardar`.\n\nQuando `SendEmail=1`, o link do arquivo é enviado para o e-mail do usuário ao terminar a geração.", "type": "text/plain" }, "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyReport\": 9258,\n \"Query\": \"string\",\n \"SendEmail\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aad9e522-6915-4b88-b15c-b9806c5fabf9", "name": "Relatório enfileirado. Retorna o histórico atualizado de relatórios do usuário (mesmo formato de `GET /user/report`).", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyReport\": 9258,\n \"Query\": \"string\",\n \"SendEmail\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUserReport\": 511,\n \"IDCompany\": 8788,\n \"IDTypeCompanyReport\": 3327,\n \"TypeCompanyReport\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeStatusUserReport\": 2,\n \"Status\": \"string\",\n \"Query\": \"string\",\n \"SendEmail\": 1,\n \"Link\": \"string\",\n \"Comments\": \"string\",\n \"RecordTimestamp\": \"1985-12-06T06:57:49.102Z\",\n \"RecordUserCreated\": 4894\n },\n {\n \"IDUserReport\": 1864,\n \"IDCompany\": 3203,\n \"IDTypeCompanyReport\": 8269,\n \"TypeCompanyReport\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeStatusUserReport\": 1,\n \"Status\": \"string\",\n \"Query\": \"string\",\n \"SendEmail\": 1,\n \"Link\": \"string\",\n \"Comments\": \"string\",\n \"RecordTimestamp\": \"1947-06-22T00:03:53.046Z\",\n \"RecordUserCreated\": 1048\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "562fe3a9-4893-42f8-b6de-9429dc731351", "name": "Erros (prefixo `[BadRequest]`):\n- `Empresa não existe`\n- `Relatório já está em processamento, favor aguardar`\n- `Problema ao gerar relatório`\n- `Query deve ser uma querystring (ex: DateFrom=2026-06-23&DateTo=2026-06-23), recebido JSON: `", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyReport\": 9258,\n \"Query\": \"string\",\n \"SendEmail\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "839221cf-ef2a-4b9c-a113-a1104fd4d8aa", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyReport\": 9258,\n \"Query\": \"string\",\n \"SendEmail\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ff555bb-06c3-414d-9e3e-f603d7e79ef8", "name": "Adiciona uma regra de comissão para o vendedor", "request": { "name": "Adiciona uma regra de comissão para o vendedor", "description": { "content": "Cria uma regra de comissão (`SalesmanComission`) vinculada ao usuário. A regra define a vigência (`DateFrom`/`DateTo`), o percentual de comissão (`ComissionPercent`) e o limite máximo de desconto (`DiscountPercentLimit`) — vendas com desconto **acima do limite** não pagam essa comissão. Quando `IDCategory` é informado, a regra **só vale** para vendas de SKUs daquela categoria (permite ter percentuais diferentes por categoria de produto).\n\nA cada criação, o sistema também grava um log da operação em `UserLog`. A resposta é o detalhe completo do usuário atualizado, com a nova regra já em `SalesmanComission[]`.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "comission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor) ao qual a comissão será vinculada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d11cfbad-65b4-4522-bc1a-8e57185c79b2", "name": "Regra de comissão criada. Retorna o detalhe do usuário com a lista atualizada de regras.", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor) ao qual a comissão será vinculada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 4823,\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"Salesman\": 1,\n \"DiscountPercentLimit\": 6104.65413089317,\n \"IDTypeSalesmanCommission\": 3,\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 1,\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 2154,\n \"IDAcess\": 2015,\n \"DateFrom\": \"1983-02-21\",\n \"DateTo\": \"2024-08-09\",\n \"DiscountPercentLimit\": 6586.164972076392,\n \"ComissionPercent\": 8104.629433752013,\n \"IDCategory\": 5456,\n \"Category\": \"string\",\n \"RecordTimestamp\": \"2006-06-20T10:14:31.374Z\"\n },\n {\n \"IDSalesmanComission\": 4106,\n \"IDAcess\": 864,\n \"DateFrom\": \"1985-06-19\",\n \"DateTo\": \"1951-08-19\",\n \"DiscountPercentLimit\": 3784.7360715732557,\n \"ComissionPercent\": 6241.966320363712,\n \"IDCategory\": 8785,\n \"Category\": \"string\",\n \"RecordTimestamp\": \"1977-07-31T07:08:36.555Z\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "696590eb-ea28-432c-b0a1-d808c4ff0b01", "name": "Erros (prefixo `[BadRequest]`):\n- `Usuário não encontrado`\n- `Categoria não existe` (quando `IDCategory` aponta para categoria de outra empresa ou inexistente)", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor) ao qual a comissão será vinculada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7235c5cc-af8a-465b-a85c-8795b0389d96", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor) ao qual a comissão será vinculada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4ee8cc9-9444-4b13-b5b9-3085b27992d1", "name": "Atualiza uma regra de comissão", "request": { "name": "Atualiza uma regra de comissão", "description": { "content": "Atualização total da regra — todos os campos do corpo são gravados. Quando `IDCategory` é informado, é validado contra `StockKeepingUnitCategory` da empresa autenticada. A operação também grava um log em `UserLog` e devolve o detalhe atualizado do usuário.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de28f97b-2ca7-4176-b542-414e5cf6fe6f", "name": "Regra atualizada.", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2996,\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"Salesman\": 1,\n \"DiscountPercentLimit\": 1133.4407129683366,\n \"IDTypeSalesmanCommission\": 4,\n \"ExcludeCanceledOrdersCommission\": 0,\n \"ExcludeReturnedOrdersCommission\": 1,\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 675,\n \"IDAcess\": 603,\n \"DateFrom\": \"1950-02-07\",\n \"DateTo\": \"2016-08-24\",\n \"DiscountPercentLimit\": 9796.220842995246,\n \"ComissionPercent\": 1864.641307007404,\n \"IDCategory\": 2231,\n \"Category\": \"string\",\n \"RecordTimestamp\": \"2015-10-17T15:58:32.976Z\"\n },\n {\n \"IDSalesmanComission\": 9430,\n \"IDAcess\": 816,\n \"DateFrom\": \"1992-06-04\",\n \"DateTo\": \"2020-09-03\",\n \"DiscountPercentLimit\": 5761.631403422407,\n \"ComissionPercent\": 4683.002784078889,\n \"IDCategory\": 3,\n \"Category\": \"string\",\n \"RecordTimestamp\": \"1955-10-18T00:30:23.304Z\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00bae4ed-6986-4046-b258-a00b20888992", "name": "Erros (prefixo `[BadRequest]`):\n- `Comissão vendedor não encontrada`\n- `Categoria não existe`", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "486dded8-2e7b-468e-b318-5b94b9e089ca", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"DateFrom\": \"1965-08-26\",\n \"DateTo\": \"1964-06-25\",\n \"ComissionPercent\": 5755.032340400039,\n \"DiscountPercentLimit\": 9996.855914465283,\n \"IDCategory\": 3651\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13d32ed4-fb3a-4f64-98bd-0140dfdb86cf", "name": "Remove uma regra de comissão", "request": { "name": "Remove uma regra de comissão", "description": { "content": "Apaga fisicamente a regra de comissão. Grava log em `UserLog` com o id da regra removida. A resposta é o detalhe atualizado do usuário.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b2d7a432-e47b-4328-8df2-9fe2fcab2cfc", "name": "Regra removida.", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2996,\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"Salesman\": 1,\n \"DiscountPercentLimit\": 1133.4407129683366,\n \"IDTypeSalesmanCommission\": 4,\n \"ExcludeCanceledOrdersCommission\": 0,\n \"ExcludeReturnedOrdersCommission\": 1,\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 675,\n \"IDAcess\": 603,\n \"DateFrom\": \"1950-02-07\",\n \"DateTo\": \"2016-08-24\",\n \"DiscountPercentLimit\": 9796.220842995246,\n \"ComissionPercent\": 1864.641307007404,\n \"IDCategory\": 2231,\n \"Category\": \"string\",\n \"RecordTimestamp\": \"2015-10-17T15:58:32.976Z\"\n },\n {\n \"IDSalesmanComission\": 9430,\n \"IDAcess\": 816,\n \"DateFrom\": \"1992-06-04\",\n \"DateTo\": \"2020-09-03\",\n \"DiscountPercentLimit\": 5761.631403422407,\n \"ComissionPercent\": 4683.002784078889,\n \"IDCategory\": 3,\n \"Category\": \"string\",\n \"RecordTimestamp\": \"1955-10-18T00:30:23.304Z\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5640a3bd-687d-49d5-b612-fbfad25f3b7b", "name": "Regra não encontrada para o usuário/empresa. Mensagem: `[BadRequest] - Comissão vendedor não encontrada`.", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f8dc427-e9fe-420b-8c8d-7fc01c066a0f", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "comission", ":idsalesmancomission" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário (vendedor)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idsalesmancomission", "description": "(Required) Identificador da regra de comissão." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35dd2002-f27a-46ab-9f46-ecf36579c87c", "name": "Lista os usuários da empresa", "request": { "name": "Lista os usuários da empresa", "description": { "content": "Retorna os usuários vinculados à empresa autenticada, com o(s) perfil(is) de acesso agregados em `Privileges`, o último login (`LastLogin`), flags de vendedor e o status do vínculo. Por padrão lista apenas usuários **ativos**; use `AllStatus=1` para incluir inativos.\n\nO filtro `IDModule` funciona como **roster**: traz os colaboradores que têm privilégio no(s) módulo(s) informado(s) — quem *pode* atuar no módulo, e não quem está com aquele módulo como o atual (`IDModuleCurrent`). Aceita mais de um módulo como lista separada por vírgula (ex.: `60,82`). O filtro `Tag` restringe pelos colaboradores que possuem a etiqueta informada.\n\nQuando `Comission=1`, a operação muda de comportamento: em vez da lista de cadastro, calcula e devolve a **apuração de comissões** dos vendedores no período (`DateFrom`/`DateTo` por data do pedido, ou `InvoiceDateFrom`/`InvoiceDateTo` por data de faturamento), respeitando as regras de cada vendedor.", "type": "text/plain" }, "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "AllStatus", "value": "1", "description": "1 = inclui usuários inativos na listagem; ausente/0 = só ativos." }, { "disabled": false, "key": "Salesman", "value": "1", "description": "Filtra apenas vendedores (1) ou não-vendedores (0)." }, { "disabled": false, "key": "Technician", "value": "1", "description": "Filtra apenas técnicos (1)." }, { "disabled": false, "key": "IDUserJobPosition", "value": "2232", "description": "Filtra por cargo, combinado com `Technician=1` (o cargo deve constar em `IDUserJobPositionList` do colaborador)." }, { "disabled": false, "key": "Tag", "value": "string", "description": "Filtra os colaboradores que possuem a etiqueta (Tag) informada." }, { "disabled": false, "key": "IDModule", "value": "string", "description": "Roster: filtra os colaboradores que têm privilégio em um ou mais módulos, informados como lista separada por vírgula (ex.: `60,82`). Traz quem PODE atuar no módulo, não quem está com ele como módulo atual." }, { "disabled": false, "key": "Comission", "value": "1", "description": "1 = retorna a apuração de comissões dos vendedores no período em vez da lista de cadastro." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Início do período (data do pedido) — usado com `Comission=1`." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Fim do período (data do pedido) — usado com `Comission=1`." }, { "disabled": false, "key": "InvoiceDateFrom", "value": "1980-02-08", "description": "Início do período por data de faturamento — usado com `Comission=1`." }, { "disabled": false, "key": "InvoiceDateTo", "value": "1980-02-08", "description": "Fim do período por data de faturamento — usado com `Comission=1`." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra a listagem de cadastro para os usuários vinculados à empresa/filial faturadora informada. Aplica-se apenas à listagem (não afeta a apuração de comissão de `Comission=1`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "80fb5bde-faab-44b6-8964-2cb643bc4b3b", "name": "Lista de usuários da empresa. Quando `Comission=1`, retorna a apuração de comissões dos vendedores no período (estrutura alternativa).", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AllStatus", "value": "1" }, { "key": "Salesman", "value": "1" }, { "key": "Technician", "value": "1" }, { "key": "IDUserJobPosition", "value": "2232" }, { "key": "Tag", "value": "string" }, { "key": "IDModule", "value": "string" }, { "key": "Comission", "value": "1" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "InvoiceDateFrom", "value": "1980-02-08" }, { "key": "InvoiceDateTo", "value": "1980-02-08" }, { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 166,\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserImageUrl\": \"string\",\n \"Privileges\": \"string\",\n \"LastLogin\": \"2004-04-25T22:52:43.651Z\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1637.9637917667967,\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"MFAEnabled\": 1,\n \"StatusNameUser\": \"string\",\n \"AccountName\": \"string\",\n \"IDAcess\": 5516,\n \"Status\": 1,\n \"StatusName\": \"Ativo\",\n \"LastPasswordChange\": \"1951-02-06T16:14:22.744Z\",\n \"Technician\": 0,\n \"MFAType\": \"email\",\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 7649,\n \"IDUserJobTitle\": 2716,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 2178,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8030,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 6631,\n \"RecordTimestamp\": \"1958-06-16T12:15:01.748Z\"\n },\n {\n \"IDUser\": 2455,\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserImageUrl\": \"string\",\n \"Privileges\": \"string\",\n \"LastLogin\": \"1962-06-18T03:40:56.120Z\",\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 0,\n \"DiscountPercentLimit\": 8853.389813552832,\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"MFAEnabled\": 1,\n \"StatusNameUser\": \"string\",\n \"AccountName\": \"string\",\n \"IDAcess\": 1069,\n \"Status\": 0,\n \"StatusName\": \"Inativo\",\n \"LastPasswordChange\": \"1980-10-13T04:31:37.025Z\",\n \"Technician\": 1,\n \"MFAType\": \"totp\",\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 1079,\n \"IDUserJobTitle\": 7304,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 6107,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 4086,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 9173,\n \"RecordTimestamp\": \"1973-08-21T11:22:56.064Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2ca18b4-af74-4d12-ab18-4223fd6ed2f9", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AllStatus", "value": "1" }, { "key": "Salesman", "value": "1" }, { "key": "Technician", "value": "1" }, { "key": "IDUserJobPosition", "value": "2232" }, { "key": "Tag", "value": "string" }, { "key": "IDModule", "value": "string" }, { "key": "Comission", "value": "1" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "InvoiceDateFrom", "value": "1980-02-08" }, { "key": "InvoiceDateTo", "value": "1980-02-08" }, { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "488d169e-1892-44bf-8bc3-0994e367a85f", "name": "Cria um usuário", "request": { "name": "Cria um usuário", "description": { "content": "Cadastra um usuário na empresa autenticada. É obrigatório informar `UserName` e pelo menos um identificador de login: `Login` (e-mail) **ou** `UserCpfCnpj`. Quando só o documento é enviado, o sistema gera um login interno no formato `@email.com.br`. Quando um e-mail real é informado, um e-mail de boas-vindas é enviado.\n\nSe já existir um registro de pessoa com o mesmo `Login`/`UserCpfCnpj` em outra conta (ou desvinculado), o cadastro **reaproveita e revincula** esse registro à empresa atual em vez de duplicar. Nesse caminho de revínculo apenas os dados do vínculo com a empresa são aplicados — os dados pessoais já existentes da pessoa (`UserName`, `UserTelephone`, `UserExtenalId`, `MFAEnabled`, `MFAType`) e `RestrictAccessSalesman` são preservados como estavam. `Login` e `UserCpfCnpj` precisam ser únicos dentro da empresa.\n\nO cadastro também aceita os dados profissionais do colaborador — funções, função atual, cargo, escala, supervisor e categorias/grupos de endereço de armazenagem —, validados contra os cadastros da empresa.", "type": "text/plain" }, "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"email\",\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 0,\n \"DiscountPercentLimit\": 9588.294688732592,\n \"IDTypeSalesmanCommission\": 1,\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 7193,\n \"IDUserJobTitle\": 3425,\n \"IDUserWorkScale\": 6750,\n \"IDUserUpper\": 9783,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c66502e9-b5c7-4019-8d7e-a0ca06d1e6f7", "name": "Usuário criado. Quando o login foi gerado a partir do documento, retorna a string `\"sucesso\"`. Quando um e-mail real foi informado, retorna o detalhe completo do usuário (mesmo formato de `GET /user/{iduser}`).", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"email\",\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 0,\n \"DiscountPercentLimit\": 9588.294688732592,\n \"IDTypeSalesmanCommission\": 1,\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 7193,\n \"IDUserJobTitle\": 3425,\n \"IDUserWorkScale\": 6750,\n \"IDUserUpper\": 9783,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33d8918c-27ea-4e56-81eb-4441f44540d0", "name": "Erros (prefixo `[BadRequest]`):\n- `CPF / CNPJ inválido, verificar os números digitados`\n- `Email inválido, verificar`\n- `Tipo de MFA inválido`\n- `Tipo de comissão não existe`\n- `Documento obrigatório quando não é informado`\n- `Documento e/ou email obrigatório para cadastrar usuário`\n- `Email já está vinculado a outro usuário`\n- `Documento já está vinculado a outro usuário`\n- `Empresa não existe`\n- `Problema ao criar usuário`\n\nValidação dos dados profissionais:\n- `Função não existente, preencha corretamente`\n- `Função atual não atribuída ao colaborador`\n- `Cargo não existe, preencha corretamente`\n- `Função não permitida para o cargo selecionado`\n- `Escala não existe, preencha corretamente`\n- `Colaborador superior não existe, preencha corretamente`\n- `Categoria de armazenamento não existe`\n- `Grupo de armazenamento não existe`", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"email\",\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 0,\n \"DiscountPercentLimit\": 9588.294688732592,\n \"IDTypeSalesmanCommission\": 1,\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 7193,\n \"IDUserJobTitle\": 3425,\n \"IDUserWorkScale\": 6750,\n \"IDUserUpper\": 9783,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8991e507-dc4d-41c4-a970-571e351581f8", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"email\",\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 0,\n \"DiscountPercentLimit\": 9588.294688732592,\n \"IDTypeSalesmanCommission\": 1,\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 7193,\n \"IDUserJobTitle\": 3425,\n \"IDUserWorkScale\": 6750,\n \"IDUserUpper\": 9783,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8db230a4-c3ac-46b6-b088-60aad4c45b65", "name": "Detalha um usuário", "request": { "name": "Detalha um usuário", "description": { "content": "Retorna o cadastro completo do usuário na empresa: dados pessoais e profissionais (função, cargo, escala de trabalho, supervisor imediato e módulo atual), flags de vendedor, técnico e comissão, funções (`UserJobPositionList`), perfis de acesso (`UserPrivilegeGroup`), regras de comissão (`SalesmanComission`), vínculos de empresa/filial faturadora (`UserCompanyInvoice`), centros de distribuição (`UserCompanyDistributionCenter`), categorias de fornecedor (`UserCompanySupplierCategory`), categorias e grupos de endereço de estoque (`StockKeepingUnitLocationCategories`, `StockKeepingUnitLocationGroups`), etiquetas do colaborador (`Tags`) e a auditoria de alterações (`UserLog`) e de acessos (`LoginLog`).\n\nO parâmetro `Type` troca o endpoint para dois modos enxutos, usados no carregamento da tela inicial: `Tours` devolve apenas os tours de apresentação já vistos e `Dashboard` devolve a configuração de painel já resolvida (a pessoal quando existe, senão a do perfil de acesso) junto com as preferências de arrumação da home.\n\nNo modo padrão considera apenas o vínculo **ativo** (`status=1`); informe `status` na query para buscar por outro status. Quando não há vínculo no status pedido, retorna um array vazio (`[]`) com status 200.\n\n**Alertas de gráfico (`ChartAlert=1`).** Com `ChartAlert=1`, o endpoint devolve, para o **painel de alertas** do Dashboard personalizado, o que o servidor registrou sobre os alertas de gráfico com aviso do usuário (`ChartAlertStatusList`): a situação de cada um (disparado, normal, ainda não checado, com erro ou sem valor para comparar), a última checagem, o último valor medido, o último aviso e, por alerta, os eventos mais recentes (disparou, avisou, voltou ao normal, falhou, desistiu…). Só leitura. Só o texto `1` liga o modo; com qualquer outro valor o parâmetro é ignorado.\n\n- **De quem são as linhas.** Sempre do usuário do token. O `{iduser}` do caminho tem de ser esse mesmo usuário, senão 400 sem dado nenhum; nenhum outro parâmetro nem o corpo escolhe outro usuário, e nenhum privilégio (nem o de editar o painel de outras pessoas) abre a linha de outra pessoa. Usuário ausente no token: 400.\n- **Não combina com `Type`.** `ChartAlert=1` junto com `Type` (qualquer valor) dá 400. `status` é ignorado.\n- **Sem filtro pela conta do subdomínio.** O painel pessoal é um só por usuário, aberto em qualquer conta dele, e cada alerta monitora a conta em que foi criado: ela vem em `IDCompany` e `AccountName`.\n- **Privilégio.** O modo não exige privilégio: a linha é do próprio usuário, e quem perdeu o privilégio de editar continua recebendo o aviso.\n- **O que nunca vem.** A configuração do alerta (condição, destinatários, janela), que já está no `DashboardConfig` do usuário (`PUT /user/{iduser}`); o detalhe do envio por destinatário (só as contagens, em `Delivery`); o texto do erro dos envios; e o texto do código `exception`. Endereços de e-mail nos motivos que vêm saem mascarados (`c***@dominio`).\n- **Casamento com o painel.** Cada alerta é identificado pela tripla `(PanelId, WidgetId, AlertId)`, a mesma do `DashboardConfig`. Um registro sem alerta correspondente no documento é de um salvamento ainda não sincronizado, e é atualizado ou removido no próximo salvamento do painel.\n- **Datas.** Texto `YYYY-MM-DD HH:MM` na hora de parede de São Paulo (horário de Brasília), sem fuso e sem `Z`. Não converter de fuso.\n- **Resposta.** Sempre um objeto com `Version: 1`. Sem nenhum alerta com aviso: `Alerts` vazio. Se só o histórico falhar, a situação vem e `EventsAvailable` é `false`. A resposta não é guardada em cache.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "1", "description": "Status do vínculo a buscar (1 = ativo, padrão; 0 = inativo). Ignorado nos modos `Type=Tours` e `Type=Dashboard`, em que o vínculo não é filtrado por status — nesses modos a resposta vem `[]` quando o usuário não pertence à conta. Ignorado também com `ChartAlert=1`." }, { "disabled": false, "key": "Type", "value": "TablePrefs", "description": "Troca o endpoint para um modo enxuto. `Tours` devolve só `ToursSeen`; `Dashboard` devolve `DashboardConfig` (a configuração pessoal quando existe, senão a do primeiro perfil de acesso que tiver uma) e `HomeConfig`. `TablePrefs` devolve as preferências de layout de tabela do usuário (uma linha por tela, com `PrefKey`, `Config` e `Revision`), opcionalmente filtradas por `PrefKey`. Omitido, devolve o cadastro completo. Diferencia maiúsculas de minúsculas. Não combina com `ChartAlert=1` (400)." }, { "disabled": false, "key": "PrefKey", "value": "string", "description": "Só com `Type=TablePrefs`: restringe a uma tela. Omitido, devolve todas (limite de 500)." }, { "disabled": false, "key": "ChartAlert", "value": "1", "description": "Com `1`, devolve a situação e os últimos disparos dos alertas de gráfico do usuário do token (`ChartAlertStatusList`) em vez do cadastro. O `{iduser}` do caminho tem de ser o próprio usuário do token, e o parâmetro não combina com `Type` (os dois casos dão 400). Qualquer outro valor é ignorado." }, { "disabled": false, "key": "Days", "value": "30", "description": "Só com `ChartAlert=1`: a janela dos eventos, em dias, contada para trás a partir de agora em São Paulo. Só dígitos; fora de 1 a 90: 400." }, { "disabled": false, "key": "Events", "value": "20", "description": "Só com `ChartAlert=1`: quantos eventos, os mais novos, vêm por alerta. Com `0`, o histórico não é lido e todo `Events` vem vazio (só a situação). Só dígitos; fora de 0 a 50: 400." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1d232cc4-a890-4a32-a85d-3ae573de86c3", "name": "Detalhe do usuário (array com 1 item) ou `[]` quando não há vínculo no status pedido. Com `ChartAlert=1`, a situação dos alertas de gráfico do usuário (`ChartAlertStatusList`): sempre um objeto com `Version: 1`, os alertas em ordem de criação, no máximo 200 (`Truncated` diz se havia mais).", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "1" }, { "key": "Type", "value": "TablePrefs" }, { "key": "PrefKey", "value": "string" }, { "key": "ChartAlert", "value": "1" }, { "key": "Days", "value": "30" }, { "key": "Events", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 4605,\n \"IDAcess\": 3719,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 1,\n \"LastLogin\": \"2007-10-19T00:45:23.478Z\",\n \"LastPasswordChange\": \"1964-04-30T08:22:09.417Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": null,\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 0,\n \"DiscountPercentLimit\": 4002.1119956589346,\n \"IDTypeSalesmanCommission\": 4,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 0,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 7070,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 9659,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 2697,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 6002,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 1755,\n \"RecordTimestamp\": \"2012-02-25T11:34:57.450Z\",\n \"DateFrom\": \"2024-08-02\",\n \"DateTo\": \"1959-09-23\",\n \"DiscountPercentLimit\": 3461.108583808896,\n \"ComissionPercent\": 13.699139868135202,\n \"IDCategory\": 5303,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1909,\n \"RecordTimestamp\": \"2009-03-15T00:22:52.902Z\",\n \"DateFrom\": \"1971-12-29\",\n \"DateTo\": \"1978-11-02\",\n \"DiscountPercentLimit\": 1789.5276893857438,\n \"ComissionPercent\": 1760.1491637605359,\n \"IDCategory\": 9850,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3554,\n \"IDCompany\": 5490,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 542,\n \"IDCompany\": 7520,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8636,\n \"IDStockKeepingUnitDistributionCenter\": 1634,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 5325,\n \"IDStockKeepingUnitDistributionCenter\": 937,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 6123,\n \"IDSupplierCategory\": 7707,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 1265,\n \"IDSupplierCategory\": 364,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 3814,\n \"RecordTimestamp\": \"1965-01-18T00:00:49.045Z\",\n \"RecordUserCreated\": 3619,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5773,\n \"RecordTimestamp\": \"1982-03-31T20:54:52.373Z\",\n \"RecordUserCreated\": 5408,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 6445,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1995-01-25T14:00:23.234Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 6765,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"2019-03-07T22:03:45.008Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 1527,\n \"IDUserJobTitle\": 6295,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 2460,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 6998,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 5931,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 8480,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 4705,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 8994,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6978,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": false,\n \"key_1\": false\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21a6291e-c0ba-4ca9-9b2e-2f2ba2b3a87b", "name": "Falha na consulta nos modos `Type=Tours` e `Type=Dashboard`, que devolvem o erro com o prefixo `[BadRequest]`. O modo padrão não emite 400.\n\nCom `ChartAlert=1`, mensagens possíveis:\n- `[BadRequest] - Usuário não identificado` — o token não traz o usuário.\n- `[BadRequest] - Alertas de gráfico só podem ser lidos pelo próprio usuário` — o `{iduser}` do caminho não é o usuário do token.\n- `[BadRequest] - Use ChartAlert ou Type, não os dois`\n- `[BadRequest] - Days precisa ser um inteiro de 1 a 90`\n- `[BadRequest] - Events precisa ser um inteiro de 0 a 50`\n- `[BadRequest] - Não foi possível ler os alertas ()` — falha ao ler os alertas; o código é o do banco (ou `exception`).", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "1" }, { "key": "Type", "value": "TablePrefs" }, { "key": "PrefKey", "value": "string" }, { "key": "ChartAlert", "value": "1" }, { "key": "Days", "value": "30" }, { "key": "Events", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "582c2da6-2d88-49b9-a150-69da96a15f7d", "name": "Só com `ChartAlert=1`: `[NotFound] - Histórico de alertas indisponível nesta base` — o histórico de alertas ainda não existe no banco de leitura. Tente de novo mais tarde.", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "1" }, { "key": "Type", "value": "TablePrefs" }, { "key": "PrefKey", "value": "string" }, { "key": "ChartAlert", "value": "1" }, { "key": "Days", "value": "30" }, { "key": "Events", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e799c01d-ff4f-4f23-80d0-ad5717eed3ee", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "1" }, { "key": "Type", "value": "TablePrefs" }, { "key": "PrefKey", "value": "string" }, { "key": "ChartAlert", "value": "1" }, { "key": "Days", "value": "30" }, { "key": "Events", "value": "20" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d571aa45-5a93-42ed-a9c2-516bef43545c", "name": "Atualiza um usuário", "request": { "name": "Atualiza um usuário", "description": { "content": "Atualiza os dados do usuário na empresa.\n\n**A atualização não é totalmente parcial — monte o corpo com o cadastro completo.** Os dados profissionais, o bloco de vendedor/comissão/técnico e as etiquetas só são tocados quando vêm no corpo, mas os dados pessoais são sempre reescritos: `UserCpfCnpj`, `UserTelephone`, `UserExtenalId`, `MFAEnabled` e `IDModuleFavorite` são gravados vazios quando omitidos, e omitir `MFAEnabled` ainda apaga o segredo do app autenticador. Envie sempre o cadastro inteiro (é o que a tela faz), não apenas o campo alterado.\n\nPela mesma razão, todo corpo que não seja um dos quatro atalhos exclusivos precisa trazer `Login` ou `UserCpfCnpj` — sem nenhum dos dois a requisição é recusada com `Documento e/ou email obrigatório para cadastrar usuário`. E enviar `UserCpfCnpj` sem `Login` substitui o login atual pelo login interno `@email.com.br`.\n\nQuando `Password` é enviado, a senha é validada contra a política da empresa (comprimento mínimo, complexidade, não repetir as 5 últimas senhas e validade). Alterar a senha de **outro** usuário exige o privilégio de redefinir senha; alterar a própria, não. Mudanças de campos são registradas em log de auditoria (valores de antes e depois).\n\nA atualização também cobre os **dados profissionais** do colaborador — funções, função atual, cargo, escala de trabalho, supervisor e categorias/grupos de endereço de armazenagem — e as etiquetas: o campo `Tags` substitui integralmente as etiquetas atuais.\n\nOs campos de vendedor, comissão e técnico — `RestrictAccessSalesman`, `DiscountPercentLimit`, `IDTypeSalesmanCommission`, `ExcludeCanceledOrdersCommission`, `ExcludeReturnedOrdersCommission` e `Technician` — só são gravados quando `Salesman` vem no **mesmo** corpo; enviados sozinhos, são ignorados.\n\nQuatro campos funcionam como **atalhos exclusivos**: só têm efeito quando são o único campo do corpo, e nesse caso apenas eles são salvos e a resposta é uma string curta de confirmação em vez do detalhe do usuário — `IDModuleCurrent` (`Módulo atual atualizado`), `TourSeen` (`Tour marcado como visto`), `HomeConfig` (`Preferências da home salvas`) e `DashboardConfig` (`Dashboard salvo`). Enviados junto com outros campos, os quatro são simplesmente ignorados.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"Password\": \"string\",\n \"MFAEnabled\": 0,\n \"MFAType\": \"email\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Status\": 1,\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 5729.555003333773,\n \"IDTypeSalesmanCommission\": 4,\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 1,\n \"Technician\": 1,\n \"IDUserJobPositionCurrent\": 7809,\n \"IDUserJobTitle\": 7502,\n \"IDUserWorkScale\": 2706,\n \"IDUserUpper\": 421,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"IDModuleCurrent\": 4708,\n \"TourSeen\": \"string\",\n \"HomeConfig\": {\n \"cardOrder\": {},\n \"chartLayouts\": {\n \"key_0\": {\n \"x\": 6907.681311182312,\n \"y\": 7827.92164520167,\n \"w\": 2800.3499779740705,\n \"h\": 6636.378111380545\n },\n \"key_1\": {\n \"x\": 3746.3496597520084,\n \"y\": 5684.580976404208,\n \"w\": 2018.1990147952722,\n \"h\": 4736.33333115544\n }\n },\n \"quickActions\": {},\n \"pipelineStages\": {},\n \"pipelineStatus\": {}\n },\n \"DashboardConfig\": \"string\",\n \"TablePreference\": \"{\\\"page:PageListOrders:main\\\":{\\\"v\\\":1,\\\"order\\\":null,\\\"cols\\\":{\\\"OrderNumber\\\":{\\\"w\\\":160}}}}\",\n \"Logout\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "256dc8cd-64cb-4a53-b051-11b700fbfbbc", "name": "Usuário atualizado. Retorna o detalhe completo (mesmo formato de `GET /user/{iduser}`).\n\nExceções — quando o corpo traz apenas um destes campos, a resposta é uma string:\n- `IDModuleCurrent` → `Módulo atual atualizado`\n- `TourSeen` → `Tour marcado como visto` (ou `Tour ignorado` quando a chave fica vazia após o saneamento)\n- `HomeConfig` → `Preferências da home salvas` (ou `Home ignorada` quando o corpo não é um objeto, ou `Home sem alterações` quando nenhuma chave é aproveitável)\n- `DashboardConfig` → `Dashboard salvo`", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"Password\": \"string\",\n \"MFAEnabled\": 0,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Status\": 1,\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 4765.274480791535,\n \"IDTypeSalesmanCommission\": 1,\n \"ExcludeCanceledOrdersCommission\": 0,\n \"ExcludeReturnedOrdersCommission\": 1,\n \"Technician\": 0,\n \"IDUserJobPositionCurrent\": 4480,\n \"IDUserJobTitle\": 9222,\n \"IDUserWorkScale\": 4058,\n \"IDUserUpper\": 7973,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"IDModuleCurrent\": 5557,\n \"TourSeen\": \"string\",\n \"HomeConfig\": {\n \"cardOrder\": {},\n \"chartLayouts\": {\n \"key_0\": {\n \"x\": 7786.932705236416,\n \"y\": 1845.540144401896,\n \"w\": 3849.7255717457633,\n \"h\": 1149.6001108028443\n },\n \"key_1\": {\n \"x\": 7432.389640538171,\n \"y\": 9683.518182102833,\n \"w\": 5758.312397285547,\n \"h\": 9845.76367131946\n }\n },\n \"quickActions\": {},\n \"pipelineStages\": {},\n \"pipelineStatus\": {}\n },\n \"DashboardConfig\": \"string\",\n \"TablePreference\": \"{\\\"page:PageListOrders:main\\\":{\\\"v\\\":1,\\\"order\\\":null,\\\"cols\\\":{\\\"OrderNumber\\\":{\\\"w\\\":160}}}}\",\n \"Logout\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c79070be-a803-4bde-8186-f27a4f7ab440", "name": "Erros (prefixo `[BadRequest]`):\n- `A lista de cargos do usuário deve conter apenas IDs separados por vírgula`\n- `CPF / CNPJ inválido, verificar os números digitados`\n- `Email inválido, verificar`\n- `Tipo de MFA inválido`\n- `Tipo de comissão não existe`\n- `Documento obrigatório quando não é informado`\n- `Documento e/ou email obrigatório para cadastrar usuário`\n- `A senha deve ter no mínimo N caracteres`\n- `A senha deve conter letras maiúsculas, minúsculas, números e caracteres especiais`\n- `Usuário não tem privilégio para resetar senha`\n- `A senha informada deve ser diferente das 5 últimas senhas utilizadas`\n- `Email já está vinculado a outro usuário`\n- `Documento já está vinculado a outro usuário`\n- `Usuário não existe`\n- `Função não existente, preencha corretamente`\n- `Função atual não atribuída ao colaborador`\n- `Categoria armazém não existe ()`\n- `Grupo endereços não existe`\n- `Escala não existe, preencha corretamente`\n- `Colaborador não pode ser seu próprio supervisor`\n- `Colaborador superior não existe, preencha corretamente`\n- `Colaborador é supervisor de outros colaboradores e não pode ter o vínculo profissional removido`\n- `Cargo não existe, preencha corretamente`\n- `Função não permitida para o cargo selecionado`", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"Password\": \"string\",\n \"MFAEnabled\": 0,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Status\": 1,\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 4765.274480791535,\n \"IDTypeSalesmanCommission\": 1,\n \"ExcludeCanceledOrdersCommission\": 0,\n \"ExcludeReturnedOrdersCommission\": 1,\n \"Technician\": 0,\n \"IDUserJobPositionCurrent\": 4480,\n \"IDUserJobTitle\": 9222,\n \"IDUserWorkScale\": 4058,\n \"IDUserUpper\": 7973,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"IDModuleCurrent\": 5557,\n \"TourSeen\": \"string\",\n \"HomeConfig\": {\n \"cardOrder\": {},\n \"chartLayouts\": {\n \"key_0\": {\n \"x\": 7786.932705236416,\n \"y\": 1845.540144401896,\n \"w\": 3849.7255717457633,\n \"h\": 1149.6001108028443\n },\n \"key_1\": {\n \"x\": 7432.389640538171,\n \"y\": 9683.518182102833,\n \"w\": 5758.312397285547,\n \"h\": 9845.76367131946\n }\n },\n \"quickActions\": {},\n \"pipelineStages\": {},\n \"pipelineStatus\": {}\n },\n \"DashboardConfig\": \"string\",\n \"TablePreference\": \"{\\\"page:PageListOrders:main\\\":{\\\"v\\\":1,\\\"order\\\":null,\\\"cols\\\":{\\\"OrderNumber\\\":{\\\"w\\\":160}}}}\",\n \"Logout\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77b73a70-0d56-4f27-81d0-60f0a98c7455", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserName\": \"string\",\n \"Login\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"Password\": \"string\",\n \"MFAEnabled\": 0,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Status\": 1,\n \"Salesman\": 0,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 4765.274480791535,\n \"IDTypeSalesmanCommission\": 1,\n \"ExcludeCanceledOrdersCommission\": 0,\n \"ExcludeReturnedOrdersCommission\": 1,\n \"Technician\": 0,\n \"IDUserJobPositionCurrent\": 4480,\n \"IDUserJobTitle\": 9222,\n \"IDUserWorkScale\": 4058,\n \"IDUserUpper\": 7973,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"IDModuleCurrent\": 5557,\n \"TourSeen\": \"string\",\n \"HomeConfig\": {\n \"cardOrder\": {},\n \"chartLayouts\": {\n \"key_0\": {\n \"x\": 7786.932705236416,\n \"y\": 1845.540144401896,\n \"w\": 3849.7255717457633,\n \"h\": 1149.6001108028443\n },\n \"key_1\": {\n \"x\": 7432.389640538171,\n \"y\": 9683.518182102833,\n \"w\": 5758.312397285547,\n \"h\": 9845.76367131946\n }\n },\n \"quickActions\": {},\n \"pipelineStages\": {},\n \"pipelineStatus\": {}\n },\n \"DashboardConfig\": \"string\",\n \"TablePreference\": \"{\\\"page:PageListOrders:main\\\":{\\\"v\\\":1,\\\"order\\\":null,\\\"cols\\\":{\\\"OrderNumber\\\":{\\\"w\\\":160}}}}\",\n \"Logout\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c3c971a-9eb3-494b-9b98-208171e39856", "name": "Remove o usuário da empresa", "request": { "name": "Remove o usuário da empresa", "description": { "content": "Remove o vínculo do colaborador com a empresa autenticada — apaga o vínculo com a empresa, os perfis de acesso, os vínculos de categoria de fornecedor e os vínculos de centro de distribuição daquela empresa. O cadastro global da pessoa é preservado quando ela ainda está vinculada a outra conta, mantendo o histórico e o login nas demais empresas.\n\nA exclusão é bloqueada quando o colaborador é supervisor de outros: nesse caso é preciso trocar o supervisor desses colaboradores antes de removê-lo. Em caso de sucesso, devolve o detalhe atualizado do usuário.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "1f4f1b35-337e-422e-a08e-632ea68f41bb", "name": "Vínculo removido. Retorna o detalhe do usuário atualizado.", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f43ec930-f941-4fde-a89f-ea41d2adfb6a", "name": "Requisição inválida. Mensagens possíveis: `[BadRequest] - Usuário não existe` — quando não há vínculo do usuário com a empresa; e `[BadRequest] - Não é possível excluir: este usuário é supervisor de outros colaboradores. Altere o supervisor deles antes de excluir.` — quando o colaborador é supervisor de outros e o supervisor deles precisa ser trocado antes da exclusão.", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ff51c0a-d4dc-4f2e-81da-e9814dce637c", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54f10907-3a46-464d-a474-4d5570e8f8ae", "name": "Lista os perfis de acesso do usuário", "request": { "name": "Lista os perfis de acesso do usuário", "description": { "content": "Retorna os perfis de acesso (grupos de privilégio) atualmente vinculados ao usuário na empresa autenticada.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "privilege", "privilege-group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e782ec86-491e-462c-860c-013d1998a7b9", "name": "Perfis de acesso vinculados ao usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "privilege", "privilege-group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUserPrivilegeGroup\": 9660,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 1419,\n \"PrivilegeGroupName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2526d2a4-33f8-49e3-b080-73f58951dc13", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "privilege", "privilege-group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2938b4c-8cf5-43f2-98c9-6af55b3b054b", "name": "Substitui os perfis de acesso do usuário", "request": { "name": "Substitui os perfis de acesso do usuário", "description": { "content": "Redefine, de uma vez, o conjunto de perfis de acesso do usuário: o corpo é a **lista completa** de identificadores de perfil (`IDUserPrivilegeGroup`) que o usuário deve passar a ter. Cada identificador é validado contra os perfis da empresa; os vínculos anteriores com perfis desta empresa são apagados e os novos inseridos, e a operação fica registrada em log. A lista precisa ter pelo menos um perfil — enviar uma lista vazia não remove os perfis do usuário.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "privilege", "privilege-group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n 12,\n 15\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0a2ab92a-2529-4ace-afe5-1a883fca2c8c", "name": "Perfis atualizados. Retorna o detalhe completo do usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "privilege", "privilege-group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 12,\n 15\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b2b23c6-b32b-4ed3-99eb-cfd746454420", "name": "Erros (prefixo `[BadRequest]`):\n- `Privilégio não encontrado` (um dos IDs não pertence à empresa)\n- `User não existe`", "originalRequest": { "url": { "path": [ "user", ":iduser", "privilege", "privilege-group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 12,\n 15\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49144b55-e752-44f2-aae3-913369a37534", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "privilege", "privilege-group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 12,\n 15\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e04df115-68ee-4963-87c1-83e83a14789f", "name": "Vincula uma empresa/filial faturadora ao usuário", "request": { "name": "Vincula uma empresa/filial faturadora ao usuário", "description": { "content": "Adiciona ao usuário o acesso a uma empresa/filial faturadora (`IDCompany`). Define em quais filiais emitentes o usuário pode operar.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "company-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompany\": 2543\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f2cd215d-5455-49d2-8190-0b0d70bf70f2", "name": "Vínculo criado. Retorna o detalhe completo do usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "company-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompany\": 2543\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f311b3c1-dfed-44a2-9d37-d9148e343f7d", "name": "Erros (prefixo `[BadRequest]`):\n- `Empresa não existe`\n- `Usuário não encontrado`", "originalRequest": { "url": { "path": [ "user", ":iduser", "company-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompany\": 2543\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b899d05-6c96-4144-bc2b-9d04befb7309", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "company-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompany\": 2543\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a0c814c-a92d-46ba-beaa-bfd64ab54d84", "name": "Remove o vínculo de empresa/filial faturadora", "request": { "name": "Remove o vínculo de empresa/filial faturadora", "description": { "content": "Desfaz o acesso do usuário a uma empresa/filial faturadora. A operação é registrada em log.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "company-invoice", ":idusercompanyinvoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanyinvoice", "description": "(Required) Identificador do vínculo de empresa/filial faturadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "9616bf13-4c34-4245-9ee7-85380887d791", "name": "Vínculo removido. Retorna o detalhe completo do usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "company-invoice", ":idusercompanyinvoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanyinvoice", "description": "(Required) Identificador do vínculo de empresa/filial faturadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93806bbf-65d3-4b4e-b751-cdd3360b9da6", "name": "Mensagem: `[BadRequest] - Empresa não localizada no cadastro do usuário`.", "originalRequest": { "url": { "path": [ "user", ":iduser", "company-invoice", ":idusercompanyinvoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanyinvoice", "description": "(Required) Identificador do vínculo de empresa/filial faturadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab83916c-777e-4960-839e-f04855b88062", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "company-invoice", ":idusercompanyinvoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanyinvoice", "description": "(Required) Identificador do vínculo de empresa/filial faturadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6e60f83-f1a4-46b1-a386-f5f322e82a98", "name": "Vincula um centro de distribuição ao usuário", "request": { "name": "Vincula um centro de distribuição ao usuário", "description": { "content": "Adiciona ao usuário o acesso a um centro de distribuição (`IDStockKeepingUnitDistributionCenter`). Restringe os CDs cujo estoque o usuário pode operar.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 7260\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ee4a3d75-607b-401d-bc42-3cca658073d0", "name": "Vínculo criado. Retorna o detalhe completo do usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 7260\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0cac034-65e3-4177-8d9c-124562e5197b", "name": "Erros (prefixo `[BadRequest]`):\n- `Centro de distribuição não existe`\n- `Usuário não encontrado`", "originalRequest": { "url": { "path": [ "user", ":iduser", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 7260\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e571526b-e9d3-4b9d-8aa9-1b66b9e68660", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitDistributionCenter\": 7260\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76fd22f6-02fc-4787-901c-6e844b60cb62", "name": "Remove o vínculo de centro de distribuição", "request": { "name": "Remove o vínculo de centro de distribuição", "description": { "content": "Desfaz o acesso do usuário a um centro de distribuição. A operação é registrada em log.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "distribution-center", ":idusercompanydistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanydistributioncenter", "description": "(Required) Identificador do vínculo de centro de distribuição." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "899cede6-1cea-4016-a9e5-7d53afb566c9", "name": "Vínculo removido. Retorna o detalhe completo do usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "distribution-center", ":idusercompanydistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanydistributioncenter", "description": "(Required) Identificador do vínculo de centro de distribuição." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b181a71b-37ed-4804-9234-a8d4457be548", "name": "Mensagem: `[BadRequest] - Empresa não localizada no cadastro do usuário`.", "originalRequest": { "url": { "path": [ "user", ":iduser", "distribution-center", ":idusercompanydistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanydistributioncenter", "description": "(Required) Identificador do vínculo de centro de distribuição." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdde21ac-22b0-4ac3-a32a-e27108ac80c8", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "distribution-center", ":idusercompanydistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusercompanydistributioncenter", "description": "(Required) Identificador do vínculo de centro de distribuição." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "500dc325-e054-49ef-95d3-7446db269b9f", "name": "Vincula uma categoria de fornecedor ao usuário", "request": { "name": "Vincula uma categoria de fornecedor ao usuário", "description": { "content": "Adiciona ao usuário o acesso a uma categoria de fornecedor (`IDSupplierCategory`). Restringe quais categorias de fornecedor o usuário enxerga/opera.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "supplier-category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 8466\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f53ac205-ef7a-4ee3-8b2f-3fa611418a7d", "name": "Vínculo criado. Retorna o detalhe completo do usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "supplier-category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 8466\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2484074-dcff-4c7d-b027-eabeee2b77b8", "name": "Erros (prefixo `[BadRequest]`):\n- `Categoria fornecedor não existe`\n- `Usuário não encontrado`", "originalRequest": { "url": { "path": [ "user", ":iduser", "supplier-category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 8466\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6958ddd7-970d-4288-b97c-28670bfa446d", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "supplier-category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplierCategory\": 8466\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7431404e-e6f2-416e-9f8c-c0bb1cbd1ac5", "name": "Remove o vínculo de categoria de fornecedor", "request": { "name": "Remove o vínculo de categoria de fornecedor", "description": { "content": "Desfaz o acesso do usuário a uma categoria de fornecedor. A operação é registrada em log.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "supplier-category", ":idusersuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusersuppliercategory", "description": "(Required) Identificador do vínculo de categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "d4b0de95-ea0d-4e40-926a-3d16f9c348bd", "name": "Vínculo removido. Retorna o detalhe completo do usuário.", "originalRequest": { "url": { "path": [ "user", ":iduser", "supplier-category", ":idusersuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusersuppliercategory", "description": "(Required) Identificador do vínculo de categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 2073,\n \"IDAcess\": 3786,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"UserCpfCnpj\": \"string\",\n \"UserTelephone\": \"string\",\n \"UserExtenalId\": \"string\",\n \"UserImageUrl\": \"string\",\n \"AccountName\": \"string\",\n \"Status\": 0,\n \"LastLogin\": \"1975-07-16T06:00:00.158Z\",\n \"LastPasswordChange\": \"1985-03-26T21:04:15.364Z\",\n \"MFAEnabled\": 1,\n \"MFAType\": \"totp\",\n \"IDModuleFavorite\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Salesman\": 1,\n \"RestrictAccessSalesman\": 1,\n \"DiscountPercentLimit\": 1144.5178305445224,\n \"IDTypeSalesmanCommission\": 1,\n \"TypeSalesmanCommission\": \"string\",\n \"ExcludeCanceledOrdersCommission\": 1,\n \"ExcludeReturnedOrdersCommission\": 0,\n \"Technician\": 1,\n \"UserJobPositionList\": [\n {\n \"IDUserJobPosition\": 8431,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 288,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"UserPrivilegeGroup\": [\n {\n \"IDUserPrivilegeGroup\": 4952,\n \"PrivilegeGroupName\": \"string\"\n },\n {\n \"IDUserPrivilegeGroup\": 3275,\n \"PrivilegeGroupName\": \"string\"\n }\n ],\n \"SalesmanComission\": [\n {\n \"IDSalesmanComission\": 266,\n \"RecordTimestamp\": \"1968-05-27T13:34:08.640Z\",\n \"DateFrom\": \"1973-12-19\",\n \"DateTo\": \"1961-04-21\",\n \"DiscountPercentLimit\": 1758.603948411166,\n \"ComissionPercent\": 7791.1436241448455,\n \"IDCategory\": 9813,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDSalesmanComission\": 1416,\n \"RecordTimestamp\": \"1977-02-08T13:37:33.814Z\",\n \"DateFrom\": \"1964-02-19\",\n \"DateTo\": \"1957-02-20\",\n \"DiscountPercentLimit\": 5391.952046373421,\n \"ComissionPercent\": 2338.7330756108927,\n \"IDCategory\": 4460,\n \"Category\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanyInvoice\": [\n {\n \"IDUserCompanyInvoice\": 3425,\n \"IDCompany\": 6280,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 5749,\n \"IDCompany\": 922,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\"\n }\n ],\n \"UserCompanyDistributionCenter\": [\n {\n \"IDUserCompanyDistributionCenter\": 8103,\n \"IDStockKeepingUnitDistributionCenter\": 4923,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyDistributionCenter\": 9628,\n \"IDStockKeepingUnitDistributionCenter\": 2703,\n \"DistributionCenterName\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserCompanySupplierCategory\": [\n {\n \"IDUserCompanySupplierCategory\": 8332,\n \"IDSupplierCategory\": 6377,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanySupplierCategory\": 8853,\n \"IDSupplierCategory\": 7539,\n \"CategoryDescription\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"UserLog\": [\n {\n \"IDUserLog\": 5859,\n \"RecordTimestamp\": \"1953-05-10T14:33:22.026Z\",\n \"RecordUserCreated\": 7779,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDUserLog\": 5230,\n \"RecordTimestamp\": \"1988-06-08T13:38:33.901Z\",\n \"RecordUserCreated\": 847,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ],\n \"LoginLog\": [\n {\n \"IDUserLogin\": 7351,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1950-11-24T21:40:02.081Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserLogin\": 4054,\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1969-09-06T20:46:39.499Z\",\n \"IP\": \"string\",\n \"AccountName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4464,\n \"IDUserJobTitle\": 2246,\n \"UserJobTitleName\": \"string\",\n \"IDWorkScale\": 388,\n \"UserWorkScaleName\": \"string\",\n \"IDUserUpper\": 8206,\n \"UserUpperName\": \"string\",\n \"IDModuleCurrent\": 4503,\n \"ModuleCurrentName\": \"string\",\n \"StockKeepingUnitLocationCategories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 9004,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 8113,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"StockKeepingUnitLocationGroups\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 7747,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 6070,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ],\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"ToursSeen\": {\n \"key_0\": true\n },\n \"DashboardConfig\": \"string\",\n \"HomeConfig\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbd18259-40d1-41df-88bd-b1cacc96bbf3", "name": "Mensagem: `[BadRequest] - Categoria fornecedor não localizada no cadastro do usuário`.", "originalRequest": { "url": { "path": [ "user", ":iduser", "supplier-category", ":idusersuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusersuppliercategory", "description": "(Required) Identificador do vínculo de categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20d59650-f7ba-436f-9d7a-a53f3c6df767", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "supplier-category", ":idusersuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idusersuppliercategory", "description": "(Required) Identificador do vínculo de categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "254ad4bb-2d53-4679-acfd-a289a8ce3eab", "name": "Define a foto do usuário", "request": { "name": "Define a foto do usuário", "description": { "content": "Define a imagem de perfil do usuário. Aceita dois formatos:\n- **Upload de arquivo** (`multipart/form-data`, campo `file`) — envia o binário da imagem.\n- **JSON com `Url`** — o sistema baixa a imagem dessa URL e a armazena.\n\nA imagem é salva no armazenamento público e o endereço final é gravado em `UserImageUrl`.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "Arquivo de imagem a enviar." } ] } }, "response": [ { "id": "7ec24f1f-3e05-41fa-aa37-4449bc2ef57c", "name": "Imagem definida com sucesso.", "originalRequest": { "url": { "path": [ "user", ":iduser", "image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo de imagem a enviar.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab399517-5800-406b-9a04-1c67328ee231", "name": "Falha ao processar/baixar a imagem. Mensagem possível: `[BadRequest] - erro ao baixar imagem`.", "originalRequest": { "url": { "path": [ "user", ":iduser", "image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo de imagem a enviar.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e29af511-7325-4f3c-8a83-5226a5e77763", "name": "Usuário não encontrado na empresa.", "originalRequest": { "url": { "path": [ "user", ":iduser", "image" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo de imagem a enviar.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed925b45-b8dd-4300-984f-1ec7767f79ab", "name": "Confirma a senha do usuário (reautenticação)", "request": { "name": "Confirma a senha do usuário (reautenticação)", "description": { "content": "Revalida a senha do usuário para liberar uma ação sensível (reautenticação). Compara a senha enviada com a cadastrada e, opcionalmente, verifica se o usuário possui o privilégio informado em `UserPrivilege`. Em caso de sucesso, devolve o usuário com um token temporário (`TempAuthToken`) para autorizar a ação seguinte.", "type": "text/plain" }, "url": { "path": [ "user", ":iduser", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"UserPrivilege\": 2715\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "22527758-1685-4184-b16b-39a35aac0d71", "name": "Senha confirmada. Retorna o usuário com `TempAuthToken`.", "originalRequest": { "url": { "path": [ "user", ":iduser", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"UserPrivilege\": 2715\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUser\": 1092,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"TempAuthToken\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d57dab71-599f-4052-8809-504aa36c2741", "name": "Erros (prefixo `[BadRequest]`):\n- `Usuário não tem senha cadastrada`\n- `Usuário não tem privilégio necessário para essa ação`\n- `Senha incorreta`\n- `Usuário não localizado`", "originalRequest": { "url": { "path": [ "user", ":iduser", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"UserPrivilege\": 2715\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "929ca440-ae4e-46d2-9dad-d3cc917f83c9", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "user", ":iduser", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduser", "description": "(Required) Identificador do usuário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"UserPrivilege\": 2715\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3efefb02-333a-43eb-93b1-79808c89bc56", "name": "Lista as empresas vinculadas ao usuário autenticado", "request": { "name": "Lista as empresas vinculadas ao usuário autenticado", "description": { "content": "Retorna as empresas (vínculo `UserCompany`) às quais o usuário autenticado tem acesso, ordenadas por `AccountName`.", "type": "text/plain" }, "url": { "path": [ "user", "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "597877a5-ffe5-4b0e-a8c1-7dd89bcfa4d9", "name": "Lista de vínculos do usuário com empresas.", "originalRequest": { "url": { "path": [ "user", "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 6733,\n \"AccountName\": \"string\",\n \"IDUser\": 6995,\n \"Salesman\": 744,\n \"CertificadoBestBeforeDate\": \"1971-01-14\",\n \"CompanyTradeName\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 6280,\n \"CompanyNameCorporateName\": \"string\",\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"CompanyLogoUrl\": \"string\"\n },\n {\n \"IDCompany\": 7180,\n \"AccountName\": \"string\",\n \"IDUser\": 6620,\n \"Salesman\": 1553,\n \"CertificadoBestBeforeDate\": \"1962-12-27\",\n \"CompanyTradeName\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 4404,\n \"CompanyNameCorporateName\": \"string\",\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"CompanyLogoUrl\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6277d65-ef99-4abc-bccd-b4fcc444e57b", "name": "`[BadRequest] - não encontrado` — nenhum vínculo localizado.", "originalRequest": { "url": { "path": [ "user", "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dda59756-6738-43a4-b6f2-be0c6ccce40e", "name": "Lista as empresas faturadoras vinculadas ao usuário", "request": { "name": "Lista as empresas faturadoras vinculadas ao usuário", "description": { "content": "Retorna as empresas faturadoras (`UserCompanyInvoice`) às quais o usuário autenticado tem acesso, dentro do grupo da empresa identificada pelo subdomínio.", "type": "text/plain" }, "url": { "path": [ "user", "company-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6df5ee9c-b3d8-4955-aa60-9834f8e37296", "name": "Lista de empresas faturadoras. Retorna `[]` quando não houver vínculos.", "originalRequest": { "url": { "path": [ "user", "company-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUserCompanyInvoice\": 6060,\n \"IDCompany\": 3584,\n \"IDUser\": 4119,\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDUserCompanyInvoice\": 4739,\n \"IDCompany\": 1359,\n \"IDUser\": 6416,\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e40f2fd5-0e65-4c95-a87f-477c9544e99d", "name": "Monta o menu lateral do usuário", "request": { "name": "Monta o menu lateral do usuário", "description": { "content": "Retorna os grupos de módulos visíveis ao usuário autenticado, considerando os privilégios do perfil de acesso atribuído. Cada grupo traz seus módulos e, em `Version = 2`, também submódulos aninhados (estrutura hierárquica `Module` dentro de `Module`). Quando `Version` é diferente de `2`, devolve apenas o primeiro nível. Informando `IDUser`, o menu é montado para o usuário indicado em vez do autenticado.", "type": "text/plain" }, "url": { "path": [ "user", "menu" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Version", "value": "1", "description": "Versão do formato. `2` inclui submódulos aninhados em cada item; qualquer outro valor retorna apenas o primeiro nível." }, { "disabled": false, "key": "IDUser", "value": "2232", "description": "Monta o menu de outro usuário informado. Quando ausente, usa o usuário autenticado." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "46ef9ba3-c92a-47c4-903d-daf9e0bafbd3", "name": "Lista de grupos de módulos com seus módulos.", "originalRequest": { "url": { "path": [ "user", "menu" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Version", "value": "1" }, { "key": "IDUser", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDModuleGroup\": 3840,\n \"ModuleGroupDescription\": \"string\",\n \"iconName\": \"string\",\n \"newIconName\": \"string\",\n \"link\": \"string\",\n \"index\": 6399,\n \"Module\": [\n {\n \"IDUserPrivilege\": 6518,\n \"IDModule\": 3768,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\",\n \"Module\": [\n {\n \"IDUserPrivilege\": 8260,\n \"IDModule\": 4557,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"IDUserPrivilege\": 1414,\n \"IDModule\": 4709,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n },\n {\n \"IDUserPrivilege\": 2757,\n \"IDModule\": 7430,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\",\n \"Module\": [\n {\n \"IDUserPrivilege\": 3602,\n \"IDModule\": 2664,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"IDUserPrivilege\": 2183,\n \"IDModule\": 3164,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"IDModuleGroup\": 2981,\n \"ModuleGroupDescription\": \"string\",\n \"iconName\": \"string\",\n \"newIconName\": \"string\",\n \"link\": \"string\",\n \"index\": 7272,\n \"Module\": [\n {\n \"IDUserPrivilege\": 571,\n \"IDModule\": 933,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\",\n \"Module\": [\n {\n \"IDUserPrivilege\": 4093,\n \"IDModule\": 6336,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"IDUserPrivilege\": 9806,\n \"IDModule\": 5303,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n },\n {\n \"IDUserPrivilege\": 2681,\n \"IDModule\": 7129,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\",\n \"Module\": [\n {\n \"IDUserPrivilege\": 9658,\n \"IDModule\": 2448,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"IDUserPrivilege\": 6836,\n \"IDModule\": 1250,\n \"ModuleDescription\": \"string\",\n \"link\": \"string\",\n \"icon\": \"string\",\n \"newIcon\": \"string\",\n \"header\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44c32cbb-5504-4fd3-9919-25bdaa9f41c1", "name": "`[BadRequest] - Usuário não encontrado`.", "originalRequest": { "url": { "path": [ "user", "menu" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Version", "value": "1" }, { "key": "IDUser", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b239e50-b062-4012-be24-aec3208b83f2", "name": "Retorna os privilégios do usuário ou recria os dados de login", "request": { "name": "Retorna os privilégios do usuário ou recria os dados de login", "description": { "content": "Por padrão (`LoginData` ausente ou diferente de `1`), devolve a lista de perfis de acesso (`UserPrivilegeGroup`) da empresa com os módulos e privilégios de cada um, restritos ao que o usuário enxerga. Quando `LoginData=1`, recria o corpo de login do usuário autenticado — útil para o frontend reidratar a sessão com dados frescos (dados da empresa, tours de apresentação já vistos e as parametrizações da empresa).", "type": "text/plain" }, "url": { "path": [ "user", "privilege" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "LoginData", "value": "1", "description": "Quando `1`, retorna o corpo de login (`UserLoginPayload`) em vez da lista de perfis. Default `0`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "02f7a4f5-65c1-4b25-ae8d-076d8bb28eba", "name": "Conforme `LoginData`: lista de perfis (`UserPrivilegeGroup[]`) ou o corpo de login (`UserLoginPayload`). O corpo é equivalente ao campo `body` de `POST /user/signin/local`, exceto por `UserImageUrl`, `IDModuleFavorite` e `CompanyPaymentStatus`, que não são preenchidos aqui.", "originalRequest": { "url": { "path": [ "user", "privilege" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "LoginData", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDUserPrivilegeGroup\": 9120,\n \"PrivilegeGroupName\": \"string\",\n \"Module\": [\n {\n \"IDModule\": 127,\n \"ModuleDescription\": \"string\",\n \"Privilege\": [\n {\n \"IDUserPrivilege\": 3024,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n },\n {\n \"IDUserPrivilege\": 4213,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n }\n ]\n },\n {\n \"IDModule\": 1052,\n \"ModuleDescription\": \"string\",\n \"Privilege\": [\n {\n \"IDUserPrivilege\": 1,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n },\n {\n \"IDUserPrivilege\": 5685,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"IDUserPrivilegeGroup\": 9966,\n \"PrivilegeGroupName\": \"string\",\n \"Module\": [\n {\n \"IDModule\": 6914,\n \"ModuleDescription\": \"string\",\n \"Privilege\": [\n {\n \"IDUserPrivilege\": 5704,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n },\n {\n \"IDUserPrivilege\": 7688,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n }\n ]\n },\n {\n \"IDModule\": 1588,\n \"ModuleDescription\": \"string\",\n \"Privilege\": [\n {\n \"IDUserPrivilege\": 1728,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n },\n {\n \"IDUserPrivilege\": 7521,\n \"UserPrivilege\": \"string\",\n \"PrivilegeDescription\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de0f2248-c26b-4131-922a-edfbe5dc8d7e", "name": "Mensagens conhecidas:\n- `[BadRequest] - Usuário precisa estar logado`\n- `[BadRequest] - Usuário não encontrado`.", "originalRequest": { "url": { "path": [ "user", "privilege" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "LoginData", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89e815d5-2e55-4dfb-827f-618ad3901183", "name": "Lista tags de usuário", "request": { "name": "Lista tags de usuário", "description": { "content": "Lista as tags de acesso dos usuários das empresas do token, em ordem alfabética.", "type": "text/plain" }, "url": { "path": [ "user", "tag" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDAcess", "value": "string", "description": "Filtra as tags de um acesso específico. Quando omitido, retorna as tags de todos os acessos das empresas do token." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "811eedc1-81fd-403d-a193-b5ef182d08fd", "name": "Lista de tags de acesso, ordenada por `Tag` em ordem crescente. Pode vir vazia.", "originalRequest": { "url": { "path": [ "user", "tag" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDAcess", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Tag\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"Tag\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91dc7938-c974-45d1-98ce-dac4b450d92a", "name": "Lista cargos", "request": { "name": "Lista cargos", "description": { "content": "Lista os cargos das empresas do token, em ordem alfabética pelo nome do cargo. Por padrão traz apenas os cargos ativos; use `AllStatus=1` para incluir os inativos.", "type": "text/plain" }, "url": { "path": [ "user", "jobtitle" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDUserJobTitle", "value": "2232", "description": "Filtra um cargo específico pelo seu identificador. Quando omitido, retorna todos os cargos." }, { "disabled": false, "key": "AllStatus", "value": "1", "description": "Quando `1`, inclui também os cargos inativos no resultado. Omitido (ou diferente de `1`), retorna apenas os cargos ativos (`Status=1`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b871588b-0873-4525-96f7-de99c59cc8d9", "name": "Lista de cargos, ordenada pelo nome do cargo. Retorna array vazio quando não há cargos.", "originalRequest": { "url": { "path": [ "user", "jobtitle" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDUserJobTitle", "value": "2232" }, { "key": "AllStatus", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"UserJobTitleName\": \"string\",\n \"IDUserJobTitle\": 3202,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 5711,\n \"UserJobTitleUpperName\": \"string\",\n \"Status\": 9344,\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 3354,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 5189,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"JobPositionsName\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"UserJobTitleName\": \"string\",\n \"IDUserJobTitle\": 9175,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 9776,\n \"UserJobTitleUpperName\": \"string\",\n \"Status\": 8428,\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 2576,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 2323,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"JobPositionsName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04e27ef4-729f-4701-aa7b-b594ebab7c96", "name": "Cria um cargo", "request": { "name": "Cria um cargo", "description": { "content": "Cria um cargo. O nome deve ser único na empresa; funções e cargo superior informados precisam existir e pertencer à mesma empresa.\n\nA resposta é a lista contendo o cargo recém-criado, no mesmo formato do `GET /user/jobtitle`.", "type": "text/plain" }, "url": { "path": [ "user", "jobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserJobTitleName\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 4065\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "267b59be-9643-4325-8cf8-8221d9282834", "name": "Cargo criado. Retorna a lista contendo o cargo recém-criado.", "originalRequest": { "url": { "path": [ "user", "jobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserJobTitleName\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 4065\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"UserJobTitleName\": \"string\",\n \"IDUserJobTitle\": 5686,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 7317,\n \"UserJobTitleUpperName\": \"string\",\n \"Status\": 3691,\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 5534,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 3462,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"JobPositionsName\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"UserJobTitleName\": \"string\",\n \"IDUserJobTitle\": 8548,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 6739,\n \"UserJobTitleUpperName\": \"string\",\n \"Status\": 5341,\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 8199,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 8115,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"JobPositionsName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d55f242-c8fb-4057-81db-59b978b1a10f", "name": "Validação falhou (prefixo `[BadRequest]`). Mensagens possíveis: `Preencha corretamente o nome do cargo`, `Função não existente, preencha corretamente`, `Cargo superior não existe`, `Cargo já existe`, `Empresa não existe`, `Erro ao adicionar cargo`.", "originalRequest": { "url": { "path": [ "user", "jobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserJobTitleName\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 4065\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb9aff98-fe2d-4774-9677-1ee30d2ea5e9", "name": "Atualiza um cargo", "request": { "name": "Atualiza um cargo", "description": { "content": "Atualiza um cargo. O nome continua obrigatório e único na empresa. Para desvincular o cargo superior, envie `IDUserJobTitleUpper` vazio; para manter o superior atual, omita o campo. Retorna a lista contendo o cargo atualizado.", "type": "text/plain" }, "url": { "path": [ "user", "jobtitle", ":idjobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjobtitle", "description": "(Required) Identificador do cargo a atualizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"UserJobTitleName\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Status\": 2493,\n \"IDUserJobTitleUpper\": 9993\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dcd9e5db-9e59-429a-a3c4-ddfe0b8bc267", "name": "Cargo atualizado. Retorna a lista contendo o cargo atualizado.", "originalRequest": { "url": { "path": [ "user", "jobtitle", ":idjobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjobtitle", "description": "(Required) Identificador do cargo a atualizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserJobTitleName\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Status\": 2493,\n \"IDUserJobTitleUpper\": 9993\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"UserJobTitleName\": \"string\",\n \"IDUserJobTitle\": 6627,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobTitleUpper\": 6128,\n \"UserJobTitleUpperName\": \"string\",\n \"Status\": 8692,\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 8468,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 1111,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"JobPositionsName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b4e813-7944-44a8-b167-715ed07fd0dc", "name": "Requisição inválida. Mensagens possíveis: `[BadRequest] - Preencha corretamente o nome do cargo` (nome não enviado ou vazio); `[BadRequest] - Cargo não existe` (cargo informado não pertence à empresa); `[BadRequest] - Cargo já existente com esse nome` (nome já usado por outro cargo); `[BadRequest] - Função não existente, preencha corretamente` (alguma função em `IDUserJobPositionList` não existe na empresa); `[BadRequest] - Cargo superior não existe` (o cargo superior informado não existe na empresa); `[BadRequest] - Cargo não atualizado` (falha ao gravar a alteração).", "originalRequest": { "url": { "path": [ "user", "jobtitle", ":idjobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjobtitle", "description": "(Required) Identificador do cargo a atualizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserJobTitleName\": \"string\",\n \"IDUserJobPositionList\": \"string\",\n \"Status\": 2493,\n \"IDUserJobTitleUpper\": 9993\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6e2196d-ba6f-4927-95af-25ec985feae9", "name": "Exclui um cargo", "request": { "name": "Exclui um cargo", "description": { "content": "Exclui um cargo. A exclusão é bloqueada quando há colaboradores vinculados ao cargo ou quando ele é superior de outro cargo no organograma.", "type": "text/plain" }, "url": { "path": [ "user", "jobtitle", ":idjobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjobtitle", "description": "(Required) Identificador do cargo a excluir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8681e0eb-b86d-4090-86cd-0bf02f5be665", "name": "Cargo excluído. Devolve a string `\"Cargo excluído com sucesso\"`.", "originalRequest": { "url": { "path": [ "user", "jobtitle", ":idjobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjobtitle", "description": "(Required) Identificador do cargo a excluir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Cargo excluído com sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a646cb5b-2f68-4def-9c48-61b44c2f75e3", "name": "Regras impeditivas (prefixo `[BadRequest]`): `Informe corretamente o cargo` quando o identificador do cargo não é enviado; `Cargo não existe` quando não há cargo com esse identificador na empresa; `Há colaboradores com esse cargo, altere antes de excluir` quando existem colaboradores vinculados ao cargo; `Há cargos subordinados a este, altere antes de excluir` quando o cargo é superior de outro cargo no organograma.", "originalRequest": { "url": { "path": [ "user", "jobtitle", ":idjobtitle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjobtitle", "description": "(Required) Identificador do cargo a excluir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "08c75661-b796-4833-81f8-c63ec3b335bb", "name": "Categorias Similares", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "142bbf98-5972-45ae-8d1a-54251541cefc", "name": "Lista categorias similares do SKU", "request": { "name": "Lista categorias similares do SKU", "description": { "content": "Lista as categorias adicionais associadas ao SKU para fins de classificação cruzada (recomendação, navegação alternativa).", "type": "text/plain" }, "url": { "path": [ "sku", "similarcategory", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d6faa418-151d-40cf-9877-93776de5b0e8", "name": "Lista de categorias similares.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSimilarCategory\": 5773,\n \"IDCategory\": 8454,\n \"CategoryTree\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCategory\": 8798,\n \"IDCategory\": 3265,\n \"CategoryTree\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "301bb2f6-f179-4556-abbb-be89bca7ff00", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "665f4632-dd3d-4f38-98bf-5e329a9cfc81", "name": "Adiciona uma categoria similar ao SKU", "request": { "name": "Adiciona uma categoria similar ao SKU", "description": { "content": "Vincula uma categoria adicional ao SKU.", "type": "text/plain" }, "url": { "path": [ "sku", "similarcategory", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCategory\": 1668\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1093b9ee-98f4-4af2-ac47-5d9f7164b547", "name": "Categoria adicionada. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCategory\": 1668\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSimilarCategory\": 5773,\n \"IDCategory\": 8454,\n \"CategoryTree\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCategory\": 8798,\n \"IDCategory\": 3265,\n \"CategoryTree\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c027ddb-074d-430d-8a36-08634906a8e0", "name": "Prefixo `[BadRequest]`. Mensagens: `Sku não existe`, `IDCategory não existe`.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCategory\": 1668\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5e6b98b-2ee5-4684-9d79-e15a1366e1e8", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCategory\": 1668\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00922282-606b-469a-9aa6-e7c7d19e64af", "name": "Remove uma categoria similar do SKU", "request": { "name": "Remove uma categoria similar do SKU", "description": { "content": "Remove o vínculo entre o SKU e a categoria similar.", "type": "text/plain" }, "url": { "path": [ "sku", "similarcategory", ":idsku", ":idstockkeepinunitsimilarcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepinunitsimilarcategory", "description": "(Required) Identificador do vínculo SKU/categoria similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "275497f5-4e99-470b-929d-8b90a30dc0e5", "name": "Vínculo removido. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku", ":idstockkeepinunitsimilarcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepinunitsimilarcategory", "description": "(Required) Identificador do vínculo SKU/categoria similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSimilarCategory\": 5773,\n \"IDCategory\": 8454,\n \"CategoryTree\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCategory\": 8798,\n \"IDCategory\": 3265,\n \"CategoryTree\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73f3f51f-800f-409d-a5d9-83cf91f812d0", "name": "Prefixo `[BadRequest]`. Mensagem: `Sku não existe`.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku", ":idstockkeepinunitsimilarcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepinunitsimilarcategory", "description": "(Required) Identificador do vínculo SKU/categoria similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d38b7a9-974f-4c63-8ccf-27388bff7c59", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "similarcategory", ":idsku", ":idstockkeepinunitsimilarcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepinunitsimilarcategory", "description": "(Required) Identificador do vínculo SKU/categoria similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fe52e3b4-2e36-4fd5-8be6-9ffc004524cd", "name": "Categorias de Fornecedor", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9a676ecf-3f45-4c0c-8232-a7a867a9d884", "name": "Lista categorias de fornecedor", "request": { "name": "Lista categorias de fornecedor", "description": { "content": "Retorna as categorias ativas da empresa, ordenadas pela descrição. Cada item já vem com o tipo de fornecedor resolvido (`TypeSupplier`). Aceita filtro opcional por `IDSupplierCategory` para retornar uma única categoria. Quando a empresa autenticada é a `all` (multi-conta), retorna as categorias de todas as empresas vinculadas.", "type": "text/plain" }, "url": { "path": [ "supplier", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDSupplierCategory", "value": "2232", "description": "Filtra por identificador de categoria. Quando omitido, devolve todas as categorias ativas da empresa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5d2ff108-b309-4158-bd05-8f193a41bcb3", "name": "Lista de categorias.", "originalRequest": { "url": { "path": [ "supplier", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDSupplierCategory", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDSupplierCategory\": 93,\n \"CategoryDescription\": \"string\",\n \"IDCompany\": 4451,\n \"IDTypeSupplier\": 9,\n \"TypeSupplier\": \"Transportadora\",\n \"SuppliersCategoryStatus\": 1,\n \"RecordTimestamp\": \"1957-07-05T07:33:05.905Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDSupplierCategory\": 2825,\n \"CategoryDescription\": \"string\",\n \"IDCompany\": 6059,\n \"IDTypeSupplier\": 9,\n \"TypeSupplier\": \"Insumo\",\n \"SuppliersCategoryStatus\": 0,\n \"RecordTimestamp\": \"1979-06-24T08:58:42.519Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "264e65d1-8ab6-4c8f-a550-75a6d6499e9a", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDSupplierCategory", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d324b43-f7c9-4954-8978-f90c45cca464", "name": "Cadastra uma categoria de fornecedor", "request": { "name": "Cadastra uma categoria de fornecedor", "description": { "content": "Cria uma categoria para a empresa autenticada. A resposta repete o formato da listagem — array com 1 item — já com o tipo de fornecedor resolvido.", "type": "text/plain" }, "url": { "path": [ "supplier", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "efe1426e-6f9e-47e2-a9fe-8bde52f017d9", "name": "Categoria criada.", "originalRequest": { "url": { "path": [ "supplier", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDSupplierCategory\": 4772,\n \"CategoryDescription\": \"string\",\n \"IDCompany\": 1421,\n \"IDTypeSupplier\": 7,\n \"TypeSupplier\": \"Serviço\",\n \"SuppliersCategoryStatus\": 0,\n \"RecordTimestamp\": \"2002-09-20T06:22:30.528Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae3e0c9e-b9cd-4e58-a7c4-1949cc0e3fd0", "name": "Empresa não localizada. Mensagem: `[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "supplier", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91aebe2d-cf0c-4928-aeeb-f4dabd5ea94e", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 7\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "477107fc-28ae-4c77-bf30-435fef0d504c", "name": "Atualiza uma categoria de fornecedor", "request": { "name": "Atualiza uma categoria de fornecedor", "description": { "content": "Atualiza a descrição e/ou o tipo de fornecedor de uma categoria existente. Ambos os campos são considerados em toda chamada — não é uma atualização parcial. A resposta repete o formato da listagem.", "type": "text/plain" }, "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 9\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b543fe24-959a-429d-ae49-4aa5f5de137d", "name": "Categoria atualizada.", "originalRequest": { "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 9\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDSupplierCategory\": 4772,\n \"CategoryDescription\": \"string\",\n \"IDCompany\": 1421,\n \"IDTypeSupplier\": 7,\n \"TypeSupplier\": \"Serviço\",\n \"SuppliersCategoryStatus\": 0,\n \"RecordTimestamp\": \"2002-09-20T06:22:30.528Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bf2c35b-e4fc-4630-8a08-a153329bd228", "name": "Categoria não encontrada para a empresa. Mensagem: `[BadRequest] - Categoria fornecedor não existe`.", "originalRequest": { "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 9\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b847227-3113-4309-a81f-225e0590d1db", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CategoryDescription\": \"string\",\n \"IDTypeSupplier\": 9\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22aa6a83-917c-4baf-a762-a91b2eb31137", "name": "Exclui (inativa) uma categoria de fornecedor", "request": { "name": "Exclui (inativa) uma categoria de fornecedor", "description": { "content": "Inativa a categoria (`SuppliersCategoryStatus = 0`). Não exclui fisicamente o registro. A exclusão é bloqueada quando há fornecedores ativos vinculados à categoria — nesse caso é preciso primeiro alterar a categoria no cadastro de cada fornecedor. A resposta é a lista atualizada das categorias ativas da empresa.", "type": "text/plain" }, "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "1c3a6e6b-84d1-464c-8c4d-9235db55240d", "name": "Categoria inativada. Devolve a lista atualizada das categorias ativas.", "originalRequest": { "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDSupplierCategory\": 93,\n \"CategoryDescription\": \"string\",\n \"IDCompany\": 4451,\n \"IDTypeSupplier\": 9,\n \"TypeSupplier\": \"Transportadora\",\n \"SuppliersCategoryStatus\": 1,\n \"RecordTimestamp\": \"1957-07-05T07:33:05.905Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDSupplierCategory\": 2825,\n \"CategoryDescription\": \"string\",\n \"IDCompany\": 6059,\n \"IDTypeSupplier\": 9,\n \"TypeSupplier\": \"Insumo\",\n \"SuppliersCategoryStatus\": 0,\n \"RecordTimestamp\": \"1979-06-24T08:58:42.519Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c48599fb-0066-4c6b-b903-2efc8dcdeaac", "name": "Categoria não encontrada ou possui fornecedores ativos. Mensagens: `[BadRequest] - Categoria fornecedor não existe`; `[BadRequest] - Existem fornecedores nessa categoria, alterar a categoria dentro do cadastro do fornecedor antes de excluir`.", "originalRequest": { "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "928f7d60-f549-4787-9f82-d4f6d54e1826", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "supplier", "category", ":idsuppliercategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsuppliercategory", "description": "(Required) Identificador da categoria de fornecedor." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "aa8fb78e-e6f7-4fc8-9d14-a1ec5ac28126", "name": "Categorias de Produto", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "13f030a6-be0e-494b-aea2-cb3ba7fdddab", "name": "Lista categorias", "request": { "name": "Lista categorias", "description": { "content": "Lista as categorias ativas da empresa autenticada. Com `Type=Tree` (modo usado pela tela) retorna a árvore aninhada, cada nó com `Children`. Sem `Type=Tree`, retorna uma lista achatada em que cada item traz `CategoryTree` — a trilha do caminho da raiz até a categoria (`Pai -> Filho -> Neto`).", "type": "text/plain" }, "url": { "path": [ "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "string", "description": "Use `Tree` para receber a árvore aninhada com `Children`. Omitido, retorna a lista achatada com a trilha `CategoryTree`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f7a5c399-092c-4e6f-868f-7f87898e3cf1", "name": "Árvore de categorias (modo `Type=Tree`).", "originalRequest": { "url": { "path": [ "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCategory\": 4959,\n \"Name\": \"string\",\n \"IDCategoryFather\": 1110,\n \"IsActive\": 8525,\n \"AccountName\": \"string\"\n },\n {\n \"IDCategory\": 9400,\n \"Name\": \"string\",\n \"IDCategoryFather\": 9715,\n \"IsActive\": 1310,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55c646f7-6393-4756-9f9f-c0054ecfdecf", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a5d7955-4420-41f2-a8bc-0a0c00bbb368", "name": "Cria categoria", "request": { "name": "Cria categoria", "description": { "content": "Cria uma categoria para a empresa autenticada. Quando `Description`, `Keywords` ou `Title` não são informados, assumem o valor de `Name`. Após inserir, reinvoca `categoryGet` e devolve a categoria criada (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 4555,\n \"ShowInStoreFront\": 5312,\n \"ShowBrandFilter\": 2317,\n \"ActiveStoreFrontLink\": 7711,\n \"Score\": 5988,\n \"IsActive\": 3002\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bb9029ec-fcff-48e0-8455-7bf0597a8221", "name": "Categoria criada (em formato de lista).", "originalRequest": { "url": { "path": [ "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 4555,\n \"ShowInStoreFront\": 5312,\n \"ShowBrandFilter\": 2317,\n \"ActiveStoreFrontLink\": 7711,\n \"Score\": 5988,\n \"IsActive\": 3002\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCategory\": 2305,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 143,\n \"CategoryFather\": \"string\",\n \"IsActive\": 8950,\n \"ShowInStoreFront\": 2401,\n \"ShowBrandFilter\": 3962,\n \"ActiveStoreFrontLink\": 3697,\n \"Score\": 6396,\n \"AccountName\": \"string\"\n },\n {\n \"IDCategory\": 3566,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 704,\n \"CategoryFather\": \"string\",\n \"IsActive\": 8633,\n \"ShowInStoreFront\": 8392,\n \"ShowBrandFilter\": 5126,\n \"ActiveStoreFrontLink\": 9031,\n \"Score\": 3698,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf0a2700-8976-4fb2-8944-91b05773df63", "name": "`[BadRequest] - Company não existe`.", "originalRequest": { "url": { "path": [ "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 4555,\n \"ShowInStoreFront\": 5312,\n \"ShowBrandFilter\": 2317,\n \"ActiveStoreFrontLink\": 7711,\n \"Score\": 5988,\n \"IsActive\": 3002\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b329a44a-a17d-4955-a68e-ee49b0d0186c", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 4555,\n \"ShowInStoreFront\": 5312,\n \"ShowBrandFilter\": 2317,\n \"ActiveStoreFrontLink\": 7711,\n \"Score\": 5988,\n \"IsActive\": 3002\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d41711cf-9b8f-43ca-bdc2-6f5ff6e393c7", "name": "Detalha categoria", "request": { "name": "Detalha categoria", "description": { "content": "Retorna os dados completos de uma categoria da empresa autenticada, incluindo `CategoryFather` (nome da categoria pai). Devolve uma lista vazia quando a categoria não existe.", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "85af7aec-76e3-4bbb-800e-a8d8604db675", "name": "Dados da categoria (em formato de lista; vazia se não existir).", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCategory\": 2305,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 143,\n \"CategoryFather\": \"string\",\n \"IsActive\": 8950,\n \"ShowInStoreFront\": 2401,\n \"ShowBrandFilter\": 3962,\n \"ActiveStoreFrontLink\": 3697,\n \"Score\": 6396,\n \"AccountName\": \"string\"\n },\n {\n \"IDCategory\": 3566,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 704,\n \"CategoryFather\": \"string\",\n \"IsActive\": 8633,\n \"ShowInStoreFront\": 8392,\n \"ShowBrandFilter\": 5126,\n \"ActiveStoreFrontLink\": 9031,\n \"Score\": 3698,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55490292-a127-46e7-8bac-ea505fb06fad", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9aad98a7-1b5c-4451-b4bc-f3b4a3392f74", "name": "Atualiza categoria", "request": { "name": "Atualiza categoria", "description": { "content": "Atualização parcial: apenas os campos enviados são alterados. Após atualizar, reinvoca `categoryGet` e devolve a categoria atualizada (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 8720,\n \"ShowInStoreFront\": 166,\n \"ShowBrandFilter\": 5222,\n \"ActiveStoreFrontLink\": 1297,\n \"Score\": 9745,\n \"IsActive\": 367\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "429747f8-2123-474c-a318-f86c13f8c58f", "name": "Categoria atualizada (em formato de lista).", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 8720,\n \"ShowInStoreFront\": 166,\n \"ShowBrandFilter\": 5222,\n \"ActiveStoreFrontLink\": 1297,\n \"Score\": 9745,\n \"IsActive\": 367\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCategory\": 2305,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 143,\n \"CategoryFather\": \"string\",\n \"IsActive\": 8950,\n \"ShowInStoreFront\": 2401,\n \"ShowBrandFilter\": 3962,\n \"ActiveStoreFrontLink\": 3697,\n \"Score\": 6396,\n \"AccountName\": \"string\"\n },\n {\n \"IDCategory\": 3566,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 704,\n \"CategoryFather\": \"string\",\n \"IsActive\": 8633,\n \"ShowInStoreFront\": 8392,\n \"ShowBrandFilter\": 5126,\n \"ActiveStoreFrontLink\": 9031,\n \"Score\": 3698,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f86e019f-a8ed-4221-b9d9-674fc45645e7", "name": "`[BadRequest] - Categoria não pode ser superior dela mesma`; `[BadRequest] - Categoria pai não localizada`; `[BadRequest] - Categoria não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 8720,\n \"ShowInStoreFront\": 166,\n \"ShowBrandFilter\": 5222,\n \"ActiveStoreFrontLink\": 1297,\n \"Score\": 9745,\n \"IsActive\": 367\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27857210-eefb-4d0e-9ae6-aea173e440ce", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Title\": \"string\",\n \"Keywords\": \"string\",\n \"IDCategoryFather\": 8720,\n \"ShowInStoreFront\": 166,\n \"ShowBrandFilter\": 5222,\n \"ActiveStoreFrontLink\": 1297,\n \"Score\": 9745,\n \"IsActive\": 367\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8704e8b0-2da5-428e-8580-f7fa08335205", "name": "Exclui categoria", "request": { "name": "Exclui categoria", "description": { "content": "Exclusão lógica (`Status = 0`) de uma categoria da empresa autenticada. **Bloqueada** quando a categoria tem produtos ativos vinculados ou quando possui subcategorias.", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b5061b49-83ba-4e96-b162-fbc64aaae624", "name": "Categoria excluída. Corpo: string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cfa030b-2ab5-4bb7-8a70-e7cd901bbfbc", "name": "`[BadRequest] - Categoria possui produto ativos. Alterar a categoria no cadastro do item antes de excluir a categoria`; `[BadRequest] - Categoria possui filhos (categoria inferior) que precisam ser removidas`; `[BadRequest] - Categoria não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01513781-e576-4cc0-8e50-a4544960723b", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f571a789-9ab2-4805-b36d-76d4a9c935e7", "name": "Centros de Distribuição", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b0ae5f48-4765-41a6-ad6a-b1ec5bfb0f02", "name": "Lista centros de distribuição", "request": { "name": "Lista centros de distribuição", "description": { "content": "Lista os centros de distribuição da empresa, ordenados por `DistributionCenterName`, já com o armazém de transferência por validade e os clientes vinculados resolvidos em `DistributionCenterConsumerList`. Identificadores que não correspondem mais a um cliente existente são omitidos dessa lista resolvida, que por isso pode ser menor que `DistributionCenterIDConsumerList`. Respeita a restrição de centros permitidos ao usuário — pedir um centro fora dessa restrição devolve lista vazia.", "type": "text/plain" }, "url": { "path": [ "sku", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitDistributionCenter", "value": "string", "description": "Filtra por id; aceita lista CSV." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7dab71a2-498b-4ea6-9d9b-8e91790c514e", "name": "Lista de CDs.", "originalRequest": { "url": { "path": [ "sku", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 4539,\n \"IDCompany\": 1032,\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"2024-01-05T05:55:00.580Z\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 8220,\n \"WarehouseBestBeforeDaysName\": \"string\",\n \"DistributionCenterIDConsumerList\": \"string\",\n \"DistributionCenterConsumerList\": [\n {\n \"IDConsumer\": 9303,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n },\n {\n \"IDConsumer\": 1953,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 2086,\n \"IDCompany\": 1479,\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"2007-09-23T12:02:08.357Z\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 4466,\n \"WarehouseBestBeforeDaysName\": \"string\",\n \"DistributionCenterIDConsumerList\": \"string\",\n \"DistributionCenterConsumerList\": [\n {\n \"IDConsumer\": 9317,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n },\n {\n \"IDConsumer\": 5358,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ff0f1b5-0749-4f49-9f87-159cb0d7d300", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99490790-f32e-4a8f-87af-bea8575a6361", "name": "Cria centro de distribuição", "request": { "name": "Cria centro de distribuição", "description": { "content": "Cria um centro de distribuição. O nome precisa ser único dentro da empresa. Quando `Default` é `1` — inclusive por omissão, já que esse é o valor assumido — os demais centros da empresa deixam de ser o padrão antes da criação; enviar `Default` como `0` é aceito sem exigir que outro centro já seja o padrão, diferente do que acontece na atualização. Aceita vincular até 5 clientes ao centro, cada um precisando pertencer à empresa e ter CPF/CNPJ cadastrado. Devolve a lista completa de centros já atualizada.", "type": "text/plain" }, "url": { "path": [ "sku", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 3827,\n \"DistributionCenterIDConsumerList\": [\n 6108,\n 7146\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b5a71085-079c-41d8-b420-af755961364b", "name": "CD criado (devolve lista completa).", "originalRequest": { "url": { "path": [ "sku", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 4688,\n \"DistributionCenterIDConsumerList\": [\n 6719,\n 3806\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 9335,\n \"IDCompany\": 3557,\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"2015-03-23T17:26:12.674Z\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 8761,\n \"WarehouseBestBeforeDaysName\": \"string\",\n \"DistributionCenterIDConsumerList\": \"string\",\n \"DistributionCenterConsumerList\": [\n {\n \"IDConsumer\": 5843,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n },\n {\n \"IDConsumer\": 7514,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 6855,\n \"IDCompany\": 3073,\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1997-02-17T09:09:24.691Z\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 5977,\n \"WarehouseBestBeforeDaysName\": \"string\",\n \"DistributionCenterIDConsumerList\": \"string\",\n \"DistributionCenterConsumerList\": [\n {\n \"IDConsumer\": 5569,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n },\n {\n \"IDConsumer\": 5531,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9157ebcb-6129-4366-9dc5-9b0e6b14cb92", "name": "`[BadRequest] - Já existe um centro de distribuição com este nome`; `[BadRequest] - Company não existe`.\n- `[BadRequest] - Só é permitido vincular até 5 clientes por Centro de Distribuição`\n- `[BadRequest] - IDConsumer inválido em DistributionCenterIDConsumerList` — quando algum identificador enviado na lista não é numérico\n- `[BadRequest] - Cliente não encontrado: ` — cliente inexistente ou de outra empresa\n- `[BadRequest] - Cliente sem CPF/CNPJ cadastrado: `", "originalRequest": { "url": { "path": [ "sku", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 4688,\n \"DistributionCenterIDConsumerList\": [\n 6719,\n 3806\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69093dbc-35fb-4b10-8684-ed1c289ef006", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "distribution-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 4688,\n \"DistributionCenterIDConsumerList\": [\n 6719,\n 3806\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cdf6a82-28c9-4741-9a55-097771c04539", "name": "Atualiza centro de distribuição", "request": { "name": "Atualiza centro de distribuição", "description": { "content": "Substitui os dados de um centro de distribuição. **Não é atualização parcial** — todo campo omitido do corpo é apagado, inclusive endereço, armazém de transferência por validade e clientes vinculados. Envie sempre o registro completo. O nome precisa continuar único dentro da empresa. Marcar `Default` como `1` retira o padrão dos demais centros; para gravar `Default` como `0` é preciso que outro centro já seja o padrão da empresa. Devolve a lista completa de centros já atualizada.", "type": "text/plain" }, "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 9377,\n \"DistributionCenterIDConsumerList\": [\n 1894,\n 9322\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "46df936d-a80d-4913-b5dd-4077972c07c1", "name": "CD atualizado.", "originalRequest": { "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 5521,\n \"DistributionCenterIDConsumerList\": [\n 4819,\n 8130\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 9335,\n \"IDCompany\": 3557,\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"2015-03-23T17:26:12.674Z\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 8761,\n \"WarehouseBestBeforeDaysName\": \"string\",\n \"DistributionCenterIDConsumerList\": \"string\",\n \"DistributionCenterConsumerList\": [\n {\n \"IDConsumer\": 5843,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n },\n {\n \"IDConsumer\": 7514,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 6855,\n \"IDCompany\": 3073,\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"RecordTimestamp\": \"1997-02-17T09:09:24.691Z\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 5977,\n \"WarehouseBestBeforeDaysName\": \"string\",\n \"DistributionCenterIDConsumerList\": \"string\",\n \"DistributionCenterConsumerList\": [\n {\n \"IDConsumer\": 5569,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n },\n {\n \"IDConsumer\": 5531,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcb7b43d-f5a5-4e04-86a9-abc6b7e3ad02", "name": "Mensagens (prefixo `[BadRequest]`):\n- `Centro de distribuição não existe`\n- `Já existe um centro de distribuição com este nome`\n- `É preciso ter um centro de distribuição padrão` — tentativa de deixar a empresa sem centro padrão.\n- `Só é permitido vincular até 5 clientes por Centro de Distribuição`\n- `IDConsumer inválido em DistributionCenterIDConsumerList`\n- `Cliente não encontrado: `\n- `Cliente sem CPF/CNPJ cadastrado: `", "originalRequest": { "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 5521,\n \"DistributionCenterIDConsumerList\": [\n 4819,\n 8130\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7bd6672-73b7-4552-9599-dd1627cd26ba", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"ShippingPostalCode\": \"string\",\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"IDStockKeepingUnitWarehouseBestBeforeDays\": 5521,\n \"DistributionCenterIDConsumerList\": [\n 4819,\n 8130\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9317b8dc-d772-4ed9-8c32-891d8a07f3bd", "name": "Exclui centro de distribuição", "request": { "name": "Exclui centro de distribuição", "description": { "content": "**Exclusão física** com várias regras de bloqueio em cascata:\n\n1. Armazéns vinculados → bloqueia.\n2. CD padrão → exige definir outro antes.\n3. Histórico de recebimento (`StockKeepingUnitPurchase`) → bloqueia.\n4. Histórico de pedidos (`Orders`) → bloqueia.\n5. Histórico de pedido de compra (`StockKeepingUnitBuyOrder`) → bloqueia.\n6. Usuários com vínculo (`UserCompanyDistributionCenter`) → bloqueia.\n7. Ressuprimento (`StockKeepingUnitResupplyList`) → bloqueia.\n8. Inventário (`StockKeepingUnitInventorySummary`) → bloqueia.", "type": "text/plain" }, "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "78c42183-de70-47f4-bc9a-7026fd99fa04", "name": "CD excluído.", "originalRequest": { "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4478e2c-7653-4c00-85c3-a7f930509bd4", "name": "`[BadRequest] - Existem armazéns vinculados a este centro de distribuição`; `[BadRequest] - Precisa definir outro centro de distribuição padrão antes de deletar`; `[BadRequest] - Centro de distribuição já teve recebimento e não pode ser excluído`; `[BadRequest] - Centro de distribuição já teve pedido e não pode ser excluído`; `[BadRequest] - Centro de distribuição já teve pedido de compra e não pode ser excluído`; `[BadRequest] - Centro de distribuição está vinculado a usuário e não pode ser excluído`; `[BadRequest] - Centro de distribuição está vinculado a ressuprimento e não pode ser excluído`; `[BadRequest] - Centro de distribuição está vinculado a inventário e não pode ser excluído`.", "originalRequest": { "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b477bcc6-ea2a-4df3-848d-6f441c5ebc7a", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "distribution-center", ":idstockkeepingunitdistributioncenter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitdistributioncenter", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c509bf7a-1973-46f7-ba38-aa3c61077785", "name": "Cobrança", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "122e480d-3750-4272-9766-cb3c24b0c1b9", "name": "Lista as faturas mensais de cobrança da empresa", "request": { "name": "Lista as faturas mensais de cobrança da empresa", "description": { "content": "Retorna o histórico de faturas geradas, com vencimento, valor total, nota fiscal de serviço associada e boleto. Cada fatura traz o detalhamento das regras de cobrança aplicadas no mês.", "type": "text/plain" }, "url": { "path": [ "company", "bill" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e6b8606f-c8e2-46ff-9e61-c09902271c15", "name": "Faturas encontradas.", "originalRequest": { "url": { "path": [ "company", "bill" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"Bills\": [\n {\n \"IDCompanyBilling\": 3083,\n \"RecordTimestamp\": \"1991-01-27T06:07:42.435Z\",\n \"BillingDateMonth\": \"1964-10-20T16:11:04.196Z\",\n \"DueDate\": \"1968-01-13\",\n \"TotalBillValue\": 9534.341852699128,\n \"IDServiceOrder\": 3985,\n \"NfsDate\": \"1969-10-09T07:46:55.134Z\",\n \"IDStatusInvoice\": 1737,\n \"NfsNumber\": \"string\",\n \"NfsVerificationCode\": \"string\",\n \"NfsValue\": 5319.302874740246,\n \"StatusInvoice\": \"string\",\n \"InvoiceUrl\": \"string\",\n \"IDStatusBankSlip\": 2,\n \"BankSlipUrl\": \"string\",\n \"IDBankSlip\": 1872,\n \"DatePaid\": \"1997-08-05T06:12:10.682Z\",\n \"StatusBankSlip\": \"string\",\n \"Charges\": [\n {\n \"IDCompanyBillingCharges\": 4521,\n \"TotalValue\": 6641.54137756736,\n \"TotalQuantity\": 9936,\n \"IDCompanyBillingRules\": 7063,\n \"DateFrom\": \"1961-10-10\",\n \"DateTo\": \"1961-11-04\",\n \"IDTypeCompanyBillingCharges\": 9888,\n \"RangeFrom\": 3104,\n \"RangeTo\": 5607,\n \"UnitValue\": 6124.3105666550355,\n \"MinimumValue\": 1279.3485221645296,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n },\n {\n \"IDCompanyBillingCharges\": 6904,\n \"TotalValue\": 5316.01334627819,\n \"TotalQuantity\": 4680,\n \"IDCompanyBillingRules\": 3312,\n \"DateFrom\": \"1993-08-18\",\n \"DateTo\": \"1957-06-12\",\n \"IDTypeCompanyBillingCharges\": 8587,\n \"RangeFrom\": 9146,\n \"RangeTo\": 1949,\n \"UnitValue\": 3190.922585530156,\n \"MinimumValue\": 8940.917704195297,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n }\n ]\n },\n {\n \"IDCompanyBilling\": 8230,\n \"RecordTimestamp\": \"1978-09-21T23:46:51.942Z\",\n \"BillingDateMonth\": \"1963-02-02T13:47:09.429Z\",\n \"DueDate\": \"2018-05-08\",\n \"TotalBillValue\": 9117.70720891426,\n \"IDServiceOrder\": 9794,\n \"NfsDate\": \"2001-05-19T22:11:57.083Z\",\n \"IDStatusInvoice\": 469,\n \"NfsNumber\": \"string\",\n \"NfsVerificationCode\": \"string\",\n \"NfsValue\": 7289.636617618942,\n \"StatusInvoice\": \"string\",\n \"InvoiceUrl\": \"string\",\n \"IDStatusBankSlip\": 1,\n \"BankSlipUrl\": \"string\",\n \"IDBankSlip\": 3722,\n \"DatePaid\": \"2019-02-27T17:42:31.679Z\",\n \"StatusBankSlip\": \"string\",\n \"Charges\": [\n {\n \"IDCompanyBillingCharges\": 7514,\n \"TotalValue\": 4406.899638518394,\n \"TotalQuantity\": 6420,\n \"IDCompanyBillingRules\": 7312,\n \"DateFrom\": \"1963-02-13\",\n \"DateTo\": \"1981-12-28\",\n \"IDTypeCompanyBillingCharges\": 3836,\n \"RangeFrom\": 1340,\n \"RangeTo\": 3589,\n \"UnitValue\": 2459.4198536264944,\n \"MinimumValue\": 366.44554019489294,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n },\n {\n \"IDCompanyBillingCharges\": 2905,\n \"TotalValue\": 949.878812185101,\n \"TotalQuantity\": 9083,\n \"IDCompanyBillingRules\": 706,\n \"DateFrom\": \"1996-06-13\",\n \"DateTo\": \"1986-06-16\",\n \"IDTypeCompanyBillingCharges\": 9356,\n \"RangeFrom\": 215,\n \"RangeTo\": 893,\n \"UnitValue\": 6957.556112886853,\n \"MinimumValue\": 4691.735240376344,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"Bills\": [\n {\n \"IDCompanyBilling\": 5825,\n \"RecordTimestamp\": \"2023-08-08T10:37:32.077Z\",\n \"BillingDateMonth\": \"2016-06-20T08:44:32.958Z\",\n \"DueDate\": \"1976-11-04\",\n \"TotalBillValue\": 46.25488797731947,\n \"IDServiceOrder\": 3553,\n \"NfsDate\": \"1996-07-28T21:20:28.526Z\",\n \"IDStatusInvoice\": 7540,\n \"NfsNumber\": \"string\",\n \"NfsVerificationCode\": \"string\",\n \"NfsValue\": 7635.863562561062,\n \"StatusInvoice\": \"string\",\n \"InvoiceUrl\": \"string\",\n \"IDStatusBankSlip\": 6,\n \"BankSlipUrl\": \"string\",\n \"IDBankSlip\": 2353,\n \"DatePaid\": \"1951-12-30T11:37:35.484Z\",\n \"StatusBankSlip\": \"string\",\n \"Charges\": [\n {\n \"IDCompanyBillingCharges\": 4654,\n \"TotalValue\": 4805.01242798296,\n \"TotalQuantity\": 9605,\n \"IDCompanyBillingRules\": 296,\n \"DateFrom\": \"2015-03-12\",\n \"DateTo\": \"1971-02-12\",\n \"IDTypeCompanyBillingCharges\": 5390,\n \"RangeFrom\": 9449,\n \"RangeTo\": 7939,\n \"UnitValue\": 7684.493068140908,\n \"MinimumValue\": 819.033137483216,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n },\n {\n \"IDCompanyBillingCharges\": 7501,\n \"TotalValue\": 3445.971187953949,\n \"TotalQuantity\": 8830,\n \"IDCompanyBillingRules\": 4149,\n \"DateFrom\": \"1996-02-28\",\n \"DateTo\": \"2025-01-24\",\n \"IDTypeCompanyBillingCharges\": 6663,\n \"RangeFrom\": 2963,\n \"RangeTo\": 8334,\n \"UnitValue\": 6832.186774996234,\n \"MinimumValue\": 4904.961877225256,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n }\n ]\n },\n {\n \"IDCompanyBilling\": 8213,\n \"RecordTimestamp\": \"1976-10-01T17:33:02.052Z\",\n \"BillingDateMonth\": \"1956-04-12T21:21:22.650Z\",\n \"DueDate\": \"2005-12-03\",\n \"TotalBillValue\": 1489.1876416373418,\n \"IDServiceOrder\": 1823,\n \"NfsDate\": \"1956-07-03T17:14:46.774Z\",\n \"IDStatusInvoice\": 9105,\n \"NfsNumber\": \"string\",\n \"NfsVerificationCode\": \"string\",\n \"NfsValue\": 4947.973990217572,\n \"StatusInvoice\": \"string\",\n \"InvoiceUrl\": \"string\",\n \"IDStatusBankSlip\": 3,\n \"BankSlipUrl\": \"string\",\n \"IDBankSlip\": 8991,\n \"DatePaid\": \"1955-12-08T02:38:58.356Z\",\n \"StatusBankSlip\": \"string\",\n \"Charges\": [\n {\n \"IDCompanyBillingCharges\": 7144,\n \"TotalValue\": 1071.2334786385513,\n \"TotalQuantity\": 713,\n \"IDCompanyBillingRules\": 1318,\n \"DateFrom\": \"1996-11-08\",\n \"DateTo\": \"1956-06-15\",\n \"IDTypeCompanyBillingCharges\": 8363,\n \"RangeFrom\": 3165,\n \"RangeTo\": 1077,\n \"UnitValue\": 6642.135199286705,\n \"MinimumValue\": 6072.103384674508,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n },\n {\n \"IDCompanyBillingCharges\": 7186,\n \"TotalValue\": 7810.973896742628,\n \"TotalQuantity\": 3949,\n \"IDCompanyBillingRules\": 1126,\n \"DateFrom\": \"1962-07-02\",\n \"DateTo\": \"1980-07-22\",\n \"IDTypeCompanyBillingCharges\": 9190,\n \"RangeFrom\": 134,\n \"RangeTo\": 3214,\n \"UnitValue\": 8158.894761201849,\n \"MinimumValue\": 4094.33965220906,\n \"Comments\": \"string\",\n \"TypeCompanyBillingCharges\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b284d721-7d18-4937-beaa-876d8714511c", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "company", "bill" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45a9c47a-32f2-4cd4-896a-f8e036895fe9", "name": "Gera o relatório detalhado de uma fatura e envia por e-mail", "request": { "name": "Gera o relatório detalhado de uma fatura e envia por e-mail", "description": { "content": "Gera a planilha com o detalhamento de uma fatura e a envia por e-mail ao usuário autenticado; a resposta HTTP não traz o arquivo (que chega por e-mail) e a planilha é montada e enviada durante a própria requisição, sem processamento em segundo plano.", "type": "text/plain" }, "url": { "path": [ "company", "bill", ":idcompanybilling", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanybilling", "description": "(Required) Identificador da fatura." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "POST", "auth": null }, "response": [ { "id": "8e0d6c94-f4fb-4c79-ae68-09df7e2cbc7e", "name": "Relatório gerado e enviado por e-mail ao usuário durante a requisição. Sem corpo na resposta.", "originalRequest": { "url": { "path": [ "company", "bill", ":idcompanybilling", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanybilling", "description": "(Required) Identificador da fatura." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75a4f201-ec76-4dcc-825c-180fd473ee31", "name": "Empresa ou fatura não localizada. Corpo JSON com `errorMessage` no formato `[BadRequest] - `: `[BadRequest] - Empresa não localizada`, `[BadRequest] - Fatura não localizada`.", "originalRequest": { "url": { "path": [ "company", "bill", ":idcompanybilling", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanybilling", "description": "(Required) Identificador da fatura." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c21df0f-9a6d-4c55-9bba-85631eedd0f2", "name": "Erro interno ao gerar o relatório (ex.: fatura sem itens detalhados). Corpo vazio.", "originalRequest": { "url": { "path": [ "company", "bill", ":idcompanybilling", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanybilling", "description": "(Required) Identificador da fatura." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8d016da2-db3d-4a7f-9313-25f2977cea7a", "name": "Coleções", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "782c9236-b677-421b-9488-1135b3db53c2", "name": "Lista coleções", "request": { "name": "Lista coleções", "description": { "content": "Lista as coleções da empresa, ordenadas por nome (`StockKeepingUnitCollectionName ASC`). Em contexto multi-conta (`accountname = all`), traz todas as contas acessíveis.", "type": "text/plain" }, "url": { "path": [ "sku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "StockKeepingUnitCollectionName", "value": "string", "description": "Filtra pelo nome da coleção." }, { "disabled": false, "key": "IDStockKeepingUnitCollection", "value": "string", "description": "Filtra pelo id da coleção." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0c43d60c-5eb1-47ba-a60f-7e0c124677d5", "name": "Lista de coleções.", "originalRequest": { "url": { "path": [ "sku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "StockKeepingUnitCollectionName", "value": "string" }, { "key": "IDStockKeepingUnitCollection", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitCollection\": 5077,\n \"IDCompany\": 4278,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1972-04-05T22:46:32.733Z\"\n },\n {\n \"IDStockKeepingUnitCollection\": 8915,\n \"IDCompany\": 3494,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1952-10-22T21:46:57.328Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a1f1047-90ff-45ec-8dcb-fd2d2b03bc04", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "StockKeepingUnitCollectionName", "value": "string" }, { "key": "IDStockKeepingUnitCollection", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bcea4eec-edf6-4e85-acd5-cdb8f633e213", "name": "Cria coleção", "request": { "name": "Cria coleção", "description": { "content": "Cria uma coleção para a empresa autenticada. Após inserir, reinvoca `skuCollectionList` e devolve a coleção criada (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "sku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1e3f8373-0c6a-4547-a821-880ec2f0fe31", "name": "Coleção criada (devolve a coleção em formato de lista).", "originalRequest": { "url": { "path": [ "sku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitCollection\": 5077,\n \"IDCompany\": 4278,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1972-04-05T22:46:32.733Z\"\n },\n {\n \"IDStockKeepingUnitCollection\": 8915,\n \"IDCompany\": 3494,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1952-10-22T21:46:57.328Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b255cc0-d351-41cc-a3a9-355b20ed8f86", "name": "`[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "sku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab533fff-f1d9-4f7f-b630-72b945151ed6", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29a8edd3-8502-449a-b9f9-b8baa8623433", "name": "Atualiza coleção", "request": { "name": "Atualiza coleção", "description": { "content": "Renomeia uma coleção da empresa autenticada. Após atualizar, reinvoca `skuCollectionList` e devolve a coleção atualizada (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2abaa454-14ab-448f-b81c-95c69d8530f0", "name": "Coleção atualizada (devolve a coleção em formato de lista).", "originalRequest": { "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitCollection\": 5077,\n \"IDCompany\": 4278,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1972-04-05T22:46:32.733Z\"\n },\n {\n \"IDStockKeepingUnitCollection\": 8915,\n \"IDCompany\": 3494,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1952-10-22T21:46:57.328Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae6f1765-93ec-484d-8311-a76e4a095921", "name": "`[BadRequest] - Coleção não existe`.", "originalRequest": { "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57d0b9b8-c492-4567-95bb-8de6e1ef4b2f", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitCollectionName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e29a50e-6280-486d-801d-25089a42531f", "name": "Exclui coleção", "request": { "name": "Exclui coleção", "description": { "content": "Exclui uma coleção da empresa autenticada. **Bloqueado** quando a coleção tem SKUs associados — é preciso remover os vínculos antes (endpoints `/sku/{idsku}/collection`).", "type": "text/plain" }, "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "39856ee9-2cf3-492f-97e4-29963b51bbfe", "name": "Coleção excluída. Corpo: string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "167848e7-2131-4bba-b39b-d034070eea85", "name": "`[BadRequest] - Coleção não existe`; `[BadRequest] - Coleção está associada a SKUs, remover o vínculo antes de excluir a coleção`.", "originalRequest": { "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e454d9a-f827-4bea-8eb1-07f84d892d2e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "collection", ":idstockkeepingunitcollection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollection", "description": "(Required) Id da coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72f1396c-c412-434d-99da-f529494c38b4", "name": "Lista coleções associadas ao SKU", "request": { "name": "Lista coleções associadas ao SKU", "description": { "content": "Lista as coleções a que o SKU está vinculado.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f5e8869e-6259-481e-b633-9183a4953f61", "name": "Lista de associações.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitCollectionAssociation\": 8462,\n \"IDSku\": 9371,\n \"IDStockKeepingUnitCollection\": 8024,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1966-12-20T12:52:32.570Z\"\n },\n {\n \"IDStockKeepingUnitCollectionAssociation\": 4920,\n \"IDSku\": 8469,\n \"IDStockKeepingUnitCollection\": 1064,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1999-10-20T10:29:27.834Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18e03e18-1404-40a5-8a96-290aceff68f0", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2075d6a3-49ad-4297-8c78-f8a4f589e7f4", "name": "Associa o SKU a uma coleção", "request": { "name": "Associa o SKU a uma coleção", "description": { "content": "Vincula o SKU à coleção informada. Cada par SKU/coleção é único.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 8038\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a1d0aa20-5f24-4321-89d0-3a52dbf7df71", "name": "Associação criada. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 8038\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitCollectionAssociation\": 8462,\n \"IDSku\": 9371,\n \"IDStockKeepingUnitCollection\": 8024,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1966-12-20T12:52:32.570Z\"\n },\n {\n \"IDStockKeepingUnitCollectionAssociation\": 4920,\n \"IDSku\": 8469,\n \"IDStockKeepingUnitCollection\": 1064,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1999-10-20T10:29:27.834Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f2280a8-6f05-4f6c-ab2d-d979f19cb946", "name": "Prefixo `[BadRequest]`. Mensagens: `Sku não existe`, `Sku já possui essa coleção`, `Coleção não existe`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 8038\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ebd9f8f2-1b91-438a-bbdf-a92d590f83d7", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 8038\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19c1b183-f2af-4791-932f-237ed33e31aa", "name": "Troca a coleção de uma associação existente", "request": { "name": "Troca a coleção de uma associação existente", "description": { "content": "Atualiza a coleção associada a um vínculo já existente.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 2830\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b27f8d2c-5518-4c53-acae-aa7963303074", "name": "Associação atualizada. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 2830\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitCollectionAssociation\": 8462,\n \"IDSku\": 9371,\n \"IDStockKeepingUnitCollection\": 8024,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1966-12-20T12:52:32.570Z\"\n },\n {\n \"IDStockKeepingUnitCollectionAssociation\": 4920,\n \"IDSku\": 8469,\n \"IDStockKeepingUnitCollection\": 1064,\n \"StockKeepingUnitCollectionName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1999-10-20T10:29:27.834Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bf29e04-e6e6-43b6-b73f-754ea3597de4", "name": "Prefixo `[BadRequest]`. Mensagens: `Coleção Sku não existe`, `Sku já possui essa coleção`, `Coleção não existe`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 2830\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "734f261a-646c-491e-bd1b-b0e3af42cf33", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitCollection\": 2830\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40f612a2-977c-4353-af64-2df87697f11f", "name": "Remove a associação SKU/coleção", "request": { "name": "Remove a associação SKU/coleção", "description": { "content": "Desvincula o SKU da coleção.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e9ac083a-9ceb-40ee-b892-97f96f416c08", "name": "Associação removida.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afc613e3-49e2-4a45-9ee4-f2bf8e878a91", "name": "Prefixo `[BadRequest]`. Mensagem: `Coleção Sku não existe`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9419cae-35d7-42b7-af82-ed0946625061", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "collection", ":idstockkeepingunitcollectionassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitcollectionassociation", "description": "(Required) Identificador da associação SKU/coleção." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "67b1a0d6-7bb2-4b2e-9463-8633f2f66098", "name": "Conciliação Bancária", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "146ab203-454c-4e6b-8a9c-6dca172e3360", "name": "Extrato bancário ou conciliação bancária", "request": { "name": "Extrato bancário ou conciliação bancária", "description": { "content": "Retorna lançamentos do extrato bancário. O comportamento muda conforme o valor de `Source`:\n\n- **`Source=1` (extrato interno)**: lista os lançamentos do extrato do idworks (entradas e saídas conciliadas com títulos a pagar/receber), com saldo corrente calculado linha a linha (`Balance`), saldo do período anterior (`PreviousBalance`), totais de recebimentos/pagamentos e saldo final. A resposta é um objeto único agregado.\n- **`Source=2` (extrato bancário)**: lista os lançamentos importados do banco (conciliação), agrupados por `IDBankStatementConciliation`, com a lista de contas internas (`InternalAccounts[]`) que casam com cada lançamento bancário, totais por tipo e diferença entre o valor lançado no banco e a soma das contas internas. A resposta é um array.\n- **`Source=1` com `IDBankStatementConciliation`** (modo especial): retorna apenas as contas internas vinculadas a uma conciliação bancária específica, como array.\n\nQuando `Source` não é `1` nem `2`, devolve erro. Aceita filtros de data (`DateFrom`/`DateTo`), conta bancária, tipo de transação, status de conciliação, e suporta paginação por `Page`.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Source", "value": "1", "description": "(Required) `1` extrato interno (idworks), `2` extrato bancário (importado)." }, { "disabled": false, "key": "IDBankAccount", "value": "2232", "description": "Filtra por conta bancária." }, { "disabled": false, "key": "IDCompany", "value": "2232", "description": "Filtra por empresa (quando o usuário tem acesso a múltiplas)." }, { "disabled": false, "key": "IDTypeAccount", "value": "1", "description": "Tipo do lançamento: 0=entrada, 1=saída." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial. No modo `Source=2`, default é `2025-01-01` quando omitida." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final. Default: hoje quando `DateFrom` for informada." }, { "disabled": false, "key": "Page", "value": "0", "description": "Página (5000 itens por página)." }, { "disabled": false, "key": "IDBankStatement", "value": "2232", "description": "Filtra por lançamento interno específico." }, { "disabled": false, "key": "IDBankStatementConciliation", "value": "2232", "description": "Em `Source=1`, ativa o modo especial que retorna apenas contas internas dessa conciliação. Em `Source=2`, restringe ao grupo." }, { "disabled": false, "key": "IDTypeStatusConciliation", "value": "4", "description": "(Source=2) Filtra por status da conciliação." }, { "disabled": false, "key": "OnlyTransfer", "value": "1", "description": "(Source=1) Quando `1`, traz apenas transferências (lançamentos sem título associado)." }, { "disabled": false, "key": "Ignore", "value": "2232", "description": "Reservado (lido do query mas sem efeito documentado no caminho atual)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d8f70ad6-9a60-46d4-ad9b-d40f48bf4f0d", "name": "Resultado depende de `Source` e dos filtros.", "originalRequest": { "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Source", "value": "1" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompany", "value": "2232" }, { "key": "IDTypeAccount", "value": "1" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Page", "value": "0" }, { "key": "IDBankStatement", "value": "2232" }, { "key": "IDBankStatementConciliation", "value": "2232" }, { "key": "IDTypeStatusConciliation", "value": "4" }, { "key": "OnlyTransfer", "value": "1" }, { "key": "Ignore", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"IDBankAccount\": 8212,\n \"PeriodStart\": \"string\",\n \"PeriodEnd\": \"string\",\n \"AccountName\": \"string\",\n \"PreviousBalance\": 7334.578690529205,\n \"Entries\": [\n {\n \"AccountName\": \"string\",\n \"IDBankAccount\": 5902,\n \"IDBankStatement\": 6367,\n \"TransactionDate\": \"2013-09-10\",\n \"Document\": \"string\",\n \"Description\": \"string\",\n \"IDTypeAccount\": 1,\n \"Value\": 9660.718225008506,\n \"IDSupplier\": 7609,\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 7973,\n \"ConsumerNameCorporateName\": \"string\",\n \"BankName\": \"string\",\n \"Balance\": 8803.512148756005,\n \"IDAccountPayableReceivable\": 6924\n },\n {\n \"AccountName\": \"string\",\n \"IDBankAccount\": 5088,\n \"IDBankStatement\": 2637,\n \"TransactionDate\": \"1947-02-01\",\n \"Document\": \"string\",\n \"Description\": \"string\",\n \"IDTypeAccount\": 0,\n \"Value\": 1088.8686106977307,\n \"IDSupplier\": 719,\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 8498,\n \"ConsumerNameCorporateName\": \"string\",\n \"BankName\": \"string\",\n \"Balance\": 9148.681170048154,\n \"IDAccountPayableReceivable\": 7134\n }\n ],\n \"Receivables\": 7375.664900687864,\n \"Payables\": 1269.9231605363836,\n \"FinalBalance\": 7629.741839583259\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87da6fda-8f22-41f7-96f6-d3825c9b2639", "name": "Erro de validação dos filtros enviados.", "originalRequest": { "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Source", "value": "1" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompany", "value": "2232" }, { "key": "IDTypeAccount", "value": "1" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Page", "value": "0" }, { "key": "IDBankStatement", "value": "2232" }, { "key": "IDBankStatementConciliation", "value": "2232" }, { "key": "IDTypeStatusConciliation", "value": "4" }, { "key": "OnlyTransfer", "value": "1" }, { "key": "Ignore", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad829fb4-b8cb-4930-869a-2720e3468e37", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Source", "value": "1" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompany", "value": "2232" }, { "key": "IDTypeAccount", "value": "1" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Page", "value": "0" }, { "key": "IDBankStatement", "value": "2232" }, { "key": "IDBankStatementConciliation", "value": "2232" }, { "key": "IDTypeStatusConciliation", "value": "4" }, { "key": "OnlyTransfer", "value": "1" }, { "key": "Ignore", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f78686e8-6a87-4d14-9af2-988e51a9a573", "name": "Concilia títulos ou transferências com um lançamento bancário ou de adquirente", "request": { "name": "Concilia títulos ou transferências com um lançamento bancário ou de adquirente", "description": { "content": "Vincula um conjunto de títulos a pagar/receber **ou** de transferências entre contas a um único lançamento — bancário ou de adquirente. O corpo deve identificar **exatamente uma** das duas conciliações em `IDBankStatementConciliation` (conciliação bancária) ou `IDAccountsPayableReceivableConciliation` (conciliação de adquirente), e também **exatamente uma** das listas: `Accounts[]` para títulos a pagar/receber, ou `Transfers[]` para transferências entre contas já lançadas.\n\nFluxo:\n\n- **Conciliação de adquirente** com `Accounts[]`: registra no extrato interno o lançamento de cada título, amarra esses lançamentos à conciliação de adquirente e marca a conciliação como conciliada manualmente (`IDTypeStatusConciliation=3`).\n- **Conciliação bancária** com `Accounts[]`: o status final depende dos valores — `3` (conciliada manualmente) quando o total dos títulos bate com o valor do lançamento bancário, `4` (conciliada parcialmente) quando ainda falta reconciliar.\n- **Quando o título já tem lançamento** com a mesma data da conciliação, o lançamento existente é reaproveitado em vez de criar novo. Lançamentos já vinculados a outra conciliação bloqueiam a operação.\n- **`Transfers[]`** liga transferências entre contas pré-lançadas (sem título associado) à conciliação. Transferências já conciliadas são rejeitadas.\n\nO valor total das contas não pode ultrapassar o valor do lançamento de conciliação (comparação em módulo, para suportar estornos).", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6662,\n \"IDBankStatementConciliation\": 370,\n \"IDAccountsPayableReceivableConciliation\": 3248,\n \"Accounts\": [\n {\n \"IDAccountPayableReceivable\": 9475\n },\n {\n \"IDAccountPayableReceivable\": 3488\n }\n ],\n \"Transfers\": [\n {\n \"IDBankStatement\": 1631\n },\n {\n \"IDBankStatement\": 1246\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ab06cd3f-a476-454a-afa1-a68d141bc756", "name": "Conciliação efetuada. Retorna um array com 1 item — a conciliação resultante com os lançamentos vinculados e o status final.", "originalRequest": { "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 108,\n \"IDBankStatementConciliation\": 8815,\n \"IDAccountsPayableReceivableConciliation\": 13,\n \"Accounts\": [\n {\n \"IDAccountPayableReceivable\": 2768\n },\n {\n \"IDAccountPayableReceivable\": 8083\n }\n ],\n \"Transfers\": [\n {\n \"IDBankStatement\": 7586\n },\n {\n \"IDBankStatement\": 8984\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankStatementConciliation\": 5201,\n \"IDAccountsPayableReceivableConciliation\": 7715,\n \"IDBankAccount\": 6783,\n \"TransactionDate\": \"1960-11-23\",\n \"BankTransactionID\": \"string\",\n \"Comments\": \"string\",\n \"BankValue\": 3488.4970523021066,\n \"BankName\": \"string\",\n \"IDTypeStatusConciliation\": 4,\n \"StatusDescription\": \"string\",\n \"IDTypeAccount\": 0,\n \"InternalAccounts\": [\n {\n \"IDBankStatement\": 2608,\n \"IDAccountPayableReceivable\": 1685,\n \"Description\": \"string\",\n \"Document\": \"string\",\n \"Value\": 8245.18270473952,\n \"IDTypeAccount\": 0\n },\n {\n \"IDBankStatement\": 2463,\n \"IDAccountPayableReceivable\": 6564,\n \"Description\": \"string\",\n \"Document\": \"string\",\n \"Value\": 9958.4697894507,\n \"IDTypeAccount\": 1\n }\n ],\n \"ERPValueTotal\": 1040.2499110175856,\n \"AccountName\": \"string\",\n \"Difference\": 3863.0842417333943\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c12f465-c8c7-4252-91af-a97c070b5dfd", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Lançamento de conciliação não selecionado`\n- `Informe apenas uma conciliação: bancária ou de adquirente`\n- `Conta bancária não selecionada`\n- `Contas a receber/pagar é obrigatório e deve ser um array com pelo menos um item`\n- `Transferência é obrigatória e deve ser um array com pelo menos um item`\n- `Accounts[]. Conta a pagar/receber não informada ou inválida`\n- `Transfers[]. Transferência não informada ou inválida`\n- `Empresa não encontrada`\n- `Lançamento de conciliação de adquirente não encontrado`\n- `Lançamento conciliação bancária não encontrado`\n- `Conta bancária não encontrada`\n- `Contas não encontradas: `\n- `O valor total dos lançamentos () é maior que o valor do título (). Código do título: . Lançamentos: `\n- `Divergência na data dos pagamentos realizados e a data do `\n- `Título já está conciliado na conciliação bancária código: `\n- `O valor total das contas () é maior que o valor do (). Não é possível conciliar.`\n- `Transferência(s) não encontradas ou já conciliadas: `\n- `Falha ao processar conciliação`", "originalRequest": { "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 108,\n \"IDBankStatementConciliation\": 8815,\n \"IDAccountsPayableReceivableConciliation\": 13,\n \"Accounts\": [\n {\n \"IDAccountPayableReceivable\": 2768\n },\n {\n \"IDAccountPayableReceivable\": 8083\n }\n ],\n \"Transfers\": [\n {\n \"IDBankStatement\": 7586\n },\n {\n \"IDBankStatement\": 8984\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b092230-dd74-4643-9e53-2adb97bc8d37", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 108,\n \"IDBankStatementConciliation\": 8815,\n \"IDAccountsPayableReceivableConciliation\": 13,\n \"Accounts\": [\n {\n \"IDAccountPayableReceivable\": 2768\n },\n {\n \"IDAccountPayableReceivable\": 8083\n }\n ],\n \"Transfers\": [\n {\n \"IDBankStatement\": 7586\n },\n {\n \"IDBankStatement\": 8984\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ff8b548-ad35-40a3-9977-40fe336078ce", "name": "Cria uma transferência entre contas bancárias", "request": { "name": "Cria uma transferência entre contas bancárias", "description": { "content": "Registra uma transferência de valor entre duas contas bancárias da empresa. Gera dois lançamentos no extrato interno (`AccountsPayableReceivableBankStatement`): um de débito (saída) na conta de origem e um de crédito (entrada) na conta de destino. Os dois lançamentos ficam ligados por uma referência única (`AccountsPayableReceivableBankStatementTransfer`), o que permite tratá-los como o mesmo movimento ao reconciliar.\n\nAs descrições dos lançamentos são geradas automaticamente concatenando a descrição informada (ou o texto padrão `Transferência entre contas`) com o banco e o número da conta do outro lado da operação. A origem e o destino não podem ser a mesma conta.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBankFrom\": 700,\n \"IDBankTo\": 4187,\n \"Value\": 1607.1592618407938,\n \"Date\": \"2007-05-14\",\n \"Description\": \"string\",\n \"Document\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ebfd5d3a-bcc3-4f3f-a720-3c6107e6bbae", "name": "Transferência registrada. Retorna detalhes da transferência e os dois lançamentos criados.", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankFrom\": 700,\n \"IDBankTo\": 4187,\n \"Value\": 1607.1592618407938,\n \"Date\": \"2007-05-14\",\n \"Description\": \"string\",\n \"Document\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"IDAccountsPayableReceivableBankStatementTransfer\": 9433,\n \"Transfer\": {\n \"From\": {\n \"IDBankAccount\": 7263,\n \"Bank\": \"string\",\n \"AccountNumber\": \"string\",\n \"IDBankStatement\": 103\n },\n \"To\": {\n \"IDBankAccount\": 4835,\n \"Bank\": \"string\",\n \"AccountNumber\": \"string\",\n \"IDBankStatement\": 9718\n },\n \"Value\": \"string\",\n \"TransactionDate\": \"1988-09-15\",\n \"Description\": \"string\",\n \"Document\": \"string\"\n },\n \"InsertedTransactions\": [\n {\n \"IDBankStatement\": 8823,\n \"IDBankAccount\": 6032,\n \"IDTypeAccount\": 1,\n \"Value\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"Credit\"\n },\n {\n \"IDBankStatement\": 3406,\n \"IDBankAccount\": 546,\n \"IDTypeAccount\": 1,\n \"Value\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"Debit\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c418e3e-e6e6-4bae-b05e-918596e40c10", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Conta bancária de origem não informada`\n- `Conta bancária de destino não informada`\n- `A conta de origem e destino não podem ser a mesma`\n- `Valor deve ser maior que zero`\n- `Empresa não encontrada`\n- `Uma ou ambas as contas bancárias não foram encontradas ou não pertencem a esta empresa`\n- `Conta bancária de origem não encontrada`\n- `Conta bancária de destino não encontrada`\n- `Falha ao inserir transação de débito`\n- `Falha ao inserir transação de crédito`\n- `Falha ao processar transferência`", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankFrom\": 700,\n \"IDBankTo\": 4187,\n \"Value\": 1607.1592618407938,\n \"Date\": \"2007-05-14\",\n \"Description\": \"string\",\n \"Document\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f07a5dc-6d4b-4884-ab31-41ba04c1cd43", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankFrom\": 700,\n \"IDBankTo\": 4187,\n \"Value\": 1607.1592618407938,\n \"Date\": \"2007-05-14\",\n \"Description\": \"string\",\n \"Document\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc382ab3-af5a-4517-92b5-b8390b3cad55", "name": "Exclui uma transferência entre contas bancárias", "request": { "name": "Exclui uma transferência entre contas bancárias", "description": { "content": "Remove uma transferência interna criada por `POST /accounts/bank-statement/transfer`. O endpoint aceita o id de **qualquer um dos dois lados** da transferência (débito ou crédito); a partir dele, identifica o par completo (via `AccountsPayableReceivableBankStatementTransfer`), valida que ambos os lançamentos pertencem à empresa autenticada e remove **a referência da transferência e os dois lançamentos** do extrato.\n\nFalha quando o lançamento informado não é parte de uma transferência ou quando um dos lados pertence a outra empresa.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement", "transfer", ":idbankstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatement", "description": "(Required) Identificador de **um** dos dois lançamentos da transferência (débito ou crédito). O outro lado é resolvido automaticamente pelo sistema." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7bf6341e-65bb-4901-b091-227b3dc6643a", "name": "Transferência excluída. Retorna a referência removida e os dados resumidos dos dois lançamentos apagados.", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "transfer", ":idbankstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatement", "description": "(Required) Identificador de **um** dos dois lançamentos da transferência (débito ou crédito). O outro lado é resolvido automaticamente pelo sistema." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Message\": \"string\",\n \"DeletedTransfer\": {\n \"IDAccountsPayableReceivableBankStatementTransfer\": 8561,\n \"Debit\": {\n \"IDBankStatement\": 852,\n \"IDBankAccount\": 9561,\n \"Value\": 8526.0557504303,\n \"Description\": \"string\"\n },\n \"Credit\": {\n \"IDBankStatement\": 3272,\n \"IDBankAccount\": 8491,\n \"Value\": 573.3752002685577,\n \"Description\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0ee3a1d-6933-4154-ac23-b789814fabda", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Empresa não encontrada`\n- `Lançamento não é uma transferência ou não foi encontrado`\n- `Uma ou ambas as transações não pertencem a esta empresa`\n- `Falha ao excluir as transações`\n- `Falha ao excluir transferência`", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "transfer", ":idbankstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatement", "description": "(Required) Identificador de **um** dos dois lançamentos da transferência (débito ou crédito). O outro lado é resolvido automaticamente pelo sistema." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a770e9cb-74a9-4720-9c9e-b084eb9fd86a", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "transfer", ":idbankstatement" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatement", "description": "(Required) Identificador de **um** dos dois lançamentos da transferência (débito ou crédito). O outro lado é resolvido automaticamente pelo sistema." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b918e72d-3a0d-48d2-bf57-6d8ef9556cd7", "name": "Lista regras de conciliação automática", "request": { "name": "Lista regras de conciliação automática", "description": { "content": "Retorna as regras de conciliação automática cadastradas. Quando o OFX é importado, cada lançamento bancário é cruzado com essas regras para determinar se a conciliação acontece automaticamente, e contra qual tipo de movimento (título a pagar/receber ou transferência entre contas).\n\nCada regra é restrita a uma **conta bancária** e a um **tipo de transação** (débito ou crédito), e só vale para o lançamento cuja descrição é **idêntica** ao `Description` da regra — os demais campos não entram nessa escolha. O **tipo de regra** define o que acontece depois:\n\n- `1` (contas a pagar/receber) — procura um título em aberto do fornecedor (ou cliente) e do tipo de documento da regra, com vencimento na data do lançamento e o mesmo valor; se não encontra, cria o título com os dados da regra. Nos dois casos, o título é baixado na data do lançamento.\n- `2` (transferência) — requer a **conta bancária de destino** (`IDBankAccountTo`).", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement", "conciliation-rule" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDBankAccount", "value": "2232", "description": "Filtra por conta bancária." }, { "disabled": false, "key": "IDBankStatementConciliationRule", "value": "2232", "description": "Retorna apenas a regra com o identificador informado." }, { "disabled": false, "key": "Page", "value": "0", "description": "Página (5000 itens por página)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "95dfb40e-81b3-47e8-87b9-87f94a6a1e3d", "name": "Lista de regras (ou array vazio quando não há resultados).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankAccount", "value": "2232" }, { "key": "IDBankStatementConciliationRule", "value": "2232" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankStatementConciliationRule\": 8767,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 1069,\n \"Bank\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccount\": \"Crédito\",\n \"Description\": \"string\",\n \"IDTypeRule\": 1,\n \"TypeBankStatementConciliationRule\": \"Transferência\",\n \"IDTypeAccountPayableReceivable\": 1061,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 6517,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 6882,\n \"TypePaymentDescription\": \"string\",\n \"IDSupplier\": 784,\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4006,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDBankAccountTo\": 4220,\n \"BankTo\": \"string\",\n \"BankStatementConciliationRuleStatus\": 829,\n \"RecordTimestamp\": \"1975-07-04T09:27:24.633Z\"\n },\n {\n \"IDBankStatementConciliationRule\": 9156,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 2961,\n \"Bank\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccount\": \"Crédito\",\n \"Description\": \"string\",\n \"IDTypeRule\": 2,\n \"TypeBankStatementConciliationRule\": \"Transferência\",\n \"IDTypeAccountPayableReceivable\": 4558,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 2409,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 9742,\n \"TypePaymentDescription\": \"string\",\n \"IDSupplier\": 5322,\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 3094,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDBankAccountTo\": 4773,\n \"BankTo\": \"string\",\n \"BankStatementConciliationRuleStatus\": 2638,\n \"RecordTimestamp\": \"2006-11-13T10:26:33.508Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db9c76cf-9621-464e-bcdf-7484b6aa3403", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankAccount", "value": "2232" }, { "key": "IDBankStatementConciliationRule", "value": "2232" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36d2b846-601b-4e22-a285-8378902a9575", "name": "Cria uma regra de conciliação automática", "request": { "name": "Cria uma regra de conciliação automática", "description": { "content": "Cadastra uma nova regra para conciliação automática. Conforme `IDTypeRule`:\n\n- **`IDTypeRule=1` (contas a pagar/receber)** — o campo `IDBankAccountTo` é descartado. Os campos `IDTypeAccountPayableReceivable`, `IDTypeDocument`, `IDTypePayment`, `IDSupplier` e `IDConsumer` são opcionais e **não** decidem quais lançamentos a regra pega (isso depende só de `Description` e `IDTypeAccount`). `IDSupplier` (ou `IDConsumer`) e `IDTypeDocument` são usados para procurar o título em aberto; quando nenhum é encontrado, o título é criado com todos os dados da regra, incluindo `IDTypeAccountPayableReceivable` e `IDTypePayment`.\n- **`IDTypeRule=2` (transferência)** — o campo `IDBankAccountTo` é **obrigatório** e os dados de título (plano de contas, tipo documento, tipo pagamento, fornecedor, cliente) são descartados.\n\nNão é permitido repetir a mesma descrição com o mesmo tipo de transação (`Description` + `IDTypeAccount`) na conta bancária: a mesma descrição pode ter uma regra de crédito e outra de débito. `IDTypeAccount` ausente conta como crédito (`0`). A conta bancária de origem (`IDBankAccount`) e a de destino (`IDBankAccountTo`) não podem ser iguais.\n\nA resposta é a representação completa da regra recém-criada, no mesmo formato de `GET /accounts/bank-statement/conciliation-rule`.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement", "conciliation-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6da36ac4-f8ca-4878-82bf-6a82aac00237", "name": "Regra criada. Retorna o item completo (mesmo formato do `GET`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankStatementConciliationRule\": 2604,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 3730,\n \"Bank\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccount\": \"Débito\",\n \"Description\": \"string\",\n \"IDTypeRule\": 1,\n \"TypeBankStatementConciliationRule\": \"Contas pagar/receber\",\n \"IDTypeAccountPayableReceivable\": 9528,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 4275,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7321,\n \"TypePaymentDescription\": \"string\",\n \"IDSupplier\": 6307,\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 3630,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDBankAccountTo\": 6281,\n \"BankTo\": \"string\",\n \"BankStatementConciliationRuleStatus\": 3823,\n \"RecordTimestamp\": \"2004-04-15T17:32:32.687Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f751e2c8-32ec-40cb-a0a2-414d5e41ce02", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Empresa não existe`\n- `Já existe uma regra com a mesma descrição e o mesmo tipo para essa conta bancária`\n- `Conta bancária obrigatória` / `Conta bancária não existe`\n- `Conta bancária destino obrigatória em regra do tipo transferência` / `Conta bancária destino não existe` / `Conta bancária destino e origem não podem ser iguais`\n- `Tipo regra obrigatório` / `Tipo regra não existe`\n- `Plano de contas não existe` / `Tipo pagamento não existe` / `Tipo documento não existe`\n- `Fornecedor não existe` / `Cliente não existe`\n- `Erro ao criar regra`", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ee6566c-10ce-48e5-a5c7-9dbdfc583103", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9b6d3bc-bb1c-4696-b7e3-e8935fb6f81e", "name": "Atualiza uma regra de conciliação automática", "request": { "name": "Atualiza uma regra de conciliação automática", "description": { "content": "Atualiza uma regra de conciliação existente. A atualização é parcial — os campos não enviados preservam o valor atual —, mas `IDBankAccount` e `IDTypeRule` precisam ser reenviados em toda chamada: sem eles a requisição é recusada com `Conta bancária obrigatória` ou `Tipo regra obrigatório`.\n\nAs mesmas regras da criação valem: `IDTypeRule=1` (contas a pagar/receber) grava `IDBankAccountTo` como `null`; `IDTypeRule=2` (transferência) exige `IDBankAccountTo` e grava como `null` os dados de título — plano de contas, tipo de documento, tipo de pagamento, fornecedor e cliente. Por isso, trocar o `IDTypeRule` apaga os campos do tipo anterior. A regra guarda só fornecedor ou só cliente: enviar `IDSupplier` sem `IDConsumer` apaga o cliente gravado, e vice-versa. A conta bancária de origem e a de destino não podem ser iguais.\n\nA combinação descrição + tipo de transação (`Description` + `IDTypeAccount`) continua tendo de ser única dentro da mesma conta bancária; a validação ignora a própria regra que está sendo alterada e, quando `Description` ou `IDTypeAccount` não são enviados, usa o valor gravado.\n\nA resposta é a representação completa da regra atualizada, no mesmo formato de `GET /accounts/bank-statement/conciliation-rule`.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "05a21225-8ee7-4a07-a62d-9b2c7586cda7", "name": "Regra atualizada (mesmo formato do `GET`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankStatementConciliationRule\": 2604,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 3730,\n \"Bank\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccount\": \"Débito\",\n \"Description\": \"string\",\n \"IDTypeRule\": 1,\n \"TypeBankStatementConciliationRule\": \"Contas pagar/receber\",\n \"IDTypeAccountPayableReceivable\": 9528,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 4275,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7321,\n \"TypePaymentDescription\": \"string\",\n \"IDSupplier\": 6307,\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 3630,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDBankAccountTo\": 6281,\n \"BankTo\": \"string\",\n \"BankStatementConciliationRuleStatus\": 3823,\n \"RecordTimestamp\": \"2004-04-15T17:32:32.687Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2f1c7e0-1d15-4e61-857b-9d2d728a6dc6", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Regra não existe`\n- `Já existe uma regra com a mesma descrição e o mesmo tipo para essa conta bancária`\n- `Conta bancária obrigatória` / `Conta bancária não existe`\n- `Conta bancária destino obrigatória em regra do tipo transferência` / `Conta bancária destino não existe` / `Conta bancária destino e origem não podem ser iguais`\n- `Tipo regra obrigatório` / `Tipo regra não existe`\n- `Plano de contas não existe` / `Tipo pagamento não existe` / `Tipo documento não existe`\n- `Fornecedor não existe` / `Cliente não existe`\n- `Erro ao atualizar regra`", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "330d0fa1-b9be-4481-9005-0fa58f668936", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6313,\n \"IDTypeRule\": 1,\n \"IDTypeAccount\": 1,\n \"Description\": \"string\",\n \"IDTypeAccountPayableReceivable\": 1877,\n \"IDTypeDocument\": 986,\n \"IDTypePayment\": 4180,\n \"IDSupplier\": 1550,\n \"IDConsumer\": 1828,\n \"IDBankAccountTo\": 9459,\n \"BankStatementConciliationRuleStatus\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21caed2f-e6e0-4049-b1ac-f1988ca19819", "name": "Exclui uma regra de conciliação automática", "request": { "name": "Exclui uma regra de conciliação automática", "description": { "content": "Remove a regra. Falha quando a regra não pertence a uma conta bancária da empresa autenticada.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "04d8e30f-414d-486e-a130-f79790ad8e09", "name": "Exclusão bem-sucedida. O corpo é a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9539df84-c775-4343-aa35-eefc7fd2b61f", "name": "Validação falhou (prefixo `[BadRequest]`). Mensagem: `Regra não existe`.", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "618dad3b-f1b9-4dc3-a17e-e937710acff3", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-statement", "conciliation-rule", ":idbankstatementconciliationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankstatementconciliationrule", "description": "(Required) Identificador da regra de conciliação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "78fc6e8c-4d56-4c07-aca3-1a0b348de454", "name": "Contas Bancárias", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2365fd52-0de7-4f4b-932a-92d1a8260154", "name": "Lista contas bancárias da empresa", "request": { "name": "Lista contas bancárias da empresa", "description": { "content": "Retorna as contas bancárias ativas da empresa. Cada item traz o saldo atual e o saldo previsto até uma data futura. Aceita filtros opcionais por faturador e número do banco.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-account" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "DateForecast", "value": "1980-02-08", "description": "Data limite (inclusive) para o cálculo de `BalanceForecast`. Default: data atual (não calcula saldo futuro além de hoje)." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra apenas contas cujo faturador corresponde a este id de empresa." }, { "disabled": false, "key": "BankNumber", "value": "str", "description": "Filtra pelo código Febraban do banco. Aceita string de até 3 caracteres." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "dcc43324-2cee-40d5-a13d-cfbdf6ae4659", "name": "Lista de contas bancárias (vazia se não houver match).", "originalRequest": { "url": { "path": [ "accounts", "bank-account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DateForecast", "value": "1980-02-08" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "BankNumber", "value": "str" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankAccount\": 8729,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 4933,\n \"MainPayment\": 9661,\n \"IDCompany\": 374,\n \"RecordTimestamp\": \"1961-10-16T14:21:19.883Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 4726,\n \"IDCompanyInvoice\": 6653,\n \"IDCompanyIntegration\": 1389,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 194,\n \"IDCompanyIntegrationPix\": 470,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 510.85453581591224,\n \"BalanceForecast\": 6995.808472037935,\n \"CompanyIntegrationPix\": \"string\"\n },\n {\n \"IDBankAccount\": 6752,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 8652,\n \"MainPayment\": 7109,\n \"IDCompany\": 9843,\n \"RecordTimestamp\": \"1985-12-22T13:02:46.943Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 6350,\n \"IDCompanyInvoice\": 3193,\n \"IDCompanyIntegration\": 1070,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 3576,\n \"IDCompanyIntegrationPix\": 6521,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 9282.438004086891,\n \"BalanceForecast\": 1059.284571914323,\n \"CompanyIntegrationPix\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42efafe0-0dc5-4bc0-ad3a-f3b6acaeb673", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-account" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DateForecast", "value": "1980-02-08" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "BankNumber", "value": "str" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83056cc8-8ccf-4614-b2b3-22bc32f0b286", "name": "Cadastra uma conta bancária", "request": { "name": "Cadastra uma conta bancária", "description": { "content": "Cria uma conta bancária para a empresa. Marcar a conta como principal de recebimento com `MainIncome=1` desmarca, no mesmo faturador, tanto a conta principal de recebimento quanto a de pagamento anteriores. O faturador, as integrações bancária e de Pix e o tipo de pedido, quando informados, são validados contra os cadastros da empresa. A resposta é a lista atualizada de contas bancárias, no mesmo formato do `GET /accounts/bank-account`.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 0,\n \"IDCompanyInvoice\": 2864,\n \"IDCompanyIntegration\": 6127,\n \"IDCompanyIntegrationPix\": 998,\n \"IDTypeOrder\": 6287,\n \"TefTerminal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e0483aa7-84d5-49c1-9442-fb0b65b45546", "name": "Conta criada. Retorna a lista atualizada de contas bancárias.", "originalRequest": { "url": { "path": [ "accounts", "bank-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 0,\n \"IDCompanyInvoice\": 2864,\n \"IDCompanyIntegration\": 6127,\n \"IDCompanyIntegrationPix\": 998,\n \"IDTypeOrder\": 6287,\n \"TefTerminal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankAccount\": 8729,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 4933,\n \"MainPayment\": 9661,\n \"IDCompany\": 374,\n \"RecordTimestamp\": \"1961-10-16T14:21:19.883Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 4726,\n \"IDCompanyInvoice\": 6653,\n \"IDCompanyIntegration\": 1389,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 194,\n \"IDCompanyIntegrationPix\": 470,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 510.85453581591224,\n \"BalanceForecast\": 6995.808472037935,\n \"CompanyIntegrationPix\": \"string\"\n },\n {\n \"IDBankAccount\": 6752,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 8652,\n \"MainPayment\": 7109,\n \"IDCompany\": 9843,\n \"RecordTimestamp\": \"1985-12-22T13:02:46.943Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 6350,\n \"IDCompanyInvoice\": 3193,\n \"IDCompanyIntegration\": 1070,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 3576,\n \"IDCompanyIntegrationPix\": 6521,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 9282.438004086891,\n \"BalanceForecast\": 1059.284571914323,\n \"CompanyIntegrationPix\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb0d5d5b-2d6d-4ee4-b22f-3e87ef901018", "name": "Validação falhou (prefixo `[BadRequest]`). Mensagens possíveis: `Empresa não existe`, `Faturador não existe`, `Integração não existe`, `Integração Pix não existe`, `Tipo pedido não existe`, `Tipo pedido não está habilitado para frente de caixa`, `Tipo pedido não está habilitado para esta empresa/faturador, ajustar no cadastro`.", "originalRequest": { "url": { "path": [ "accounts", "bank-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 0,\n \"IDCompanyInvoice\": 2864,\n \"IDCompanyIntegration\": 6127,\n \"IDCompanyIntegrationPix\": 998,\n \"IDTypeOrder\": 6287,\n \"TefTerminal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b62e83b2-32c6-4148-a67f-f4cbce4c1fe6", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 0,\n \"IDCompanyInvoice\": 2864,\n \"IDCompanyIntegration\": 6127,\n \"IDCompanyIntegrationPix\": 998,\n \"IDTypeOrder\": 6287,\n \"TefTerminal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "308548a8-35c2-4f04-92f8-54cc585ebcf5", "name": "Atualiza uma conta bancária", "request": { "name": "Atualiza uma conta bancária", "description": { "content": "Atualiza a conta bancária. A operação tem dois modos, decididos pelo corpo da requisição.\n\n- **Atualização de cadastro** (modo padrão): altera os dados da conta. Vale a mesma regra do cadastro — marcar a conta como principal de recebimento com `MainIncome=1` desmarca, no mesmo faturador, tanto a conta principal de recebimento quanto a de pagamento anteriores. Trocar o código do banco quando a conta atual é interna (`000`) e existe caixa do PDV aberto vinculado a ela é bloqueado. Atenção: neste modo, os campos `IDCompanyInvoice`, `IDCompanyIntegration`, `IDCompanyIntegrationPix`, `IDTypeOrder` e `TefTerminal` são sempre regravados — omitir qualquer um deles apaga o valor atual, então reenvie os que quiser preservar.\n- **Ajuste de saldo inicial**: quando `InitialBalance` e `InitialBalanceDate` são enviados, o endpoint compara o saldo desejado com o saldo da conta até o dia anterior à data informada e lança a diferença como entrada ou saída no extrato, datada do dia anterior às 23:59:59, com a descrição `Ajuste de saldo inicial para ` e o documento `AJUSTE`. O ajuste é registrado no histórico da conta. Quando a diferença é zero, nada é lançado e a requisição é recusada. Neste modo os campos de cadastro são ignorados.\n\nA resposta é a lista atualizada de contas bancárias.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 1,\n \"IDCompanyInvoice\": 2838,\n \"IDCompanyIntegration\": 6017,\n \"IDCompanyIntegrationPix\": 1833,\n \"IDTypeOrder\": 7851,\n \"TefTerminal\": \"string\",\n \"InitialBalance\": 3981.0512676303665,\n \"InitialBalanceDate\": \"2012-08-06\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d3930f26-f742-40c0-b863-ef5c134ac047", "name": "Conta atualizada. Retorna a lista atualizada de contas bancárias.", "originalRequest": { "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 1,\n \"IDCompanyInvoice\": 2838,\n \"IDCompanyIntegration\": 6017,\n \"IDCompanyIntegrationPix\": 1833,\n \"IDTypeOrder\": 7851,\n \"TefTerminal\": \"string\",\n \"InitialBalance\": 3981.0512676303665,\n \"InitialBalanceDate\": \"2012-08-06\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankAccount\": 8729,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 4933,\n \"MainPayment\": 9661,\n \"IDCompany\": 374,\n \"RecordTimestamp\": \"1961-10-16T14:21:19.883Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 4726,\n \"IDCompanyInvoice\": 6653,\n \"IDCompanyIntegration\": 1389,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 194,\n \"IDCompanyIntegrationPix\": 470,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 510.85453581591224,\n \"BalanceForecast\": 6995.808472037935,\n \"CompanyIntegrationPix\": \"string\"\n },\n {\n \"IDBankAccount\": 6752,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 8652,\n \"MainPayment\": 7109,\n \"IDCompany\": 9843,\n \"RecordTimestamp\": \"1985-12-22T13:02:46.943Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 6350,\n \"IDCompanyInvoice\": 3193,\n \"IDCompanyIntegration\": 1070,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 3576,\n \"IDCompanyIntegrationPix\": 6521,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 9282.438004086891,\n \"BalanceForecast\": 1059.284571914323,\n \"CompanyIntegrationPix\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11117154-92ca-4335-9a41-4376b531a879", "name": "Validação falhou (prefixo `[BadRequest]`). Possíveis mensagens: `Empresa não existe` (emitida também quando a conta bancária informada no caminho não pertence à empresa autenticada), `Faturador não existe`, `Integração não existe`, `Integração Pix não existe`, `Tipo pedido não existe`, `Tipo pedido não está habilitado para frente de caixa`, `Tipo pedido não está habilitado para esta empresa/faturador, ajustar no cadastro`, `Conta possui caixa aberto e não pode ser editado`, `Nenhum ajuste aplicado` (quando o ajuste de saldo resulta em diferença zero).", "originalRequest": { "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 1,\n \"IDCompanyInvoice\": 2838,\n \"IDCompanyIntegration\": 6017,\n \"IDCompanyIntegrationPix\": 1833,\n \"IDTypeOrder\": 7851,\n \"TefTerminal\": \"string\",\n \"InitialBalance\": 3981.0512676303665,\n \"InitialBalanceDate\": \"2012-08-06\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e388a902-da5f-4ce2-98e9-81ec73ca6374", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"AccountNumberDigit\": \"s\",\n \"MainIncome\": 0,\n \"MainPayment\": 1,\n \"IDCompanyInvoice\": 2838,\n \"IDCompanyIntegration\": 6017,\n \"IDCompanyIntegrationPix\": 1833,\n \"IDTypeOrder\": 7851,\n \"TefTerminal\": \"string\",\n \"InitialBalance\": 3981.0512676303665,\n \"InitialBalanceDate\": \"2012-08-06\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7aacd649-f555-47b6-b298-470a901e72d9", "name": "Exclui (inativa) uma conta bancária", "request": { "name": "Exclui (inativa) uma conta bancária", "description": { "content": "Inativa a conta bancária (`Status = 0`). Não exclui fisicamente o registro.\n\n**Regras impeditivas**:\n- A conta não pode ter lançamentos de pagamento ou recebimento.\n- A conta não pode estar vinculada como conta prevista em algum título a pagar ou receber.\n- A conta não pode ter sido usada em abertura de caixa do PDV.\n\nA resposta é a lista atualizada de contas bancárias.", "type": "text/plain" }, "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "65a8bfa5-16e0-41a6-9104-e54dbfd62394", "name": "Conta inativada. Retorna a lista atualizada de contas bancárias — como a lista traz apenas contas ativas, a conta inativada não aparece no resultado.", "originalRequest": { "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankAccount\": 8729,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 4933,\n \"MainPayment\": 9661,\n \"IDCompany\": 374,\n \"RecordTimestamp\": \"1961-10-16T14:21:19.883Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 4726,\n \"IDCompanyInvoice\": 6653,\n \"IDCompanyIntegration\": 1389,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 194,\n \"IDCompanyIntegrationPix\": 470,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 510.85453581591224,\n \"BalanceForecast\": 6995.808472037935,\n \"CompanyIntegrationPix\": \"string\"\n },\n {\n \"IDBankAccount\": 6752,\n \"Bank\": \"string\",\n \"BankNumber\": \"str\",\n \"BankRouting\": \"string\",\n \"AccountNumber\": \"string\",\n \"MainIncome\": 8652,\n \"MainPayment\": 7109,\n \"IDCompany\": 9843,\n \"RecordTimestamp\": \"1985-12-22T13:02:46.943Z\",\n \"AccountNumberDigit\": \"s\",\n \"Status\": 6350,\n \"IDCompanyInvoice\": 3193,\n \"IDCompanyIntegration\": 1070,\n \"TefTerminal\": \"string\",\n \"IDTypeOrder\": 3576,\n \"IDCompanyIntegrationPix\": 6521,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"TypeOrder\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Balance\": 9282.438004086891,\n \"BalanceForecast\": 1059.284571914323,\n \"CompanyIntegrationPix\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2a16660-3667-4331-95c2-7afb328dd33b", "name": "Regras impeditivas (prefixo `[BadRequest]`): `Conta bancária não existe`, `Conta bancária já possui pagamento / recebimento e não pode ser excluída`, `Contas a pagar/receber esta com esta conta bancária e não pode ser excluída`, `Conta bancária já foi utilizada em abertura de caixa (PDV) e não pode ser excluída`.", "originalRequest": { "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dace7f91-04de-40f4-a9ba-42753c292ba1", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "bank-account", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Identificador da conta bancária." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "132ff6b1-6d9f-48ab-bfa0-938e5f4a4fcf", "name": "Contas a Pagar", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "59b87fa8-3297-4976-a7b7-c9201833dbf8", "name": "Lista contas a pagar", "request": { "name": "Lista contas a pagar", "description": { "content": "Retorna as contas a pagar da empresa, com totais já calculados — valor total `ValueTotal`, valor pago `ValuePaid`, saldo devedor `ValuePaymentPending`. Aceita filtros por data (vencimento, documento, competência, último pagamento, registro), valor, status, fornecedor, cliente, tipo de documento, tipo de pagamento, plano de contas, centro de custo, conta bancária, pedido associado e mais. Paginação por `Page` (5000 itens por página).\n\nQuando a parametrização **Permitir visualizar registros apenas fornecedores vinculados ao usuário** da empresa está ativa, os resultados são restritos às categorias de fornecedor vinculadas ao usuário autenticado.\n\nUse `IDTypeEntity=1` para trazer apenas títulos com cliente e `IDTypeEntity=2` para apenas títulos com fornecedor.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "0", "description": "Página (cada página tem 5000 itens)." }, { "disabled": false, "key": "IDAccountPayableReceivable", "value": "string", "description": "Filtra por um ou mais ids (lista separada por vírgula). Útil para retornar lotes recém-criados." }, { "disabled": false, "key": "IDStatusAccountPayableReceivable", "value": "0,1,2,3,5", "description": "Filtro de status (lista separada por vírgula). Valores: 0=Aberto, 1=Vencido, 2=Pago, 3=Pago Parcialmente, 4=Não lançado, 5=Pago com acréscimo, 6=Vence hoje. Default `0,1,2,3,5` (não traz Pago, Não lançado nem Vence hoje)." }, { "disabled": false, "key": "IDSupplier", "value": "2232", "description": "Filtra por fornecedor." }, { "disabled": false, "key": "IDConsumer", "value": "2232", "description": "Filtra por cliente." }, { "disabled": false, "key": "IDTypeEntity", "value": "1", "description": "Restringe ao tipo: `1` apenas com cliente, `2` apenas com fornecedor." }, { "disabled": false, "key": "DocumentNumber", "value": "string", "description": "Filtra pelo número do documento." }, { "disabled": false, "key": "IDTypeAccountPayableReceivable", "value": "2232", "description": "Filtra por plano de contas." }, { "disabled": false, "key": "IDTypePayment", "value": "2232", "description": "Filtra por tipo de pagamento." }, { "disabled": false, "key": "IDTypeDocument", "value": "2232", "description": "Filtra por tipo de documento." }, { "disabled": false, "key": "Scheduled", "value": "1", "description": "Apenas títulos agendados (`1`) ou não (`0`)." }, { "disabled": false, "key": "Forecast", "value": "1", "description": "Apenas previsões (`1`) ou apenas reais (`0`)." }, { "disabled": false, "key": "IDOrder", "value": "2232", "description": "Filtra por pedido associado." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra por empresa faturadora." }, { "disabled": false, "key": "IDBankAccountForecast", "value": "2232", "description": "Filtra pela conta bancária prevista para pagamento." }, { "disabled": false, "key": "IDBankAccount", "value": "2232", "description": "Filtra pela conta bancária do pagamento já lançado." }, { "disabled": false, "key": "ValueFrom", "value": "478.75460817372374", "description": "Valor mínimo." }, { "disabled": false, "key": "ValueTo", "value": "478.75460817372374", "description": "Valor máximo." }, { "disabled": false, "key": "DateDueFrom", "value": "1980-02-08", "description": "Vencimento a partir de." }, { "disabled": false, "key": "DateDueTo", "value": "1980-02-08", "description": "Vencimento até." }, { "disabled": false, "key": "DateDocumentFrom", "value": "1980-02-08", "description": "Data do documento a partir de." }, { "disabled": false, "key": "DateDocumentTo", "value": "1980-02-08", "description": "Data do documento até." }, { "disabled": false, "key": "DateCompetenceFrom", "value": "1980-02-08", "description": "Competência a partir de." }, { "disabled": false, "key": "DateCompetenceTo", "value": "1980-02-08", "description": "Competência até." }, { "disabled": false, "key": "DateLastPaymentFrom", "value": "1980-02-08", "description": "Último pagamento a partir de." }, { "disabled": false, "key": "DateLastPaymentTo", "value": "1980-02-08", "description": "Último pagamento até (inclusivo até 23:59)." }, { "disabled": false, "key": "DateRecordTimestampFrom", "value": "1980-02-08", "description": "Data de criação do registro a partir de." }, { "disabled": false, "key": "DateRecordTimestampTo", "value": "1980-02-08", "description": "Data de criação do registro até (inclusivo até 23:59)." }, { "disabled": false, "key": "IDTypeCostCenter", "value": "2232", "description": "Filtra por centro de custo. Traz apenas os títulos vinculados ao centro de custo informado." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5af9d5de-82ac-48ca-87bf-c307450933f6", "name": "Lista de contas a pagar com totais calculados (vazia quando o usuário não tem acesso pela parametrização de governança).", "originalRequest": { "url": { "path": [ "accounts", "payable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "IDAccountPayableReceivable", "value": "string" }, { "key": "IDStatusAccountPayableReceivable", "value": "0,1,2,3,5" }, { "key": "IDSupplier", "value": "2232" }, { "key": "IDConsumer", "value": "2232" }, { "key": "IDTypeEntity", "value": "1" }, { "key": "DocumentNumber", "value": "string" }, { "key": "IDTypeAccountPayableReceivable", "value": "2232" }, { "key": "IDTypePayment", "value": "2232" }, { "key": "IDTypeDocument", "value": "2232" }, { "key": "Scheduled", "value": "1" }, { "key": "Forecast", "value": "1" }, { "key": "IDOrder", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "IDBankAccountForecast", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "ValueFrom", "value": "478.75460817372374" }, { "key": "ValueTo", "value": "478.75460817372374" }, { "key": "DateDueFrom", "value": "1980-02-08" }, { "key": "DateDueTo", "value": "1980-02-08" }, { "key": "DateDocumentFrom", "value": "1980-02-08" }, { "key": "DateDocumentTo", "value": "1980-02-08" }, { "key": "DateCompetenceFrom", "value": "1980-02-08" }, { "key": "DateCompetenceTo", "value": "1980-02-08" }, { "key": "DateLastPaymentFrom", "value": "1980-02-08" }, { "key": "DateLastPaymentTo", "value": "1980-02-08" }, { "key": "DateRecordTimestampFrom", "value": "1980-02-08" }, { "key": "DateRecordTimestampTo", "value": "1980-02-08" }, { "key": "IDTypeCostCenter", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 5322,\n \"IDAccountPayableReceivableMain\": 5038,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2000-07-09\",\n \"DateDocument\": \"2019-06-16\",\n \"DateDue\": \"1963-11-03\",\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2016-06-20T21:39:04.864Z\",\n \"IDSupplier\": 3916,\n \"IDConsumer\": 4653,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 3314,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 5906,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7727,\n \"TypePaymentDescription\": \"string\",\n \"IDPurchase\": 5825,\n \"IDStatusPurchase\": 5668,\n \"IDOrder\": 1795,\n \"Scheduled\": 275,\n \"Forecast\": 2002,\n \"BankSlipBarCode\": \"string\",\n \"IDBankAccountForecast\": 7523,\n \"BankForecast\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"BankPayment\": \"string\",\n \"DateLastPayment\": \"2017-03-03T12:36:34.435Z\",\n \"Value\": 9499.171777202451,\n \"ValueDiscount\": 7377.932493982194,\n \"ValueInterest\": 8721.97472098919,\n \"ValuePenalty\": 9790.904201322932,\n \"ValueTotal\": 3692.2008045704824,\n \"ValuePaid\": 7950.573414664399,\n \"ValuePaymentPending\": 9780.566184853842,\n \"TotalvNF\": 9148.120421258041,\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 1,\n \"DocumentPayment\": 0,\n \"IDCompanyInvoice\": 1017,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"AccountsPayableReceivableCostCenter\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 1069,\n \"IDAccountPayableReceivableMain\": 3982,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2020-04-03\",\n \"DateDocument\": \"2000-06-14\",\n \"DateDue\": \"1961-06-09\",\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"1991-08-19T01:40:56.302Z\",\n \"IDSupplier\": 173,\n \"IDConsumer\": 7973,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 190,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 2022,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7934,\n \"TypePaymentDescription\": \"string\",\n \"IDPurchase\": 1976,\n \"IDStatusPurchase\": 348,\n \"IDOrder\": 6639,\n \"Scheduled\": 2662,\n \"Forecast\": 2890,\n \"BankSlipBarCode\": \"string\",\n \"IDBankAccountForecast\": 2972,\n \"BankForecast\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"BankPayment\": \"string\",\n \"DateLastPayment\": \"1978-11-22T03:52:00.535Z\",\n \"Value\": 9532.511070344663,\n \"ValueDiscount\": 8940.614436190685,\n \"ValueInterest\": 2828.2645858835463,\n \"ValuePenalty\": 7419.720800616307,\n \"ValueTotal\": 3819.717157849927,\n \"ValuePaid\": 2166.421613298084,\n \"ValuePaymentPending\": 3487.4661994435983,\n \"TotalvNF\": 415.8886251298588,\n \"DocumentPdf\": 0,\n \"DocumentXml\": 1,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 0,\n \"IDCompanyInvoice\": 6021,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"AccountsPayableReceivableCostCenter\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48a93bcb-ba43-4d27-ba0f-ced767a4032e", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "payable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "IDAccountPayableReceivable", "value": "string" }, { "key": "IDStatusAccountPayableReceivable", "value": "0,1,2,3,5" }, { "key": "IDSupplier", "value": "2232" }, { "key": "IDConsumer", "value": "2232" }, { "key": "IDTypeEntity", "value": "1" }, { "key": "DocumentNumber", "value": "string" }, { "key": "IDTypeAccountPayableReceivable", "value": "2232" }, { "key": "IDTypePayment", "value": "2232" }, { "key": "IDTypeDocument", "value": "2232" }, { "key": "Scheduled", "value": "1" }, { "key": "Forecast", "value": "1" }, { "key": "IDOrder", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "IDBankAccountForecast", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "ValueFrom", "value": "478.75460817372374" }, { "key": "ValueTo", "value": "478.75460817372374" }, { "key": "DateDueFrom", "value": "1980-02-08" }, { "key": "DateDueTo", "value": "1980-02-08" }, { "key": "DateDocumentFrom", "value": "1980-02-08" }, { "key": "DateDocumentTo", "value": "1980-02-08" }, { "key": "DateCompetenceFrom", "value": "1980-02-08" }, { "key": "DateCompetenceTo", "value": "1980-02-08" }, { "key": "DateLastPaymentFrom", "value": "1980-02-08" }, { "key": "DateLastPaymentTo", "value": "1980-02-08" }, { "key": "DateRecordTimestampFrom", "value": "1980-02-08" }, { "key": "DateRecordTimestampTo", "value": "1980-02-08" }, { "key": "IDTypeCostCenter", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0936ea72-be5f-41e4-a78d-6076a57f01ec", "name": "Cria contas a pagar (com suporte a recorrência e retenção de impostos)", "request": { "name": "Cria contas a pagar (com suporte a recorrência e retenção de impostos)", "description": { "content": "Cria uma ou mais contas a pagar. Suporta recorrência mensal, semanal ou personalizada, tratamento de feriado e fim de semana, retenção de impostos (que gera contas filhas e abate o valor da conta principal) e replicação automática dos centros de custo do fornecedor. A criação é registrada no histórico para auditoria. A resposta traz as contas recém-criadas no mesmo formato da listagem.\n\n**Regras de negócio**:\n- `IDConsumer` e `IDSupplier` não podem ser enviados juntos.\n- Quando `IDBankAccountForecast` é omitido e a empresa tem **exatamente uma** conta bancária cadastrada, ela é usada automaticamente.\n- Para recorrência mensal, `PeriodTypeValue` deve estar entre 1 e 31 (dia do mês).\n- Para recorrência semanal, `PeriodTypeValue` deve estar entre 0 e 6 (dia da semana).", "type": "text/plain" }, "url": { "path": [ "accounts", "payable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"2016-05-18\",\n \"Value\": 6398.868597413317,\n \"IDTypeDocument\": 5209,\n \"IDTypeAccountPayableReceivable\": 96,\n \"Comments\": \"string\",\n \"DateCompetence\": \"2017-06-30\",\n \"DateDocument\": \"1975-08-06\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 3861,\n \"IDConsumer\": 7317,\n \"IDTypePayment\": 5157,\n \"Scheduled\": 9917,\n \"IDBankAccountForecast\": 6896,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 8838.50416299525,\n \"ValueInterest\": 7187.621813802661,\n \"ValuePenalty\": 5568.673111712077,\n \"IDCompanyInvoice\": 3303,\n \"Forecast\": 8332,\n \"IDOrder\": 3262,\n \"Taxes\": [\n {\n \"IDSupplier\": 4739,\n \"Value\": 3508.5474926096595,\n \"DateDue\": \"2005-05-18\"\n },\n {\n \"IDSupplier\": 4239,\n \"Value\": 5286.891658749561,\n \"DateDue\": \"1961-12-26\"\n }\n ],\n \"Holiday\": 2,\n \"PeriodType\": 1,\n \"QuantityRepeat\": 1808,\n \"PeriodTypeValue\": 1490,\n \"IDGnre\": 303\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "56bcff08-7898-43ad-aa61-2d076a5c03b4", "name": "Conta(s) criada(s). Retorna a lista das contas recém-criadas.", "originalRequest": { "url": { "path": [ "accounts", "payable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"1995-12-17\",\n \"Value\": 6252.05607892807,\n \"IDTypeDocument\": 2820,\n \"IDTypeAccountPayableReceivable\": 3260,\n \"Comments\": \"string\",\n \"DateCompetence\": \"1962-01-01\",\n \"DateDocument\": \"1984-12-30\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 6621,\n \"IDConsumer\": 1843,\n \"IDTypePayment\": 8805,\n \"Scheduled\": 5440,\n \"IDBankAccountForecast\": 3019,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 5958.896623942535,\n \"ValueInterest\": 5852.904491223092,\n \"ValuePenalty\": 9922.043302752403,\n \"IDCompanyInvoice\": 8449,\n \"Forecast\": 6522,\n \"IDOrder\": 674,\n \"Taxes\": [\n {\n \"IDSupplier\": 2682,\n \"Value\": 4101.7903751834965,\n \"DateDue\": \"1963-12-01\"\n },\n {\n \"IDSupplier\": 3816,\n \"Value\": 21.96739786426205,\n \"DateDue\": \"1996-05-05\"\n }\n ],\n \"Holiday\": 2,\n \"PeriodType\": 3,\n \"QuantityRepeat\": 9539,\n \"PeriodTypeValue\": 7242,\n \"IDGnre\": 3797\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 5322,\n \"IDAccountPayableReceivableMain\": 5038,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2000-07-09\",\n \"DateDocument\": \"2019-06-16\",\n \"DateDue\": \"1963-11-03\",\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2016-06-20T21:39:04.864Z\",\n \"IDSupplier\": 3916,\n \"IDConsumer\": 4653,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 3314,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 5906,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7727,\n \"TypePaymentDescription\": \"string\",\n \"IDPurchase\": 5825,\n \"IDStatusPurchase\": 5668,\n \"IDOrder\": 1795,\n \"Scheduled\": 275,\n \"Forecast\": 2002,\n \"BankSlipBarCode\": \"string\",\n \"IDBankAccountForecast\": 7523,\n \"BankForecast\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"BankPayment\": \"string\",\n \"DateLastPayment\": \"2017-03-03T12:36:34.435Z\",\n \"Value\": 9499.171777202451,\n \"ValueDiscount\": 7377.932493982194,\n \"ValueInterest\": 8721.97472098919,\n \"ValuePenalty\": 9790.904201322932,\n \"ValueTotal\": 3692.2008045704824,\n \"ValuePaid\": 7950.573414664399,\n \"ValuePaymentPending\": 9780.566184853842,\n \"TotalvNF\": 9148.120421258041,\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 1,\n \"DocumentPayment\": 0,\n \"IDCompanyInvoice\": 1017,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"AccountsPayableReceivableCostCenter\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 1069,\n \"IDAccountPayableReceivableMain\": 3982,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2020-04-03\",\n \"DateDocument\": \"2000-06-14\",\n \"DateDue\": \"1961-06-09\",\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"1991-08-19T01:40:56.302Z\",\n \"IDSupplier\": 173,\n \"IDConsumer\": 7973,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 190,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 2022,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7934,\n \"TypePaymentDescription\": \"string\",\n \"IDPurchase\": 1976,\n \"IDStatusPurchase\": 348,\n \"IDOrder\": 6639,\n \"Scheduled\": 2662,\n \"Forecast\": 2890,\n \"BankSlipBarCode\": \"string\",\n \"IDBankAccountForecast\": 2972,\n \"BankForecast\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"BankPayment\": \"string\",\n \"DateLastPayment\": \"1978-11-22T03:52:00.535Z\",\n \"Value\": 9532.511070344663,\n \"ValueDiscount\": 8940.614436190685,\n \"ValueInterest\": 2828.2645858835463,\n \"ValuePenalty\": 7419.720800616307,\n \"ValueTotal\": 3819.717157849927,\n \"ValuePaid\": 2166.421613298084,\n \"ValuePaymentPending\": 3487.4661994435983,\n \"TotalvNF\": 415.8886251298588,\n \"DocumentPdf\": 0,\n \"DocumentXml\": 1,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 0,\n \"IDCompanyInvoice\": 6021,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"AccountsPayableReceivableCostCenter\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7116b0-84d2-4620-9b0c-d81572814b71", "name": "Validação falhou (prefixo `[BadRequest]`). Possíveis mensagens:\n- `Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)`\n- `Fornecedor não existe` / `Cliente não existe`\n- `Faturador não existe` / `Empresa não existe`\n- `Type Payment não existe` / `Tipo documento não existe` / `Plano de contas não existe`\n- `Pedido não existe` / `Conta bancária não existe`\n- `GNRE não existe` / `GNRE já possui título de contas a pagar`\n- `Fornecedor retenção é obrigatório` / `Valor retenção é obrigatório` / `Data vencimento retenção é obrigatória`\n- `Valor retenção superior ao valor do título`\n- `Fornecedores(s) retenção imposto não localizado(s): ...`\n- `Dia do mês precisa ser entre 1 e 31` / `Dia do semana precisa ser entre 0 e 6` / `Precisa enviar o intervalo` / `Precisa enviar o tipo de frequencia`", "originalRequest": { "url": { "path": [ "accounts", "payable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"1995-12-17\",\n \"Value\": 6252.05607892807,\n \"IDTypeDocument\": 2820,\n \"IDTypeAccountPayableReceivable\": 3260,\n \"Comments\": \"string\",\n \"DateCompetence\": \"1962-01-01\",\n \"DateDocument\": \"1984-12-30\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 6621,\n \"IDConsumer\": 1843,\n \"IDTypePayment\": 8805,\n \"Scheduled\": 5440,\n \"IDBankAccountForecast\": 3019,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 5958.896623942535,\n \"ValueInterest\": 5852.904491223092,\n \"ValuePenalty\": 9922.043302752403,\n \"IDCompanyInvoice\": 8449,\n \"Forecast\": 6522,\n \"IDOrder\": 674,\n \"Taxes\": [\n {\n \"IDSupplier\": 2682,\n \"Value\": 4101.7903751834965,\n \"DateDue\": \"1963-12-01\"\n },\n {\n \"IDSupplier\": 3816,\n \"Value\": 21.96739786426205,\n \"DateDue\": \"1996-05-05\"\n }\n ],\n \"Holiday\": 2,\n \"PeriodType\": 3,\n \"QuantityRepeat\": 9539,\n \"PeriodTypeValue\": 7242,\n \"IDGnre\": 3797\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ac6e6bd-8e3b-4b68-bb9a-ae17041a2079", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "payable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"1995-12-17\",\n \"Value\": 6252.05607892807,\n \"IDTypeDocument\": 2820,\n \"IDTypeAccountPayableReceivable\": 3260,\n \"Comments\": \"string\",\n \"DateCompetence\": \"1962-01-01\",\n \"DateDocument\": \"1984-12-30\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 6621,\n \"IDConsumer\": 1843,\n \"IDTypePayment\": 8805,\n \"Scheduled\": 5440,\n \"IDBankAccountForecast\": 3019,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 5958.896623942535,\n \"ValueInterest\": 5852.904491223092,\n \"ValuePenalty\": 9922.043302752403,\n \"IDCompanyInvoice\": 8449,\n \"Forecast\": 6522,\n \"IDOrder\": 674,\n \"Taxes\": [\n {\n \"IDSupplier\": 2682,\n \"Value\": 4101.7903751834965,\n \"DateDue\": \"1963-12-01\"\n },\n {\n \"IDSupplier\": 3816,\n \"Value\": 21.96739786426205,\n \"DateDue\": \"1996-05-05\"\n }\n ],\n \"Holiday\": 2,\n \"PeriodType\": 3,\n \"QuantityRepeat\": 9539,\n \"PeriodTypeValue\": 7242,\n \"IDGnre\": 3797\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b550fe1d-fe8c-4286-8e2e-14a6c7eb288d", "name": "Detalha uma conta a pagar", "request": { "name": "Detalha uma conta a pagar", "description": { "content": "Retorna a conta a pagar completa: dados próprios, status, fornecedor ou cliente, tipo de documento, tipo de pagamento, plano de contas, total da nota fiscal de origem, indicações de quais tipos de arquivo estão anexados, lista de pagamentos e arquivos, GNREs, histórico de alterações, centros de custo rateados e as contas filhas geradas por retenção de impostos.\n\nAtenção: quando o id não existe ou a conta pertence a outra empresa, a resposta é `200` com `[]` (array vazio) — este endpoint não retorna erro para \"não encontrado\".", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e58ec31a-6c3b-40fc-ac0a-a7801ab1263c", "name": "Conta encontrada (objeto único em array) ou array vazio quando não encontrada.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1953-11-15\",\n \"DateDocument\": \"2024-03-04\",\n \"DateDue\": \"1987-12-31\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 2185,\n \"IDStatusAccountPayableReceivable\": 2,\n \"IDSupplier\": 3225,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 5671,\n \"IDTypeDocument\": 1630,\n \"IDTypePayment\": 7620,\n \"RecordTimestamp\": \"2025-06-29T12:26:58.918Z\",\n \"Scheduled\": 3171,\n \"Value\": 5381.605814628842,\n \"IDBankAccountForecast\": 8537,\n \"IDOrder\": 423,\n \"IDCompanyInvoice\": 8201,\n \"IDAccountPayableReceivableMain\": 9236,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 5748,\n \"ValueDiscount\": 4845.159827236052,\n \"ValueInterest\": 432.7493953352479,\n \"ValuePenalty\": 6075.139646204972,\n \"ValueTotal\": 7065.088558092867,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6615,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 1,\n \"DocumentBankSlip\": 1,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 9284.493197752721,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"2026-09-01T05:27:38.285Z\",\n \"IDFile\": 674,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7678,\n \"IDAccountPayableReceivable\": 4015\n },\n {\n \"RecordTimestamp\": \"2015-08-02T14:48:32.161Z\",\n \"IDFile\": 3781,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6683,\n \"IDAccountPayableReceivable\": 2985\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"2021-12-15T07:45:09.937Z\",\n \"IDBankAccount\": 7180,\n \"IDBankStatement\": 7118,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2255.179573309616,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2013-09-23T18:45:56.156Z\",\n \"IDBankAccount\": 3120,\n \"IDBankStatement\": 9721,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 6011.887967289553,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2018-11-15T15:47:29.898Z\",\n \"IDAccountsPayableReceivableLog\": 7948,\n \"RecordUserCreated\": 5832,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2022-05-04T15:48:43.642Z\",\n \"IDAccountsPayableReceivableLog\": 7006,\n \"RecordUserCreated\": 514,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 4698,\n \"ValueRatio\": 7558.447601271035,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 3619.7584844734674\n },\n {\n \"IDTypeCostCenter\": 1766,\n \"ValueRatio\": 3441.495227676179,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 7750.664395715383\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5808,\n \"DateDue\": \"1984-12-19\",\n \"DateDocument\": \"2017-07-24\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4315,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 326,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 2768.823295481102,\n \"ValueDiscount\": 6453.461774468538,\n \"ValueInterest\": 5918.011574632611,\n \"ValuePenalty\": 721.2297449003823,\n \"ValueTotal\": 1654.5425316925732\n },\n {\n \"IDAccountPayableReceivable\": 6227,\n \"DateDue\": \"1957-10-04\",\n \"DateDocument\": \"2021-02-01\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 1,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3582,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 905,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4284.998575258718,\n \"ValueDiscount\": 7828.224029903734,\n \"ValueInterest\": 7206.991596406809,\n \"ValuePenalty\": 6804.174519328776,\n \"ValueTotal\": 9918.135909353303\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "897daa1e-819a-48e9-b154-542bcc5eea89", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0bda9500-eb2e-4d87-aca1-26ec504ac30c", "name": "Atualiza uma conta a pagar", "request": { "name": "Atualiza uma conta a pagar", "description": { "content": "Atualiza a conta a pagar de forma parcial — apenas os campos enviados são alterados (o `PUT` se comporta como `PATCH`). Quando `ChangeNextRepeat=1`, a alteração é propagada para todas as ocorrências futuras da mesma série de recorrência.\n\nA diferença campo a campo é registrada no histórico de alterações. A resposta é a representação completa da conta atualizada, no mesmo formato de `GET /accounts/payable/{idaccountpayable}`.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ChangeNextRepeat", "value": "1", "description": "Quando `1`, propaga a atualização para as próximas ocorrências da mesma recorrência (com `DateDue` posterior)." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\",\n \"DateCompetence\": \"1996-01-12\",\n \"DateDocument\": \"1965-07-21\",\n \"DateDue\": \"2001-04-16\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 5312,\n \"IDConsumer\": 2584,\n \"IDTypePayment\": 3436,\n \"IDTypeDocument\": 6066,\n \"IDTypeAccountPayableReceivable\": 7183,\n \"Scheduled\": 6592,\n \"Value\": 82.3496677565383,\n \"IDBankAccountForecast\": 7337,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 6305.675360216654,\n \"ValueInterest\": 7976.700008343562,\n \"ValuePenalty\": 9255.839440790613,\n \"Forecast\": 4739,\n \"IDCompanyInvoice\": 7893\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9abfd950-5538-4608-bb01-496048762f05", "name": "Conta atualizada. Retorna o mesmo formato do `GET /accounts/payable/{idaccountpayable}`.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\",\n \"DateCompetence\": \"1996-01-12\",\n \"DateDocument\": \"1965-07-21\",\n \"DateDue\": \"2001-04-16\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 5312,\n \"IDConsumer\": 2584,\n \"IDTypePayment\": 3436,\n \"IDTypeDocument\": 6066,\n \"IDTypeAccountPayableReceivable\": 7183,\n \"Scheduled\": 6592,\n \"Value\": 82.3496677565383,\n \"IDBankAccountForecast\": 7337,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 6305.675360216654,\n \"ValueInterest\": 7976.700008343562,\n \"ValuePenalty\": 9255.839440790613,\n \"Forecast\": 4739,\n \"IDCompanyInvoice\": 7893\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1950-12-01\",\n \"DateDocument\": \"2020-10-17\",\n \"DateDue\": \"1989-03-04\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 5151,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDSupplier\": 5671,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 8962,\n \"IDTypeDocument\": 6895,\n \"IDTypePayment\": 144,\n \"RecordTimestamp\": \"1984-12-24T10:49:41.733Z\",\n \"Scheduled\": 6488,\n \"Value\": 7747.086358194173,\n \"IDBankAccountForecast\": 1207,\n \"IDOrder\": 8062,\n \"IDCompanyInvoice\": 3408,\n \"IDAccountPayableReceivableMain\": 2243,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 8220,\n \"ValueDiscount\": 3503.6211823212593,\n \"ValueInterest\": 5499.184644781916,\n \"ValuePenalty\": 7617.315059980647,\n \"ValueTotal\": 1544.6826920478584,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6912,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 1,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 1480.8493580518766,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1987-08-25T01:59:04.324Z\",\n \"IDFile\": 5,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7682,\n \"IDAccountPayableReceivable\": 121\n },\n {\n \"RecordTimestamp\": \"1956-01-22T15:04:06.694Z\",\n \"IDFile\": 3116,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6288,\n \"IDAccountPayableReceivable\": 9\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1949-01-25T09:24:47.277Z\",\n \"IDBankAccount\": 4292,\n \"IDBankStatement\": 4996,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8035.369836951742,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1984-07-15T06:37:50.736Z\",\n \"IDBankAccount\": 4940,\n \"IDBankStatement\": 1557,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2976.162400802511,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2003-09-14T07:42:41.802Z\",\n \"IDAccountsPayableReceivableLog\": 7076,\n \"RecordUserCreated\": 7517,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2023-05-13T09:40:24.261Z\",\n \"IDAccountsPayableReceivableLog\": 1158,\n \"RecordUserCreated\": 6923,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8026,\n \"ValueRatio\": 564.1893984056168,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 1069.4514309754145\n },\n {\n \"IDTypeCostCenter\": 3279,\n \"ValueRatio\": 5148.065389652452,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 9314.932587597365\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5866,\n \"DateDue\": \"1961-12-10\",\n \"DateDocument\": \"1982-03-31\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1201,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1129,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4570.6388750568985,\n \"ValueDiscount\": 977.3647920324313,\n \"ValueInterest\": 3438.931049781051,\n \"ValuePenalty\": 7668.033957912557,\n \"ValueTotal\": 6037.9501487119505\n },\n {\n \"IDAccountPayableReceivable\": 1764,\n \"DateDue\": \"2020-10-11\",\n \"DateDocument\": \"2014-02-04\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 4,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3991,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 275,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 3896.0820107411378,\n \"ValueDiscount\": 6122.255913434556,\n \"ValueInterest\": 1287.9540698697301,\n \"ValuePenalty\": 9974.39924045227,\n \"ValueTotal\": 5680.230438760188\n }\n ]\n },\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"2018-02-21\",\n \"DateDocument\": \"1951-10-09\",\n \"DateDue\": \"2004-03-02\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 8158,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDSupplier\": 2745,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 834,\n \"IDTypeDocument\": 3291,\n \"IDTypePayment\": 8441,\n \"RecordTimestamp\": \"2009-02-26T15:02:14.630Z\",\n \"Scheduled\": 893,\n \"Value\": 397.2176560674434,\n \"IDBankAccountForecast\": 6304,\n \"IDOrder\": 8896,\n \"IDCompanyInvoice\": 321,\n \"IDAccountPayableReceivableMain\": 8310,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 6849,\n \"ValueDiscount\": 2034.1943617266134,\n \"ValueInterest\": 1938.1925946563072,\n \"ValuePenalty\": 5561.8893387304815,\n \"ValueTotal\": 3179.3963802796357,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4166,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 6287.974409699042,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1989-11-20T15:32:23.070Z\",\n \"IDFile\": 1178,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 1113,\n \"IDAccountPayableReceivable\": 6288\n },\n {\n \"RecordTimestamp\": \"1992-07-22T17:52:07.961Z\",\n \"IDFile\": 791,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3033,\n \"IDAccountPayableReceivable\": 9996\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1964-07-14T21:45:05.761Z\",\n \"IDBankAccount\": 9033,\n \"IDBankStatement\": 7317,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 4676.052006537017,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2017-11-29T06:04:22.047Z\",\n \"IDBankAccount\": 3388,\n \"IDBankStatement\": 9296,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3141.052445785759,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2004-04-11T17:03:23.909Z\",\n \"IDAccountsPayableReceivableLog\": 4819,\n \"RecordUserCreated\": 8343,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2014-12-29T21:41:50.184Z\",\n \"IDAccountsPayableReceivableLog\": 8931,\n \"RecordUserCreated\": 5831,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8301,\n \"ValueRatio\": 2830.507295234359,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 6332.373455588662\n },\n {\n \"IDTypeCostCenter\": 5943,\n \"ValueRatio\": 1200.226717940378,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 5319.284625304066\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 7502,\n \"DateDue\": \"2023-02-06\",\n \"DateDocument\": \"1979-09-20\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2750,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4405,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5347.455568828732,\n \"ValueDiscount\": 5453.135151328932,\n \"ValueInterest\": 6040.408228916954,\n \"ValuePenalty\": 4801.921213503684,\n \"ValueTotal\": 1534.2528103216323\n },\n {\n \"IDAccountPayableReceivable\": 1632,\n \"DateDue\": \"2026-07-11\",\n \"DateDocument\": \"2009-03-05\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4020,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 5514,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 710.2316277363263,\n \"ValueDiscount\": 8213.50359557087,\n \"ValueInterest\": 6273.813840735523,\n \"ValuePenalty\": 8493.882845758524,\n \"ValueTotal\": 212.41121980746237\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5c722f5-a2ca-4a5c-864e-631cf3acd9e6", "name": "Validação falhou (prefixo `[BadRequest]`). Mensagens possíveis:\n- `Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)`\n- `Contas a pagar não existe`\n- `Fornecedor não existe` / `Cliente não existe` / `Faturador não existe`\n- `Tipo pagamento não existe` (×2 — também acionado quando `TypeDocument` não é encontrado)\n- `Conta bancária não existe`\n- `Plano de contas não existe`", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\",\n \"DateCompetence\": \"1996-01-12\",\n \"DateDocument\": \"1965-07-21\",\n \"DateDue\": \"2001-04-16\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 5312,\n \"IDConsumer\": 2584,\n \"IDTypePayment\": 3436,\n \"IDTypeDocument\": 6066,\n \"IDTypeAccountPayableReceivable\": 7183,\n \"Scheduled\": 6592,\n \"Value\": 82.3496677565383,\n \"IDBankAccountForecast\": 7337,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 6305.675360216654,\n \"ValueInterest\": 7976.700008343562,\n \"ValuePenalty\": 9255.839440790613,\n \"Forecast\": 4739,\n \"IDCompanyInvoice\": 7893\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f71f737e-4581-4ae1-8efe-e78380bae9cb", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\",\n \"DateCompetence\": \"1996-01-12\",\n \"DateDocument\": \"1965-07-21\",\n \"DateDue\": \"2001-04-16\",\n \"DocumentNumber\": \"string\",\n \"IDSupplier\": 5312,\n \"IDConsumer\": 2584,\n \"IDTypePayment\": 3436,\n \"IDTypeDocument\": 6066,\n \"IDTypeAccountPayableReceivable\": 7183,\n \"Scheduled\": 6592,\n \"Value\": 82.3496677565383,\n \"IDBankAccountForecast\": 7337,\n \"BankSlipBarCode\": \"string\",\n \"ValueDiscount\": 6305.675360216654,\n \"ValueInterest\": 7976.700008343562,\n \"ValuePenalty\": 9255.839440790613,\n \"Forecast\": 4739,\n \"IDCompanyInvoice\": 7893\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17ab593e-f286-48cd-b0e1-03a2308c0210", "name": "Exclui uma conta a pagar", "request": { "name": "Exclui uma conta a pagar", "description": { "content": "Remove a conta a pagar e desvincula as GNREs associadas. Responde com a string `\"sucesso\"`.\n\n**Regras**:\n- Não é possível excluir quando a conta está agendada.\n- Não é possível excluir quando já existem pagamentos lançados.\n- Quando a conta está vinculada a uma compra e a parametrização **Não permitir excluir contas pagar com recebimento** da empresa está ativa, a exclusão é bloqueada.\n- Quando `ChangeNextRepeat=1`, também remove as ocorrências futuras da mesma série de recorrência (as com vencimento posterior ao da conta excluída).", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ChangeNextRepeat", "value": "1", "description": "Quando `1`, também exclui as próximas ocorrências da mesma recorrência." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7c4ccd4f-ddd4-448e-9b79-7a854987818d", "name": "Exclusão bem-sucedida. Nesta rota o corpo é **sempre** a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d61c8ef1-d7bf-46dc-bed4-d56eef26e8cb", "name": "Regras impeditivas (prefixo `[BadRequest]`):\n- `Pagamento não existe`\n- `Título está agendado e não pode ser excluído`\n- `Não é possível excluir um contas a pagar atrelado a um recebimento`\n- `Contas a pagar já tem pagamento`", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17b6ac47-e8cf-45c0-be02-8aff241ec538", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5b9e461-3a88-4301-ab9c-cda52a0ac690", "name": "Gera ZIP com arquivos de contas a pagar e envia por e-mail", "request": { "name": "Gera ZIP com arquivos de contas a pagar e envia por e-mail", "description": { "content": "Recebe uma lista de ids de contas a pagar, compacta todos os arquivos anexados num `.zip`, faz upload no S3 e envia o link de download para o e-mail do usuário autenticado. O link tem validade de **2 dias**.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n 26,\n 6511\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0fdf7850-182e-4d21-9b43-31a3e400a002", "name": "URL assinada do ZIP gerado no S3 (válida por 48 horas). O arquivo também é enviado para o e-mail do usuário.", "originalRequest": { "url": { "path": [ "accounts", "payable", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 4529,\n 4076\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"http://MGyvSv.nedf2CLEQ7bXzxrOZTOjfy+rfLOqdKqiUdsSY\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed150df0-ffb7-44c1-b5d6-fa96e3e6657e", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `IDs inválidos`\n- `Nenhum arquivo encontrado`\n- `Usuário não encontrado`\n- `Empresa inválida`", "originalRequest": { "url": { "path": [ "accounts", "payable", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 4529,\n 4076\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76a65577-f452-4b47-b625-6723c3cd9d5e", "name": "Lança um pagamento na conta a pagar", "request": { "name": "Lança um pagamento na conta a pagar", "description": { "content": "Registra um pagamento na conta a pagar, atualizando o status conforme o saldo devedor resultante. Regras:\n\n- Quando `FinishIfPossible=1` e há pedido vinculado, tenta finalizar o pedido se todos os títulos estiverem pagos.\n- Pagamentos em conta de **caixinha** (`BankNumber=000`) só são aceitos com a caixinha fechada.\n- Quando a conta ainda não tem conta bancária de previsão definida, a conta informada em `IDBankAccount` passa a ser também a de previsão.\n- Quando `IDAccountsPayableReceivableConciliation` **ou** `IDAccountsPayableReceivableConciliationMarketplace` é informado e o `Value` difere do valor do título com acréscimos e descontos, o sistema procura outro título do mesmo pedido com o mesmo TID ou NSU e redistribui a diferença entre os dois; se não houver esse outro título, a requisição é recusada.\n- Quando `IDAccountsPayableReceivableConciliation` é informado, o lançamento é vinculado à conciliação de adquirente e ela é fechada como conciliada manualmente (`ConciliationStatus=3`).\n- Quando `IDAccountsPayableReceivableConciliationMarketplace` é informado, gera automaticamente as contas filhas das taxas do marketplace, vinculadas ao título da baixa: comissão (`MarketplaceFeeValue`), antecipação (`MarketplaceFinancingFeeValue`), frete (`MarketplaceShippingFeeValue`), cupom (`MarketplaceCouponValue`) e outras taxas (`MarketplaceOtherFeeValue`). Cada categoria só vira título próprio quando a integração tem um plano de contas configurado para ela e o valor é diferente de zero; antecipação, frete, cupom e outras taxas sem plano de contas configurado são somadas ao valor da comissão. O valor de impostos (`MarketplaceTaxesValue`) depende de um plano de contas exclusivo de impostos, que hoje não é configurável nas integrações de marketplace — na prática ele não gera título nem entra na soma da comissão. Cada conta filha recebe também o lançamento correspondente no extrato bancário e, quando a integração tem centro de custo configurado, o rateio nesse centro. Os valores entram com o sinal invertido em relação à taxa: taxa cobrada vira débito e taxa devolvida (cancelamento) vira crédito. Concluído o vínculo, a conciliação é fechada como conciliada manualmente (`IDTypeStatusConciliation=3`).\n- É por esta rota que se dá baixa nas despesas do canal (armazenagem, mensalidade, ajuste de comissão) que aparecem como linhas do extrato de marketplace sem pedido de origem.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "FinishIfPossible", "value": "1", "description": "Quando `1`, tenta finalizar o pedido vinculado se todos os seus títulos estiverem pagos após este lançamento." }, { "disabled": false, "key": "query", "value": "1", "description": "Quando `1`, a resposta é apenas a string `\"sucesso\"`, sem os dados completos da conta. Útil em baixas em massa, para reduzir o tempo de resposta." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 4765,\n \"DateTransactionTimestamp\": \"1983-05-23T18:12:37.030Z\",\n \"Value\": 565.170004253428,\n \"TransactionDescription\": \"\",\n \"TransactionDocument\": \"\",\n \"IDAccountsPayableReceivableConciliation\": 6618,\n \"IDAccountsPayableReceivableConciliationMarketplace\": 6688\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b4eb30b1-1bef-48fa-9259-037ec01dbabb", "name": "Pagamento lançado. Retorna a conta a pagar atualizada — ou apenas a string `\"sucesso\"` quando `query=1`.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FinishIfPossible", "value": "1" }, { "key": "query", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 4765,\n \"DateTransactionTimestamp\": \"1983-05-23T18:12:37.030Z\",\n \"Value\": 565.170004253428,\n \"TransactionDescription\": \"\",\n \"TransactionDocument\": \"\",\n \"IDAccountsPayableReceivableConciliation\": 6618,\n \"IDAccountsPayableReceivableConciliationMarketplace\": 6688\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1950-12-01\",\n \"DateDocument\": \"2020-10-17\",\n \"DateDue\": \"1989-03-04\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 5151,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDSupplier\": 5671,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 8962,\n \"IDTypeDocument\": 6895,\n \"IDTypePayment\": 144,\n \"RecordTimestamp\": \"1984-12-24T10:49:41.733Z\",\n \"Scheduled\": 6488,\n \"Value\": 7747.086358194173,\n \"IDBankAccountForecast\": 1207,\n \"IDOrder\": 8062,\n \"IDCompanyInvoice\": 3408,\n \"IDAccountPayableReceivableMain\": 2243,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 8220,\n \"ValueDiscount\": 3503.6211823212593,\n \"ValueInterest\": 5499.184644781916,\n \"ValuePenalty\": 7617.315059980647,\n \"ValueTotal\": 1544.6826920478584,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6912,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 1,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 1480.8493580518766,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1987-08-25T01:59:04.324Z\",\n \"IDFile\": 5,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7682,\n \"IDAccountPayableReceivable\": 121\n },\n {\n \"RecordTimestamp\": \"1956-01-22T15:04:06.694Z\",\n \"IDFile\": 3116,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6288,\n \"IDAccountPayableReceivable\": 9\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1949-01-25T09:24:47.277Z\",\n \"IDBankAccount\": 4292,\n \"IDBankStatement\": 4996,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8035.369836951742,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1984-07-15T06:37:50.736Z\",\n \"IDBankAccount\": 4940,\n \"IDBankStatement\": 1557,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2976.162400802511,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2003-09-14T07:42:41.802Z\",\n \"IDAccountsPayableReceivableLog\": 7076,\n \"RecordUserCreated\": 7517,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2023-05-13T09:40:24.261Z\",\n \"IDAccountsPayableReceivableLog\": 1158,\n \"RecordUserCreated\": 6923,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8026,\n \"ValueRatio\": 564.1893984056168,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 1069.4514309754145\n },\n {\n \"IDTypeCostCenter\": 3279,\n \"ValueRatio\": 5148.065389652452,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 9314.932587597365\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5866,\n \"DateDue\": \"1961-12-10\",\n \"DateDocument\": \"1982-03-31\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1201,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1129,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4570.6388750568985,\n \"ValueDiscount\": 977.3647920324313,\n \"ValueInterest\": 3438.931049781051,\n \"ValuePenalty\": 7668.033957912557,\n \"ValueTotal\": 6037.9501487119505\n },\n {\n \"IDAccountPayableReceivable\": 1764,\n \"DateDue\": \"2020-10-11\",\n \"DateDocument\": \"2014-02-04\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 4,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3991,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 275,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 3896.0820107411378,\n \"ValueDiscount\": 6122.255913434556,\n \"ValueInterest\": 1287.9540698697301,\n \"ValuePenalty\": 9974.39924045227,\n \"ValueTotal\": 5680.230438760188\n }\n ]\n },\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"2018-02-21\",\n \"DateDocument\": \"1951-10-09\",\n \"DateDue\": \"2004-03-02\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 8158,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDSupplier\": 2745,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 834,\n \"IDTypeDocument\": 3291,\n \"IDTypePayment\": 8441,\n \"RecordTimestamp\": \"2009-02-26T15:02:14.630Z\",\n \"Scheduled\": 893,\n \"Value\": 397.2176560674434,\n \"IDBankAccountForecast\": 6304,\n \"IDOrder\": 8896,\n \"IDCompanyInvoice\": 321,\n \"IDAccountPayableReceivableMain\": 8310,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 6849,\n \"ValueDiscount\": 2034.1943617266134,\n \"ValueInterest\": 1938.1925946563072,\n \"ValuePenalty\": 5561.8893387304815,\n \"ValueTotal\": 3179.3963802796357,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4166,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 6287.974409699042,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1989-11-20T15:32:23.070Z\",\n \"IDFile\": 1178,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 1113,\n \"IDAccountPayableReceivable\": 6288\n },\n {\n \"RecordTimestamp\": \"1992-07-22T17:52:07.961Z\",\n \"IDFile\": 791,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3033,\n \"IDAccountPayableReceivable\": 9996\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1964-07-14T21:45:05.761Z\",\n \"IDBankAccount\": 9033,\n \"IDBankStatement\": 7317,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 4676.052006537017,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2017-11-29T06:04:22.047Z\",\n \"IDBankAccount\": 3388,\n \"IDBankStatement\": 9296,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3141.052445785759,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2004-04-11T17:03:23.909Z\",\n \"IDAccountsPayableReceivableLog\": 4819,\n \"RecordUserCreated\": 8343,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2014-12-29T21:41:50.184Z\",\n \"IDAccountsPayableReceivableLog\": 8931,\n \"RecordUserCreated\": 5831,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8301,\n \"ValueRatio\": 2830.507295234359,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 6332.373455588662\n },\n {\n \"IDTypeCostCenter\": 5943,\n \"ValueRatio\": 1200.226717940378,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 5319.284625304066\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 7502,\n \"DateDue\": \"2023-02-06\",\n \"DateDocument\": \"1979-09-20\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2750,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4405,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5347.455568828732,\n \"ValueDiscount\": 5453.135151328932,\n \"ValueInterest\": 6040.408228916954,\n \"ValuePenalty\": 4801.921213503684,\n \"ValueTotal\": 1534.2528103216323\n },\n {\n \"IDAccountPayableReceivable\": 1632,\n \"DateDue\": \"2026-07-11\",\n \"DateDocument\": \"2009-03-05\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4020,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 5514,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 710.2316277363263,\n \"ValueDiscount\": 8213.50359557087,\n \"ValueInterest\": 6273.813840735523,\n \"ValuePenalty\": 8493.882845758524,\n \"ValueTotal\": 212.41121980746237\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ada87d0-401d-46c9-8da4-c7c7c99784b9", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Conta a receber/pagar não existe`\n- `Conta bancária não existe`\n- `Caixinha está aberto e não pode ter pagamentos efetuados`\n- `Valor a conciliar divergente de valor do título e não há outro lançamento relacionado`\n- `Conciliação marketplace inexistente`\n- `Erro ao criar lançamento de taxa adquirente`", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FinishIfPossible", "value": "1" }, { "key": "query", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 4765,\n \"DateTransactionTimestamp\": \"1983-05-23T18:12:37.030Z\",\n \"Value\": 565.170004253428,\n \"TransactionDescription\": \"\",\n \"TransactionDocument\": \"\",\n \"IDAccountsPayableReceivableConciliation\": 6618,\n \"IDAccountsPayableReceivableConciliationMarketplace\": 6688\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8ecdfe3-4aec-44fe-9378-c9eaaadbe62a", "name": "Cancela um pagamento lançado", "request": { "name": "Cancela um pagamento lançado", "description": { "content": "Remove o lançamento de pagamento e reverte o status da conta a pagar. Regras:\n\n- Pagamentos lançados em **caixa** (`IDStoreFrontCashier` preenchido) não podem ser excluídos por esta rota.\n- Pagamentos em conta de **caixinha** (`BankNumber=000`) só podem ser excluídos com a caixinha fechada.\n- Quando o pagamento está vinculado a uma **conciliação bancária**, o vínculo é desfeito e a conciliação volta para `IDTypeStatusConciliation=4` (Conciliado parcialmente) se ainda restarem outros pagamentos vinculados a ela, ou para `1` (Não conciliado) quando era o último.\n- Quando o pagamento está vinculado a uma **conciliação de adquirente**, o vínculo é desfeito e a conciliação volta para `ConciliationStatus=1` (Não conciliado), sem recálculo por lançamentos remanescentes.\n- Quando o pagamento está vinculado a uma **conciliação de marketplace**, a referência é desfeita e a conciliação volta para `IDTypeStatusConciliation=1` (Não conciliado), voltando a ser listada como pendente.\n- O estorno não é simétrico à baixa: apenas o lançamento do título informado é removido. As contas filhas de comissão, antecipação, frete, cupom e outras taxas criadas na baixa permanecem, com seus próprios lançamentos, e precisam ser tratadas individualmente.\n- A exclusão é registrada no histórico da conta.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable", "payment", ":idaccountpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDBankStatementConciliation", "value": "2232", "description": "Quando informado, garante que o pagamento só seja excluído se pertencer a esta conciliação. Pagamentos vinculados a outra conciliação são bloqueados." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayment", "description": "(Required) Identificador do lançamento de pagamento (`IDBankStatement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b80a495b-ba9c-4c51-b2e2-8334178b1c29", "name": "Pagamento cancelado. Retorna a conta a pagar atualizada.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "payment", ":idaccountpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankStatementConciliation", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayment", "description": "(Required) Identificador do lançamento de pagamento (`IDBankStatement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1950-12-01\",\n \"DateDocument\": \"2020-10-17\",\n \"DateDue\": \"1989-03-04\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 5151,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDSupplier\": 5671,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 8962,\n \"IDTypeDocument\": 6895,\n \"IDTypePayment\": 144,\n \"RecordTimestamp\": \"1984-12-24T10:49:41.733Z\",\n \"Scheduled\": 6488,\n \"Value\": 7747.086358194173,\n \"IDBankAccountForecast\": 1207,\n \"IDOrder\": 8062,\n \"IDCompanyInvoice\": 3408,\n \"IDAccountPayableReceivableMain\": 2243,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 8220,\n \"ValueDiscount\": 3503.6211823212593,\n \"ValueInterest\": 5499.184644781916,\n \"ValuePenalty\": 7617.315059980647,\n \"ValueTotal\": 1544.6826920478584,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6912,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 1,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 1480.8493580518766,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1987-08-25T01:59:04.324Z\",\n \"IDFile\": 5,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7682,\n \"IDAccountPayableReceivable\": 121\n },\n {\n \"RecordTimestamp\": \"1956-01-22T15:04:06.694Z\",\n \"IDFile\": 3116,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6288,\n \"IDAccountPayableReceivable\": 9\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1949-01-25T09:24:47.277Z\",\n \"IDBankAccount\": 4292,\n \"IDBankStatement\": 4996,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8035.369836951742,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1984-07-15T06:37:50.736Z\",\n \"IDBankAccount\": 4940,\n \"IDBankStatement\": 1557,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2976.162400802511,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2003-09-14T07:42:41.802Z\",\n \"IDAccountsPayableReceivableLog\": 7076,\n \"RecordUserCreated\": 7517,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2023-05-13T09:40:24.261Z\",\n \"IDAccountsPayableReceivableLog\": 1158,\n \"RecordUserCreated\": 6923,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8026,\n \"ValueRatio\": 564.1893984056168,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 1069.4514309754145\n },\n {\n \"IDTypeCostCenter\": 3279,\n \"ValueRatio\": 5148.065389652452,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 9314.932587597365\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5866,\n \"DateDue\": \"1961-12-10\",\n \"DateDocument\": \"1982-03-31\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1201,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1129,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4570.6388750568985,\n \"ValueDiscount\": 977.3647920324313,\n \"ValueInterest\": 3438.931049781051,\n \"ValuePenalty\": 7668.033957912557,\n \"ValueTotal\": 6037.9501487119505\n },\n {\n \"IDAccountPayableReceivable\": 1764,\n \"DateDue\": \"2020-10-11\",\n \"DateDocument\": \"2014-02-04\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 4,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3991,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 275,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 3896.0820107411378,\n \"ValueDiscount\": 6122.255913434556,\n \"ValueInterest\": 1287.9540698697301,\n \"ValuePenalty\": 9974.39924045227,\n \"ValueTotal\": 5680.230438760188\n }\n ]\n },\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"2018-02-21\",\n \"DateDocument\": \"1951-10-09\",\n \"DateDue\": \"2004-03-02\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 8158,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDSupplier\": 2745,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 834,\n \"IDTypeDocument\": 3291,\n \"IDTypePayment\": 8441,\n \"RecordTimestamp\": \"2009-02-26T15:02:14.630Z\",\n \"Scheduled\": 893,\n \"Value\": 397.2176560674434,\n \"IDBankAccountForecast\": 6304,\n \"IDOrder\": 8896,\n \"IDCompanyInvoice\": 321,\n \"IDAccountPayableReceivableMain\": 8310,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 6849,\n \"ValueDiscount\": 2034.1943617266134,\n \"ValueInterest\": 1938.1925946563072,\n \"ValuePenalty\": 5561.8893387304815,\n \"ValueTotal\": 3179.3963802796357,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4166,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 6287.974409699042,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1989-11-20T15:32:23.070Z\",\n \"IDFile\": 1178,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 1113,\n \"IDAccountPayableReceivable\": 6288\n },\n {\n \"RecordTimestamp\": \"1992-07-22T17:52:07.961Z\",\n \"IDFile\": 791,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3033,\n \"IDAccountPayableReceivable\": 9996\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1964-07-14T21:45:05.761Z\",\n \"IDBankAccount\": 9033,\n \"IDBankStatement\": 7317,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 4676.052006537017,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2017-11-29T06:04:22.047Z\",\n \"IDBankAccount\": 3388,\n \"IDBankStatement\": 9296,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3141.052445785759,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2004-04-11T17:03:23.909Z\",\n \"IDAccountsPayableReceivableLog\": 4819,\n \"RecordUserCreated\": 8343,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2014-12-29T21:41:50.184Z\",\n \"IDAccountsPayableReceivableLog\": 8931,\n \"RecordUserCreated\": 5831,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8301,\n \"ValueRatio\": 2830.507295234359,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 6332.373455588662\n },\n {\n \"IDTypeCostCenter\": 5943,\n \"ValueRatio\": 1200.226717940378,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 5319.284625304066\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 7502,\n \"DateDue\": \"2023-02-06\",\n \"DateDocument\": \"1979-09-20\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2750,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4405,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5347.455568828732,\n \"ValueDiscount\": 5453.135151328932,\n \"ValueInterest\": 6040.408228916954,\n \"ValuePenalty\": 4801.921213503684,\n \"ValueTotal\": 1534.2528103216323\n },\n {\n \"IDAccountPayableReceivable\": 1632,\n \"DateDue\": \"2026-07-11\",\n \"DateDocument\": \"2009-03-05\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4020,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 5514,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 710.2316277363263,\n \"ValueDiscount\": 8213.50359557087,\n \"ValueInterest\": 6273.813840735523,\n \"ValuePenalty\": 8493.882845758524,\n \"ValueTotal\": 212.41121980746237\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "537e38b0-15e3-44e2-961e-c00e35b23477", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Pagamento não existe`\n- `Pagamento foi realizado em um caixa e não pode ser excluído`\n- `Caixinha está aberto e não pode ter pagamentos efetuados`\n- `Não é possível excluir um pagamento vinculado a outra conciliação bancária`\n- `Problema ao deletar pagamento`\n- `Erro ao atualizar conciliação bancária`\n- `Erro ao verificar vínculos de conciliação`", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "payment", ":idaccountpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankStatementConciliation", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayment", "description": "(Required) Identificador do lançamento de pagamento (`IDBankStatement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d2e9240-0284-4128-9136-b4e317f58e00", "name": "Define o rateio de centros de custo", "request": { "name": "Define o rateio de centros de custo", "description": { "content": "Substitui completamente o rateio de centros de custo da conta a pagar. Enviar array vazio remove todos os centros. A soma de `ValueRatio` de todos os itens deve ser exatamente `1` (100%).", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 9197,\n \"ValueRatio\": 8964.987636085127\n },\n {\n \"IDTypeCostCenter\": 5109,\n \"ValueRatio\": 6169.135888968709\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e41ac878-7029-43ac-a96c-67f732194c72", "name": "Rateio atualizado. Retorna a conta a pagar atualizada ou `\"sucesso\"` quando o array foi vazio.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 2011,\n \"ValueRatio\": 4328.627972395862\n },\n {\n \"IDTypeCostCenter\": 7993,\n \"ValueRatio\": 3242.6994103913366\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1950-12-01\",\n \"DateDocument\": \"2020-10-17\",\n \"DateDue\": \"1989-03-04\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 5151,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDSupplier\": 5671,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 8962,\n \"IDTypeDocument\": 6895,\n \"IDTypePayment\": 144,\n \"RecordTimestamp\": \"1984-12-24T10:49:41.733Z\",\n \"Scheduled\": 6488,\n \"Value\": 7747.086358194173,\n \"IDBankAccountForecast\": 1207,\n \"IDOrder\": 8062,\n \"IDCompanyInvoice\": 3408,\n \"IDAccountPayableReceivableMain\": 2243,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 8220,\n \"ValueDiscount\": 3503.6211823212593,\n \"ValueInterest\": 5499.184644781916,\n \"ValuePenalty\": 7617.315059980647,\n \"ValueTotal\": 1544.6826920478584,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6912,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 1,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 1480.8493580518766,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1987-08-25T01:59:04.324Z\",\n \"IDFile\": 5,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7682,\n \"IDAccountPayableReceivable\": 121\n },\n {\n \"RecordTimestamp\": \"1956-01-22T15:04:06.694Z\",\n \"IDFile\": 3116,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6288,\n \"IDAccountPayableReceivable\": 9\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1949-01-25T09:24:47.277Z\",\n \"IDBankAccount\": 4292,\n \"IDBankStatement\": 4996,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8035.369836951742,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1984-07-15T06:37:50.736Z\",\n \"IDBankAccount\": 4940,\n \"IDBankStatement\": 1557,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2976.162400802511,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2003-09-14T07:42:41.802Z\",\n \"IDAccountsPayableReceivableLog\": 7076,\n \"RecordUserCreated\": 7517,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2023-05-13T09:40:24.261Z\",\n \"IDAccountsPayableReceivableLog\": 1158,\n \"RecordUserCreated\": 6923,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8026,\n \"ValueRatio\": 564.1893984056168,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 1069.4514309754145\n },\n {\n \"IDTypeCostCenter\": 3279,\n \"ValueRatio\": 5148.065389652452,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 9314.932587597365\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5866,\n \"DateDue\": \"1961-12-10\",\n \"DateDocument\": \"1982-03-31\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1201,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1129,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4570.6388750568985,\n \"ValueDiscount\": 977.3647920324313,\n \"ValueInterest\": 3438.931049781051,\n \"ValuePenalty\": 7668.033957912557,\n \"ValueTotal\": 6037.9501487119505\n },\n {\n \"IDAccountPayableReceivable\": 1764,\n \"DateDue\": \"2020-10-11\",\n \"DateDocument\": \"2014-02-04\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 4,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3991,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 275,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 3896.0820107411378,\n \"ValueDiscount\": 6122.255913434556,\n \"ValueInterest\": 1287.9540698697301,\n \"ValuePenalty\": 9974.39924045227,\n \"ValueTotal\": 5680.230438760188\n }\n ]\n },\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"2018-02-21\",\n \"DateDocument\": \"1951-10-09\",\n \"DateDue\": \"2004-03-02\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 8158,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDSupplier\": 2745,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 834,\n \"IDTypeDocument\": 3291,\n \"IDTypePayment\": 8441,\n \"RecordTimestamp\": \"2009-02-26T15:02:14.630Z\",\n \"Scheduled\": 893,\n \"Value\": 397.2176560674434,\n \"IDBankAccountForecast\": 6304,\n \"IDOrder\": 8896,\n \"IDCompanyInvoice\": 321,\n \"IDAccountPayableReceivableMain\": 8310,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 6849,\n \"ValueDiscount\": 2034.1943617266134,\n \"ValueInterest\": 1938.1925946563072,\n \"ValuePenalty\": 5561.8893387304815,\n \"ValueTotal\": 3179.3963802796357,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4166,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 6287.974409699042,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1989-11-20T15:32:23.070Z\",\n \"IDFile\": 1178,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 1113,\n \"IDAccountPayableReceivable\": 6288\n },\n {\n \"RecordTimestamp\": \"1992-07-22T17:52:07.961Z\",\n \"IDFile\": 791,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3033,\n \"IDAccountPayableReceivable\": 9996\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1964-07-14T21:45:05.761Z\",\n \"IDBankAccount\": 9033,\n \"IDBankStatement\": 7317,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 4676.052006537017,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2017-11-29T06:04:22.047Z\",\n \"IDBankAccount\": 3388,\n \"IDBankStatement\": 9296,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3141.052445785759,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2004-04-11T17:03:23.909Z\",\n \"IDAccountsPayableReceivableLog\": 4819,\n \"RecordUserCreated\": 8343,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2014-12-29T21:41:50.184Z\",\n \"IDAccountsPayableReceivableLog\": 8931,\n \"RecordUserCreated\": 5831,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8301,\n \"ValueRatio\": 2830.507295234359,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 6332.373455588662\n },\n {\n \"IDTypeCostCenter\": 5943,\n \"ValueRatio\": 1200.226717940378,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 5319.284625304066\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 7502,\n \"DateDue\": \"2023-02-06\",\n \"DateDocument\": \"1979-09-20\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2750,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4405,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5347.455568828732,\n \"ValueDiscount\": 5453.135151328932,\n \"ValueInterest\": 6040.408228916954,\n \"ValuePenalty\": 4801.921213503684,\n \"ValueTotal\": 1534.2528103216323\n },\n {\n \"IDAccountPayableReceivable\": 1632,\n \"DateDue\": \"2026-07-11\",\n \"DateDocument\": \"2009-03-05\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4020,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 5514,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 710.2316277363263,\n \"ValueDiscount\": 8213.50359557087,\n \"ValueInterest\": 6273.813840735523,\n \"ValuePenalty\": 8493.882845758524,\n \"ValueTotal\": 212.41121980746237\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f853229-b17e-4093-aacf-2c380b115ce3", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Conta a receber/pagar não existe`\n- `Rateio precisa somar 100%`\n- `Centro de custo(s) não localizado(s): {ids}`\n- `Precisa enviar ao menos um centro de custo`", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 2011,\n \"ValueRatio\": 4328.627972395862\n },\n {\n \"IDTypeCostCenter\": 7993,\n \"ValueRatio\": 3242.6994103913366\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "718aa0ad-6aab-4fa2-a280-03911d93596c", "name": "Envia a conta a pagar para pagamento bancário integrado", "request": { "name": "Envia a conta a pagar para pagamento bancário integrado", "description": { "content": "Processa o pagamento via integração bancária. Após o envio, retorna a conta atualizada, salvo quando `NoInvoke=1`.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable", "bank-integration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "NoInvoke", "value": "1", "description": "Quando `1`, não consulta `accountsPayableGet` após o envio e devolve apenas `\"Sucesso\"`." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2b10aa47-5c3a-4d72-9a51-abc24da10f0b", "name": "Envio bem-sucedido. Retorna a conta a pagar atualizada ou `\"Sucesso\"` quando `NoInvoke=1`.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "bank-integration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1950-12-01\",\n \"DateDocument\": \"2020-10-17\",\n \"DateDue\": \"1989-03-04\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 5151,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDSupplier\": 5671,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 8962,\n \"IDTypeDocument\": 6895,\n \"IDTypePayment\": 144,\n \"RecordTimestamp\": \"1984-12-24T10:49:41.733Z\",\n \"Scheduled\": 6488,\n \"Value\": 7747.086358194173,\n \"IDBankAccountForecast\": 1207,\n \"IDOrder\": 8062,\n \"IDCompanyInvoice\": 3408,\n \"IDAccountPayableReceivableMain\": 2243,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 8220,\n \"ValueDiscount\": 3503.6211823212593,\n \"ValueInterest\": 5499.184644781916,\n \"ValuePenalty\": 7617.315059980647,\n \"ValueTotal\": 1544.6826920478584,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6912,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 1,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 1480.8493580518766,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1987-08-25T01:59:04.324Z\",\n \"IDFile\": 5,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7682,\n \"IDAccountPayableReceivable\": 121\n },\n {\n \"RecordTimestamp\": \"1956-01-22T15:04:06.694Z\",\n \"IDFile\": 3116,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6288,\n \"IDAccountPayableReceivable\": 9\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1949-01-25T09:24:47.277Z\",\n \"IDBankAccount\": 4292,\n \"IDBankStatement\": 4996,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8035.369836951742,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1984-07-15T06:37:50.736Z\",\n \"IDBankAccount\": 4940,\n \"IDBankStatement\": 1557,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2976.162400802511,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2003-09-14T07:42:41.802Z\",\n \"IDAccountsPayableReceivableLog\": 7076,\n \"RecordUserCreated\": 7517,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2023-05-13T09:40:24.261Z\",\n \"IDAccountsPayableReceivableLog\": 1158,\n \"RecordUserCreated\": 6923,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8026,\n \"ValueRatio\": 564.1893984056168,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 1069.4514309754145\n },\n {\n \"IDTypeCostCenter\": 3279,\n \"ValueRatio\": 5148.065389652452,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 9314.932587597365\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5866,\n \"DateDue\": \"1961-12-10\",\n \"DateDocument\": \"1982-03-31\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1201,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1129,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4570.6388750568985,\n \"ValueDiscount\": 977.3647920324313,\n \"ValueInterest\": 3438.931049781051,\n \"ValuePenalty\": 7668.033957912557,\n \"ValueTotal\": 6037.9501487119505\n },\n {\n \"IDAccountPayableReceivable\": 1764,\n \"DateDue\": \"2020-10-11\",\n \"DateDocument\": \"2014-02-04\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 4,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3991,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 275,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 3896.0820107411378,\n \"ValueDiscount\": 6122.255913434556,\n \"ValueInterest\": 1287.9540698697301,\n \"ValuePenalty\": 9974.39924045227,\n \"ValueTotal\": 5680.230438760188\n }\n ]\n },\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"2018-02-21\",\n \"DateDocument\": \"1951-10-09\",\n \"DateDue\": \"2004-03-02\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 8158,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDSupplier\": 2745,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 834,\n \"IDTypeDocument\": 3291,\n \"IDTypePayment\": 8441,\n \"RecordTimestamp\": \"2009-02-26T15:02:14.630Z\",\n \"Scheduled\": 893,\n \"Value\": 397.2176560674434,\n \"IDBankAccountForecast\": 6304,\n \"IDOrder\": 8896,\n \"IDCompanyInvoice\": 321,\n \"IDAccountPayableReceivableMain\": 8310,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 6849,\n \"ValueDiscount\": 2034.1943617266134,\n \"ValueInterest\": 1938.1925946563072,\n \"ValuePenalty\": 5561.8893387304815,\n \"ValueTotal\": 3179.3963802796357,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4166,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 6287.974409699042,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1989-11-20T15:32:23.070Z\",\n \"IDFile\": 1178,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 1113,\n \"IDAccountPayableReceivable\": 6288\n },\n {\n \"RecordTimestamp\": \"1992-07-22T17:52:07.961Z\",\n \"IDFile\": 791,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3033,\n \"IDAccountPayableReceivable\": 9996\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1964-07-14T21:45:05.761Z\",\n \"IDBankAccount\": 9033,\n \"IDBankStatement\": 7317,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 4676.052006537017,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2017-11-29T06:04:22.047Z\",\n \"IDBankAccount\": 3388,\n \"IDBankStatement\": 9296,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3141.052445785759,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2004-04-11T17:03:23.909Z\",\n \"IDAccountsPayableReceivableLog\": 4819,\n \"RecordUserCreated\": 8343,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2014-12-29T21:41:50.184Z\",\n \"IDAccountsPayableReceivableLog\": 8931,\n \"RecordUserCreated\": 5831,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8301,\n \"ValueRatio\": 2830.507295234359,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 6332.373455588662\n },\n {\n \"IDTypeCostCenter\": 5943,\n \"ValueRatio\": 1200.226717940378,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 5319.284625304066\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 7502,\n \"DateDue\": \"2023-02-06\",\n \"DateDocument\": \"1979-09-20\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2750,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4405,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5347.455568828732,\n \"ValueDiscount\": 5453.135151328932,\n \"ValueInterest\": 6040.408228916954,\n \"ValuePenalty\": 4801.921213503684,\n \"ValueTotal\": 1534.2528103216323\n },\n {\n \"IDAccountPayableReceivable\": 1632,\n \"DateDue\": \"2026-07-11\",\n \"DateDocument\": \"2009-03-05\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4020,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 5514,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 710.2316277363263,\n \"ValueDiscount\": 8213.50359557087,\n \"ValueInterest\": 6273.813840735523,\n \"ValuePenalty\": 8493.882845758524,\n \"ValueTotal\": 212.41121980746237\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30869849-6611-40cb-8120-8dc028237260", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Título precisa ser enviado`\n- Mensagens de erro retornadas pelo processo bancário.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "bank-integration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31aa37d0-aafa-418f-991a-4c24f51581b7", "name": "Anexa um arquivo à conta a pagar", "request": { "name": "Anexa um arquivo à conta a pagar", "description": { "content": "Faz upload de um arquivo via `multipart/form-data` (campo `file`) e o vincula à conta a pagar. O tipo do arquivo é definido pelo parâmetro `IDTypeFile`. Ao anexar um boleto, o sistema tenta ler automaticamente o código de barras ou o PIX copia-e-cola do arquivo; quando a conta ainda não tem `BankSlipBarCode` preenchido, o valor lido é gravado. Retorna o detalhe atualizado da conta a pagar.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeFile", "value": "8", "description": "(Required) Tipo do arquivo: 1=Documento Fiscal PDF, 2=Documento Fiscal XML, 3=Boleto Bancário, 4=Comprovante Pagamento, 5=Carta de Correção PDF, 6=Carta de Correção XML, 7=Inutilização NF XML, 8=Cancelamento NF XML." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Arquivo a ser anexado." } ] } }, "response": [ { "id": "50520bee-1ad8-41e4-8ced-69dd5847ecaa", "name": "Arquivo anexado. Retorna a conta a pagar atualizada com o novo arquivo listado em `Files`.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeFile", "value": "8" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo a ser anexado.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1950-12-01\",\n \"DateDocument\": \"2020-10-17\",\n \"DateDue\": \"1989-03-04\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 5151,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDSupplier\": 5671,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 8962,\n \"IDTypeDocument\": 6895,\n \"IDTypePayment\": 144,\n \"RecordTimestamp\": \"1984-12-24T10:49:41.733Z\",\n \"Scheduled\": 6488,\n \"Value\": 7747.086358194173,\n \"IDBankAccountForecast\": 1207,\n \"IDOrder\": 8062,\n \"IDCompanyInvoice\": 3408,\n \"IDAccountPayableReceivableMain\": 2243,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 8220,\n \"ValueDiscount\": 3503.6211823212593,\n \"ValueInterest\": 5499.184644781916,\n \"ValuePenalty\": 7617.315059980647,\n \"ValueTotal\": 1544.6826920478584,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6912,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 1,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 1480.8493580518766,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1987-08-25T01:59:04.324Z\",\n \"IDFile\": 5,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7682,\n \"IDAccountPayableReceivable\": 121\n },\n {\n \"RecordTimestamp\": \"1956-01-22T15:04:06.694Z\",\n \"IDFile\": 3116,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6288,\n \"IDAccountPayableReceivable\": 9\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1949-01-25T09:24:47.277Z\",\n \"IDBankAccount\": 4292,\n \"IDBankStatement\": 4996,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8035.369836951742,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1984-07-15T06:37:50.736Z\",\n \"IDBankAccount\": 4940,\n \"IDBankStatement\": 1557,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2976.162400802511,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2003-09-14T07:42:41.802Z\",\n \"IDAccountsPayableReceivableLog\": 7076,\n \"RecordUserCreated\": 7517,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2023-05-13T09:40:24.261Z\",\n \"IDAccountsPayableReceivableLog\": 1158,\n \"RecordUserCreated\": 6923,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8026,\n \"ValueRatio\": 564.1893984056168,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 1069.4514309754145\n },\n {\n \"IDTypeCostCenter\": 3279,\n \"ValueRatio\": 5148.065389652452,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 9314.932587597365\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5866,\n \"DateDue\": \"1961-12-10\",\n \"DateDocument\": \"1982-03-31\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1201,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1129,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4570.6388750568985,\n \"ValueDiscount\": 977.3647920324313,\n \"ValueInterest\": 3438.931049781051,\n \"ValuePenalty\": 7668.033957912557,\n \"ValueTotal\": 6037.9501487119505\n },\n {\n \"IDAccountPayableReceivable\": 1764,\n \"DateDue\": \"2020-10-11\",\n \"DateDocument\": \"2014-02-04\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 4,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3991,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 275,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 3896.0820107411378,\n \"ValueDiscount\": 6122.255913434556,\n \"ValueInterest\": 1287.9540698697301,\n \"ValuePenalty\": 9974.39924045227,\n \"ValueTotal\": 5680.230438760188\n }\n ]\n },\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"2018-02-21\",\n \"DateDocument\": \"1951-10-09\",\n \"DateDue\": \"2004-03-02\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 8158,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDSupplier\": 2745,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 834,\n \"IDTypeDocument\": 3291,\n \"IDTypePayment\": 8441,\n \"RecordTimestamp\": \"2009-02-26T15:02:14.630Z\",\n \"Scheduled\": 893,\n \"Value\": 397.2176560674434,\n \"IDBankAccountForecast\": 6304,\n \"IDOrder\": 8896,\n \"IDCompanyInvoice\": 321,\n \"IDAccountPayableReceivableMain\": 8310,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 6849,\n \"ValueDiscount\": 2034.1943617266134,\n \"ValueInterest\": 1938.1925946563072,\n \"ValuePenalty\": 5561.8893387304815,\n \"ValueTotal\": 3179.3963802796357,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4166,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 6287.974409699042,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1989-11-20T15:32:23.070Z\",\n \"IDFile\": 1178,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 1113,\n \"IDAccountPayableReceivable\": 6288\n },\n {\n \"RecordTimestamp\": \"1992-07-22T17:52:07.961Z\",\n \"IDFile\": 791,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3033,\n \"IDAccountPayableReceivable\": 9996\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1964-07-14T21:45:05.761Z\",\n \"IDBankAccount\": 9033,\n \"IDBankStatement\": 7317,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 4676.052006537017,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2017-11-29T06:04:22.047Z\",\n \"IDBankAccount\": 3388,\n \"IDBankStatement\": 9296,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3141.052445785759,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2004-04-11T17:03:23.909Z\",\n \"IDAccountsPayableReceivableLog\": 4819,\n \"RecordUserCreated\": 8343,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2014-12-29T21:41:50.184Z\",\n \"IDAccountsPayableReceivableLog\": 8931,\n \"RecordUserCreated\": 5831,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8301,\n \"ValueRatio\": 2830.507295234359,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 6332.373455588662\n },\n {\n \"IDTypeCostCenter\": 5943,\n \"ValueRatio\": 1200.226717940378,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 5319.284625304066\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 7502,\n \"DateDue\": \"2023-02-06\",\n \"DateDocument\": \"1979-09-20\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2750,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4405,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5347.455568828732,\n \"ValueDiscount\": 5453.135151328932,\n \"ValueInterest\": 6040.408228916954,\n \"ValuePenalty\": 4801.921213503684,\n \"ValueTotal\": 1534.2528103216323\n },\n {\n \"IDAccountPayableReceivable\": 1632,\n \"DateDue\": \"2026-07-11\",\n \"DateDocument\": \"2009-03-05\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4020,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 5514,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 710.2316277363263,\n \"ValueDiscount\": 8213.50359557087,\n \"ValueInterest\": 6273.813840735523,\n \"ValuePenalty\": 8493.882845758524,\n \"ValueTotal\": 212.41121980746237\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7153746-203b-4339-8ce9-31d6d5670912", "name": "Conta a pagar não encontrada para a empresa. Corpo vazio.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeFile", "value": "8" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo a ser anexado.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb909a76-6815-4d32-8c38-f80c6c9bca17", "name": "Baixa um arquivo anexado à conta a pagar", "request": { "name": "Baixa um arquivo anexado à conta a pagar", "description": { "content": "Serve o arquivo diretamente do S3. A implementação não foi localizada localmente — comportamento inferido a partir das URLs geradas em `accountsPayableGet`. Aceita `View=1` e `token` como query params conforme o link gerado.\n\n⚠️ *Sistema não confirmado em código.*", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file", ":idfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "View", "value": "1", "description": "Quando `1`, serve o arquivo para visualização no browser." }, { "disabled": false, "key": "token", "value": "string", "description": "Token de autenticação (alternativa ao header `Authorization` para uso em links diretos)." }, { "disabled": false, "key": "File", "value": "string", "description": "Parâmetro de roteamento interno gerado pelo sistema." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idfile", "description": "(Required) Identificador do arquivo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "91f74f5e-bd56-49be-93ce-a020d41230af", "name": "Conteúdo binário do arquivo.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file", ":idfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "View", "value": "1" }, { "key": "token", "value": "string" }, { "key": "File", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idfile", "description": "(Required) Identificador do arquivo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68dc3ab7-df1d-4619-ad22-93fd40b234e1", "name": "Remove um arquivo anexado à conta a pagar", "request": { "name": "Remove um arquivo anexado à conta a pagar", "description": { "content": "Exclui o arquivo do banco e retorna a conta a pagar atualizada.", "type": "text/plain" }, "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file", ":idfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idfile", "description": "(Required) Identificador do arquivo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "8fe7879b-7a40-49d9-9bf2-ad203b315c09", "name": "Arquivo removido. Retorna a conta a pagar atualizada.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file", ":idfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idfile", "description": "(Required) Identificador do arquivo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"1950-12-01\",\n \"DateDocument\": \"2020-10-17\",\n \"DateDue\": \"1989-03-04\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 5151,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDSupplier\": 5671,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 8962,\n \"IDTypeDocument\": 6895,\n \"IDTypePayment\": 144,\n \"RecordTimestamp\": \"1984-12-24T10:49:41.733Z\",\n \"Scheduled\": 6488,\n \"Value\": 7747.086358194173,\n \"IDBankAccountForecast\": 1207,\n \"IDOrder\": 8062,\n \"IDCompanyInvoice\": 3408,\n \"IDAccountPayableReceivableMain\": 2243,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 8220,\n \"ValueDiscount\": 3503.6211823212593,\n \"ValueInterest\": 5499.184644781916,\n \"ValuePenalty\": 7617.315059980647,\n \"ValueTotal\": 1544.6826920478584,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 6912,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 1,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 1480.8493580518766,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1987-08-25T01:59:04.324Z\",\n \"IDFile\": 5,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7682,\n \"IDAccountPayableReceivable\": 121\n },\n {\n \"RecordTimestamp\": \"1956-01-22T15:04:06.694Z\",\n \"IDFile\": 3116,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6288,\n \"IDAccountPayableReceivable\": 9\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1949-01-25T09:24:47.277Z\",\n \"IDBankAccount\": 4292,\n \"IDBankStatement\": 4996,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8035.369836951742,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1984-07-15T06:37:50.736Z\",\n \"IDBankAccount\": 4940,\n \"IDBankStatement\": 1557,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2976.162400802511,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2003-09-14T07:42:41.802Z\",\n \"IDAccountsPayableReceivableLog\": 7076,\n \"RecordUserCreated\": 7517,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2023-05-13T09:40:24.261Z\",\n \"IDAccountsPayableReceivableLog\": 1158,\n \"RecordUserCreated\": 6923,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8026,\n \"ValueRatio\": 564.1893984056168,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 1069.4514309754145\n },\n {\n \"IDTypeCostCenter\": 3279,\n \"ValueRatio\": 5148.065389652452,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 9314.932587597365\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 5866,\n \"DateDue\": \"1961-12-10\",\n \"DateDocument\": \"1982-03-31\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1201,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1129,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4570.6388750568985,\n \"ValueDiscount\": 977.3647920324313,\n \"ValueInterest\": 3438.931049781051,\n \"ValuePenalty\": 7668.033957912557,\n \"ValueTotal\": 6037.9501487119505\n },\n {\n \"IDAccountPayableReceivable\": 1764,\n \"DateDue\": \"2020-10-11\",\n \"DateDocument\": \"2014-02-04\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 4,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 3991,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 275,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 3896.0820107411378,\n \"ValueDiscount\": 6122.255913434556,\n \"ValueInterest\": 1287.9540698697301,\n \"ValuePenalty\": 9974.39924045227,\n \"ValueTotal\": 5680.230438760188\n }\n ]\n },\n {\n \"Comments\": \"string\",\n \"DateCompetence\": \"2018-02-21\",\n \"DateDocument\": \"1951-10-09\",\n \"DateDue\": \"2004-03-02\",\n \"DocumentNumber\": \"string\",\n \"IDAccountPayableReceivable\": 8158,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDSupplier\": 2745,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 834,\n \"IDTypeDocument\": 3291,\n \"IDTypePayment\": 8441,\n \"RecordTimestamp\": \"2009-02-26T15:02:14.630Z\",\n \"Scheduled\": 893,\n \"Value\": 397.2176560674434,\n \"IDBankAccountForecast\": 6304,\n \"IDOrder\": 8896,\n \"IDCompanyInvoice\": 321,\n \"IDAccountPayableReceivableMain\": 8310,\n \"StatusAccountPayableReceivable\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"Forecast\": 6849,\n \"ValueDiscount\": 2034.1943617266134,\n \"ValueInterest\": 1938.1925946563072,\n \"ValuePenalty\": 5561.8893387304815,\n \"ValueTotal\": 3179.3963802796357,\n \"TypeAccountPaybleDescription\": \"string\",\n \"TypeDocument\": \"string\",\n \"TypePaymentDescription\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDConsumer\": 4166,\n \"ConsumerNameCorporateName\": \"string\",\n \"DocumentPdf\": 0,\n \"DocumentXml\": 0,\n \"DocumentBankSlip\": 0,\n \"DocumentPayment\": 1,\n \"TotalvNF\": 6287.974409699042,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"Files\": [\n {\n \"RecordTimestamp\": \"1989-11-20T15:32:23.070Z\",\n \"IDFile\": 1178,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 1113,\n \"IDAccountPayableReceivable\": 6288\n },\n {\n \"RecordTimestamp\": \"1992-07-22T17:52:07.961Z\",\n \"IDFile\": 791,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3033,\n \"IDAccountPayableReceivable\": 9996\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1964-07-14T21:45:05.761Z\",\n \"IDBankAccount\": 9033,\n \"IDBankStatement\": 7317,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 4676.052006537017,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2017-11-29T06:04:22.047Z\",\n \"IDBankAccount\": 3388,\n \"IDBankStatement\": 9296,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3141.052445785759,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"2004-04-11T17:03:23.909Z\",\n \"IDAccountsPayableReceivableLog\": 4819,\n \"RecordUserCreated\": 8343,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2014-12-29T21:41:50.184Z\",\n \"IDAccountsPayableReceivableLog\": 8931,\n \"RecordUserCreated\": 5831,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 8301,\n \"ValueRatio\": 2830.507295234359,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 6332.373455588662\n },\n {\n \"IDTypeCostCenter\": 5943,\n \"ValueRatio\": 1200.226717940378,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 5319.284625304066\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 7502,\n \"DateDue\": \"2023-02-06\",\n \"DateDocument\": \"1979-09-20\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 5,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2750,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4405,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5347.455568828732,\n \"ValueDiscount\": 5453.135151328932,\n \"ValueInterest\": 6040.408228916954,\n \"ValuePenalty\": 4801.921213503684,\n \"ValueTotal\": 1534.2528103216323\n },\n {\n \"IDAccountPayableReceivable\": 1632,\n \"DateDue\": \"2026-07-11\",\n \"DateDocument\": \"2009-03-05\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4020,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 5514,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 710.2316277363263,\n \"ValueDiscount\": 8213.50359557087,\n \"ValueInterest\": 6273.813840735523,\n \"ValuePenalty\": 8493.882845758524,\n \"ValueTotal\": 212.41121980746237\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b188773b-8d9f-41ea-8624-3f0c27842534", "name": "Arquivo não encontrado para esta conta.", "originalRequest": { "url": { "path": [ "accounts", "payable", ":idaccountpayable", "file", ":idfile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayable", "description": "(Required) Identificador da conta a pagar." }, { "disabled": false, "type": "any", "value": "2232", "key": "idfile", "description": "(Required) Identificador do arquivo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0908e2b0-016e-4248-aa8d-172ced3caa6e", "name": "Contas a Receber", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "66f70927-4195-41f8-8ad1-d4a62966d513", "name": "Lista contas a receber", "request": { "name": "Lista contas a receber", "description": { "content": "Retorna as contas a receber da empresa, com totais calculados — valor total `ValueTotal`, valor pago `ValuePaid`, saldo pendente `ValuePaymentPending`. Cada item traz também dados resolvidos do pedido associado, da nota fiscal de origem (quando há) e da integração. Aceita filtros por data, valor, status, cliente, fornecedor, plano de contas, tipo de documento, tipo de pagamento, conta bancária, pedido, adquirente (`TID`/`NSU`) e mais. Paginação por `Page` (4000 itens por página).\n\nQuando a parametrização **Permitir visualizar registros apenas fornecedores vinculados ao usuário** da empresa está ativa, os resultados são restritos às categorias de fornecedor vinculadas ao usuário autenticado.\n\nUse `IDTypeEntity=1` para trazer apenas títulos com cliente (cobrança) e `IDTypeEntity=2` para apenas títulos com fornecedor (devolução ou estorno).", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "0", "description": "Página (cada página tem 4000 itens)." }, { "disabled": false, "key": "IDAccountPayableReceivable", "value": "string", "description": "Filtra por um ou mais ids da conta a receber (lista separada por vírgula)." }, { "disabled": false, "key": "IDStatusAccountPayableReceivable", "value": "0,1,2,3,5", "description": "Filtro de status (lista separada por vírgula). Valores: 0=Aberto, 1=Vencido, 2=Pago, 3=Pago Parcialmente, 4=Não lançado, 5=Pago com acréscimo, 6=Vence hoje. Default `0,1,2,3,5` (omite Pago, Não lançado e Vence hoje)." }, { "disabled": false, "key": "IDConsumer", "value": "2232", "description": "Filtra por cliente." }, { "disabled": false, "key": "IDSupplier", "value": "2232", "description": "Filtra por fornecedor (caso de devolução/estorno em contas a receber)." }, { "disabled": false, "key": "ConsumerNameCorporateName", "value": "string", "description": "Filtra pelo nome ou razão social do cliente (ou do fornecedor, quando o título é de fornecedor)." }, { "disabled": false, "key": "IDTypeEntity", "value": "1", "description": "Restringe ao tipo: `1` apenas com cliente, `2` apenas com fornecedor." }, { "disabled": false, "key": "DocumentNumber", "value": "string", "description": "Filtra pelo número do documento." }, { "disabled": false, "key": "NfeNumber", "value": "2232", "description": "Filtra pelo número da nota fiscal de origem." }, { "disabled": false, "key": "IDTypeAccountPayableReceivable", "value": "2232", "description": "Filtra por plano de contas." }, { "disabled": false, "key": "IDTypePayment", "value": "2232", "description": "Filtra por tipo de pagamento." }, { "disabled": false, "key": "IDTypeDocument", "value": "2232", "description": "Filtra por tipo de documento." }, { "disabled": false, "key": "IDOrder", "value": "2232", "description": "Filtra pelo identificador interno do pedido associado." }, { "disabled": false, "key": "Order", "value": "string", "description": "Filtra pelo número externo do pedido (ex.: `OT-1234`, `ML-5678`)." }, { "disabled": false, "key": "OrderFrom", "value": "string", "description": "Filtra por pedido de origem (lista de canais de venda associados ao pedido)." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra pela empresa faturadora." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "Filtra pela integração originadora do título (marketplace, adquirente, ERP)." }, { "disabled": false, "key": "IDBankAccountForecast", "value": "2232", "description": "Filtra pela conta bancária prevista para recebimento." }, { "disabled": false, "key": "IDBankAccount", "value": "2232", "description": "Filtra pela conta bancária onde o pagamento já foi lançado." }, { "disabled": false, "key": "TID", "value": "string", "description": "Filtra pelo TID (identificador da transação do adquirente)." }, { "disabled": false, "key": "NSU", "value": "string", "description": "Filtra pelo NSU (identificador sequencial único do adquirente)." }, { "disabled": false, "key": "TIDorNSU", "value": "string", "description": "Procura o mesmo valor em `TID` **ou** `NSU` (cláusula `OR`). Use quando o usuário não sabe a origem do identificador." }, { "disabled": false, "key": "NSUorTID", "value": "string", "description": "Alias adicional ao filtro `TIDorNSU` — combinado a ele, expande o `OR` para um segundo par de valores." }, { "disabled": false, "key": "ValueFrom", "value": "478.75460817372374", "description": "Valor total mínimo (`Value + ValuePenalty + ValueInterest - ValueDiscount`)." }, { "disabled": false, "key": "ValueTo", "value": "478.75460817372374", "description": "Valor total máximo." }, { "disabled": false, "key": "DateDueFrom", "value": "1980-02-08", "description": "Vencimento a partir de." }, { "disabled": false, "key": "DateDueTo", "value": "1980-02-08", "description": "Vencimento até." }, { "disabled": false, "key": "DateDocumentFrom", "value": "1980-02-08", "description": "Data do documento a partir de." }, { "disabled": false, "key": "DateDocumentTo", "value": "1980-02-08", "description": "Data do documento até." }, { "disabled": false, "key": "DateCompetenceFrom", "value": "1980-02-08", "description": "Competência a partir de." }, { "disabled": false, "key": "DateCompetenceTo", "value": "1980-02-08", "description": "Competência até." }, { "disabled": false, "key": "DateLastPaymentFrom", "value": "1980-02-08", "description": "Data do último pagamento a partir de." }, { "disabled": false, "key": "DateLastPaymentTo", "value": "1980-02-08", "description": "Data do último pagamento até (inclusivo até 23:59)." }, { "disabled": false, "key": "DateRecordTimestampFrom", "value": "1980-02-08", "description": "Data de cadastro do registro a partir de." }, { "disabled": false, "key": "DateRecordTimestampTo", "value": "1980-02-08", "description": "Data de cadastro do registro até (inclusivo até 23:59)." }, { "disabled": false, "key": "InvoiceDateFrom", "value": "1980-02-08", "description": "Data de emissão da nota fiscal de origem a partir de." }, { "disabled": false, "key": "InvoiceDateTo", "value": "1980-02-08", "description": "Data de emissão da nota fiscal de origem até (inclusivo até 23:59:59)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a9a5687e-90c2-421e-8d03-99eac891b0d3", "name": "Lista de contas a receber com totais calculados (vazia quando o usuário não tem acesso pela parametrização de governança ou não há matches).", "originalRequest": { "url": { "path": [ "accounts", "receivable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "IDAccountPayableReceivable", "value": "string" }, { "key": "IDStatusAccountPayableReceivable", "value": "0,1,2,3,5" }, { "key": "IDConsumer", "value": "2232" }, { "key": "IDSupplier", "value": "2232" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "IDTypeEntity", "value": "1" }, { "key": "DocumentNumber", "value": "string" }, { "key": "NfeNumber", "value": "2232" }, { "key": "IDTypeAccountPayableReceivable", "value": "2232" }, { "key": "IDTypePayment", "value": "2232" }, { "key": "IDTypeDocument", "value": "2232" }, { "key": "IDOrder", "value": "2232" }, { "key": "Order", "value": "string" }, { "key": "OrderFrom", "value": "string" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDBankAccountForecast", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "TID", "value": "string" }, { "key": "NSU", "value": "string" }, { "key": "TIDorNSU", "value": "string" }, { "key": "NSUorTID", "value": "string" }, { "key": "ValueFrom", "value": "478.75460817372374" }, { "key": "ValueTo", "value": "478.75460817372374" }, { "key": "DateDueFrom", "value": "1980-02-08" }, { "key": "DateDueTo", "value": "1980-02-08" }, { "key": "DateDocumentFrom", "value": "1980-02-08" }, { "key": "DateDocumentTo", "value": "1980-02-08" }, { "key": "DateCompetenceFrom", "value": "1980-02-08" }, { "key": "DateCompetenceTo", "value": "1980-02-08" }, { "key": "DateLastPaymentFrom", "value": "1980-02-08" }, { "key": "DateLastPaymentTo", "value": "1980-02-08" }, { "key": "DateRecordTimestampFrom", "value": "1980-02-08" }, { "key": "DateRecordTimestampTo", "value": "1980-02-08" }, { "key": "InvoiceDateFrom", "value": "1980-02-08" }, { "key": "InvoiceDateTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 500,\n \"IDStatusAccountPayableReceivable\": 2,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2021-12-02\",\n \"DateDocument\": \"2021-02-23\",\n \"DateDue\": \"1954-12-18\",\n \"DateLastPayment\": \"1986-06-27T18:16:19.443Z\",\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"1951-03-23T23:35:08.233Z\",\n \"IDConsumer\": 2147,\n \"IDSupplier\": 7724,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 9163,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 1136,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 4416,\n \"TypePaymentDescription\": \"string\",\n \"TypePaymentCategory\": \"string\",\n \"IDOrder\": 135,\n \"Order\": \"string\",\n \"OrderFrom\": \"string\",\n \"IDStatusOrder\": 1088,\n \"OrderFinishConfirmation\": 8420,\n \"ValueOrder\": 399.1610978972937,\n \"Installment\": 8140,\n \"InstallmentTotal\": 782,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"NfeNumber\": 9460,\n \"NfeChaveAcesso\": \"string\",\n \"NfeDhEmi\": \"1988-02-25T09:48:53.792Z\",\n \"IDBankAccountForecast\": 2628,\n \"BankForecast\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"BankPayment\": \"string\",\n \"DaysDue\": 8366,\n \"Value\": 3877.318925358895,\n \"ValueDiscount\": 9823.161728822934,\n \"ValueInterest\": 8252.325298887861,\n \"ValuePenalty\": 1393.2089614195852,\n \"ValueTotal\": 8741.779618028198,\n \"ValuePaid\": 6210.84061162287,\n \"ValuePaymentPending\": 6828.368035034078,\n \"IDCompanyInvoice\": 5621,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 3918,\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2020-01-03\",\n \"DateDocument\": \"2008-08-06\",\n \"DateDue\": \"1952-08-27\",\n \"DateLastPayment\": \"2011-09-12T23:36:45.620Z\",\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"1953-02-01T15:20:36.726Z\",\n \"IDConsumer\": 1813,\n \"IDSupplier\": 164,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 1096,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 8736,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 3022,\n \"TypePaymentDescription\": \"string\",\n \"TypePaymentCategory\": \"string\",\n \"IDOrder\": 7655,\n \"Order\": \"string\",\n \"OrderFrom\": \"string\",\n \"IDStatusOrder\": 3644,\n \"OrderFinishConfirmation\": 6046,\n \"ValueOrder\": 7597.186800295792,\n \"Installment\": 1001,\n \"InstallmentTotal\": 2355,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"NfeNumber\": 3680,\n \"NfeChaveAcesso\": \"string\",\n \"NfeDhEmi\": \"1988-05-06T21:39:03.352Z\",\n \"IDBankAccountForecast\": 7945,\n \"BankForecast\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"BankPayment\": \"string\",\n \"DaysDue\": 7820,\n \"Value\": 9866.395417607318,\n \"ValueDiscount\": 7704.521499631179,\n \"ValueInterest\": 2769.9834496644103,\n \"ValuePenalty\": 693.8947465684997,\n \"ValueTotal\": 9773.897805549293,\n \"ValuePaid\": 3894.647854756157,\n \"ValuePaymentPending\": 9334.100701960533,\n \"IDCompanyInvoice\": 2414,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyIntegration\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d677a775-fa58-4caa-a788-131955ce87da", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "receivable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "IDAccountPayableReceivable", "value": "string" }, { "key": "IDStatusAccountPayableReceivable", "value": "0,1,2,3,5" }, { "key": "IDConsumer", "value": "2232" }, { "key": "IDSupplier", "value": "2232" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "IDTypeEntity", "value": "1" }, { "key": "DocumentNumber", "value": "string" }, { "key": "NfeNumber", "value": "2232" }, { "key": "IDTypeAccountPayableReceivable", "value": "2232" }, { "key": "IDTypePayment", "value": "2232" }, { "key": "IDTypeDocument", "value": "2232" }, { "key": "IDOrder", "value": "2232" }, { "key": "Order", "value": "string" }, { "key": "OrderFrom", "value": "string" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDBankAccountForecast", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "TID", "value": "string" }, { "key": "NSU", "value": "string" }, { "key": "TIDorNSU", "value": "string" }, { "key": "NSUorTID", "value": "string" }, { "key": "ValueFrom", "value": "478.75460817372374" }, { "key": "ValueTo", "value": "478.75460817372374" }, { "key": "DateDueFrom", "value": "1980-02-08" }, { "key": "DateDueTo", "value": "1980-02-08" }, { "key": "DateDocumentFrom", "value": "1980-02-08" }, { "key": "DateDocumentTo", "value": "1980-02-08" }, { "key": "DateCompetenceFrom", "value": "1980-02-08" }, { "key": "DateCompetenceTo", "value": "1980-02-08" }, { "key": "DateLastPaymentFrom", "value": "1980-02-08" }, { "key": "DateLastPaymentTo", "value": "1980-02-08" }, { "key": "DateRecordTimestampFrom", "value": "1980-02-08" }, { "key": "DateRecordTimestampTo", "value": "1980-02-08" }, { "key": "InvoiceDateFrom", "value": "1980-02-08" }, { "key": "InvoiceDateTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72af8c19-1adf-4f8e-84de-72bfb6285794", "name": "Cria uma conta a receber", "request": { "name": "Cria uma conta a receber", "description": { "content": "Cria uma nova conta a receber. A resposta é a representação completa da conta recém-criada, no mesmo formato de `GET /accounts/receivable/{idaccountreceivable}` (objeto único dentro de array).\n\n**Regras de negócio**:\n- `IDConsumer` e `IDSupplier` não podem ser enviados juntos — apenas um dos dois.\n- Quando `IDCompanyInvoice` é omitido, assume a empresa autenticada.\n- Strings vazias são tratadas como nulas — equivalentes a omitir o campo.\n- Cria sempre como conta de **entrada** (`IDTypeAccount=0`).", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"2020-11-17\",\n \"Value\": 7131.331707110282,\n \"IDTypeDocument\": 1886,\n \"IDTypeAccountPayableReceivable\": 8016,\n \"IDTypePayment\": 9021,\n \"IDConsumer\": 1032,\n \"IDSupplier\": 329,\n \"DateCompetence\": \"1976-08-06\",\n \"DateDocument\": \"1988-02-25\",\n \"DocumentNumber\": \"string\",\n \"Comments\": \"string\",\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"Installment\": 9266,\n \"InstallmentTotal\": 2423,\n \"IDBankAccountForecast\": 7799,\n \"IDCompanyInvoice\": 926,\n \"ValueDiscount\": 9312.431487847052,\n \"ValueInterest\": 557.6868633684828,\n \"ValuePenalty\": 742.9318690168762\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "02200bd8-81fe-4cd7-86cd-5756a6a656a4", "name": "Conta criada. Retorna a representação completa da conta no formato detalhado.", "originalRequest": { "url": { "path": [ "accounts", "receivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"2020-11-17\",\n \"Value\": 7131.331707110282,\n \"IDTypeDocument\": 1886,\n \"IDTypeAccountPayableReceivable\": 8016,\n \"IDTypePayment\": 9021,\n \"IDConsumer\": 1032,\n \"IDSupplier\": 329,\n \"DateCompetence\": \"1976-08-06\",\n \"DateDocument\": \"1988-02-25\",\n \"DocumentNumber\": \"string\",\n \"Comments\": \"string\",\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"Installment\": 9266,\n \"InstallmentTotal\": 2423,\n \"IDBankAccountForecast\": 7799,\n \"IDCompanyInvoice\": 926,\n \"ValueDiscount\": 9312.431487847052,\n \"ValueInterest\": 557.6868633684828,\n \"ValuePenalty\": 742.9318690168762\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 6965,\n \"IDStatusAccountPayableReceivable\": 2,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2020-05-06\",\n \"DateDocument\": \"2002-01-15\",\n \"DateDue\": \"1969-08-24\",\n \"DaysDue\": 118,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2001-04-04T19:07:41.944Z\",\n \"IDConsumer\": 8223,\n \"IDSupplier\": 2090,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 4352,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 2230,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 6719,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 7995,\n \"Order\": \"string\",\n \"IDStatusOrder\": 2454,\n \"OrderFinishConfirmation\": 4369,\n \"IDServiceOrder\": 9690,\n \"Installment\": 7685,\n \"InstallmentTotal\": 199,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 8526,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 3021,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 9029,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 7269.300493853283,\n \"ValueDiscount\": 6257.023534275751,\n \"ValueInterest\": 5760.289984264075,\n \"ValuePenalty\": 4247.391903601283,\n \"ValueTotal\": 900.006126205819,\n \"Files\": [\n {\n \"RecordTimestamp\": \"1948-09-29T09:07:05.535Z\",\n \"IDFile\": 8842,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7079,\n \"IDAccountPayableReceivable\": 663\n },\n {\n \"RecordTimestamp\": \"2023-03-12T15:08:36.049Z\",\n \"IDFile\": 8015,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6455,\n \"IDAccountPayableReceivable\": 2812\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1967-08-29T21:07:32.653Z\",\n \"IDBankAccount\": 906,\n \"IDBankStatement\": 6186,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8235.296195945417,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2011-06-21T10:37:50.613Z\",\n \"IDBankAccount\": 7669,\n \"IDBankStatement\": 4330,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2993.3115988629797,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1949-07-28T19:26:13.622Z\",\n \"IDAccountsPayableReceivableLog\": 5681,\n \"RecordUserCreated\": 3653,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2003-03-29T16:02:26.568Z\",\n \"IDAccountsPayableReceivableLog\": 4881,\n \"RecordUserCreated\": 895,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 2683,\n \"ValueRatio\": 6910.52516019117,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 991.7148069152448\n },\n {\n \"IDTypeCostCenter\": 9060,\n \"ValueRatio\": 4349.266762837689,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8021.739525381196\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 3360,\n \"DateDue\": \"1955-05-10\",\n \"DateDocument\": \"1998-10-21\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 6618,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 8481,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 8865.39785194077,\n \"ValueDiscount\": 920.7747561024537,\n \"ValueInterest\": 4621.697521051727,\n \"ValuePenalty\": 2684.45816134562,\n \"ValueTotal\": 7491.7891814813765\n },\n {\n \"IDAccountPayableReceivable\": 8906,\n \"DateDue\": \"1950-10-20\",\n \"DateDocument\": \"1965-06-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 5206,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 7298,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4238.850498150954,\n \"ValueDiscount\": 6807.597818549742,\n \"ValueInterest\": 8671.242329788933,\n \"ValuePenalty\": 8771.414878259975,\n \"ValueTotal\": 9534.176770272466\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71f2bc6a-6009-40b1-83eb-1dd60b9587b4", "name": "Validação falhou (prefixo `[BadRequest]`). Possíveis mensagens:\n- `Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)`\n- `Empresa não existe`\n- `Cliente não existe` / `Fornecedor não existe`\n- `Faturador não existe`\n- `Type Payment não existe`\n- `Tipo documento não existe` / `Plano de contas não existe`\n- `IDBankAccountForecast não existe`", "originalRequest": { "url": { "path": [ "accounts", "receivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"2020-11-17\",\n \"Value\": 7131.331707110282,\n \"IDTypeDocument\": 1886,\n \"IDTypeAccountPayableReceivable\": 8016,\n \"IDTypePayment\": 9021,\n \"IDConsumer\": 1032,\n \"IDSupplier\": 329,\n \"DateCompetence\": \"1976-08-06\",\n \"DateDocument\": \"1988-02-25\",\n \"DocumentNumber\": \"string\",\n \"Comments\": \"string\",\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"Installment\": 9266,\n \"InstallmentTotal\": 2423,\n \"IDBankAccountForecast\": 7799,\n \"IDCompanyInvoice\": 926,\n \"ValueDiscount\": 9312.431487847052,\n \"ValueInterest\": 557.6868633684828,\n \"ValuePenalty\": 742.9318690168762\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad74a300-4717-460f-9bef-03e96a95e5a2", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "receivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DateDue\": \"2020-11-17\",\n \"Value\": 7131.331707110282,\n \"IDTypeDocument\": 1886,\n \"IDTypeAccountPayableReceivable\": 8016,\n \"IDTypePayment\": 9021,\n \"IDConsumer\": 1032,\n \"IDSupplier\": 329,\n \"DateCompetence\": \"1976-08-06\",\n \"DateDocument\": \"1988-02-25\",\n \"DocumentNumber\": \"string\",\n \"Comments\": \"string\",\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"Installment\": 9266,\n \"InstallmentTotal\": 2423,\n \"IDBankAccountForecast\": 7799,\n \"IDCompanyInvoice\": 926,\n \"ValueDiscount\": 9312.431487847052,\n \"ValueInterest\": 557.6868633684828,\n \"ValuePenalty\": 742.9318690168762\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65c5311b-d22e-4190-bfea-7a60ee49c28b", "name": "Lista conciliações de adquirentes (auditoria de taxas)", "request": { "name": "Lista conciliações de adquirentes (auditoria de taxas)", "description": { "content": "Retorna as conciliações de adquirentes recebidas. Há dois modos de operação:\n\n- **Default (`AuditRate` omitido ou `0`)**: lista as conciliações com seus vínculos a contas a receber e a lançamentos bancários, devolvendo valores brutos (`TotalValue`, `ReceivedValue`), taxas efetivas (`MerchantDiscountRateEffectiveValue`, `AnticipationRateEffectiveValue`) e a sugestão de `IDTypePayment` baseada no tipo de adquirente.\n- **Auditoria (`AuditRate=1`)**: compara as taxas efetivas pagas pelo adquirente com as taxas configuradas em `TypePaymentRate`, calculando os percentuais aplicados, esperados e a diferença em valor. Devolve também um `IDAuditStatus` (1=verde/OK, 2=azul/com prejuízo, 3=amarelo/sem configuração, 4=laranja/taxa configurada não aplicada, 5=vermelho/diferença grande). Use `IDAuditStatus` para filtrar apenas conciliações com determinado resultado de auditoria.\n\nPaginação por `Page` (5000 itens por página).", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", "conciliation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "0", "description": "Página (cada página tem 5000 itens)." }, { "disabled": false, "key": "AuditRate", "value": "1", "description": "Quando `1`, ativa o modo de auditoria de taxas — a resposta usa `AccountsReceivableConciliationAuditItem`." }, { "disabled": false, "key": "IDAuditStatus", "value": "string", "description": "Filtra por resultado de auditoria (apenas quando `AuditRate=1`). Lista separada por vírgula. Valores: 1=verde, 2=azul, 3=amarelo, 4=laranja, 5=vermelho." }, { "disabled": false, "key": "IDAccountsPayableReceivableConciliation", "value": "2232", "description": "Filtra por identificador único da conciliação." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "Filtra pela integração adquirente." }, { "disabled": false, "key": "IDTypePaymentFrom", "value": "2232", "description": "Filtra pelo tipo de pagamento do adquirente (`TypeAcquirerPayment`)." }, { "disabled": false, "key": "IDOrder", "value": "2232", "description": "Filtra pelo pedido vinculado a alguma conta a receber conciliada (não aplicável quando `AuditRate=1`)." }, { "disabled": false, "key": "TID", "value": "string", "description": "Filtra pelo TID da conciliação." }, { "disabled": false, "key": "NSU", "value": "string", "description": "Filtra pelo NSU da conciliação." }, { "disabled": false, "key": "ExternalIDOrderReference", "value": "string", "description": "Filtra pela referência externa do pedido enviada pelo adquirente." }, { "disabled": false, "key": "Status", "value": "2232", "description": "Filtra pelo status retornado pelo adquirente (`IDTypeAcquirerStatus`). Ex.: 1=Pagamento, 3=Devolução, 4=Chargeback." }, { "disabled": false, "key": "ConciliationStatus", "value": "4", "description": "Status de conciliação interno: 1=Não conciliado, 2=Conciliação automática, 3=Conciliação manual, 4=Conciliação parcial (não aplicável quando `AuditRate=1`)." }, { "disabled": false, "key": "ReceivableIDBank", "value": "string", "description": "Filtra pelo banco em que o adquirente liberou o valor." }, { "disabled": false, "key": "IDTypeAcquirerReleaseType", "value": "2232", "description": "Filtra pelo tipo de liberação do adquirente." }, { "disabled": false, "key": "SaleDateFrom", "value": "1980-02-08", "description": "Data da venda a partir de." }, { "disabled": false, "key": "SaleDateTo", "value": "1980-02-08", "description": "Data da venda até. Default `4000-01-01` (sem limite superior)." }, { "disabled": false, "key": "ReceivedDateFrom", "value": "1980-02-08", "description": "Data de recebimento a partir de." }, { "disabled": false, "key": "ReceivedDateTo", "value": "1980-02-08", "description": "Data de recebimento até. Default `4000-01-01` (sem limite superior)." }, { "disabled": false, "key": "RecordTimestampFrom", "value": "1980-02-08", "description": "Data de cadastro do registro a partir de." }, { "disabled": false, "key": "RecordTimestampTo", "value": "1980-02-08", "description": "Data de cadastro do registro até (inclusivo até 23:59:59)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "19a526b8-38c2-44f6-945a-7ffa9d8a7389", "name": "Lista de conciliações. O schema do item depende de `AuditRate`.", "originalRequest": { "url": { "path": [ "accounts", "receivable", "conciliation" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "AuditRate", "value": "1" }, { "key": "IDAuditStatus", "value": "string" }, { "key": "IDAccountsPayableReceivableConciliation", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDTypePaymentFrom", "value": "2232" }, { "key": "IDOrder", "value": "2232" }, { "key": "TID", "value": "string" }, { "key": "NSU", "value": "string" }, { "key": "ExternalIDOrderReference", "value": "string" }, { "key": "Status", "value": "2232" }, { "key": "ConciliationStatus", "value": "4" }, { "key": "ReceivableIDBank", "value": "string" }, { "key": "IDTypeAcquirerReleaseType", "value": "2232" }, { "key": "SaleDateFrom", "value": "1980-02-08" }, { "key": "SaleDateTo", "value": "1980-02-08" }, { "key": "ReceivedDateFrom", "value": "1980-02-08" }, { "key": "ReceivedDateTo", "value": "1980-02-08" }, { "key": "RecordTimestampFrom", "value": "1980-02-08" }, { "key": "RecordTimestampTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDAccountsPayableReceivableConciliation\": 5764,\n \"AccountName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"IDCompanyIntegration\": 7520,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ExternalIDOrderReference\": \"string\",\n \"Installment\": 8383,\n \"InstallmentTotal\": 215,\n \"SaleDate\": \"2013-12-23\",\n \"ReceivedDate\": \"2001-12-29\",\n \"RecordTimestamp\": \"2021-03-13T23:02:06.139Z\",\n \"TotalValue\": 3480.4865538554463,\n \"ReceivedValue\": 5397.837711297786,\n \"MerchantDiscountRateEffectiveValue\": 3344.782313853301,\n \"MerchantDiscountRateEffectiveValueRate\": 6178.604469986833,\n \"AnticipationRateEffectiveValue\": 757.4760525876756,\n \"AnticipationRateEffectiveValueRate\": 345.4914275990695,\n \"IDTypePaymentFrom\": 3672,\n \"TypePayment\": \"string\",\n \"IDTypeAcquirerReleaseType\": 2341,\n \"ReceivableIDBankAccount\": 6033,\n \"Bank\": \"string\",\n \"Status\": 2626,\n \"TypeAcquirerStatus\": \"string\",\n \"ConciliationStatus\": 1,\n \"AutomaticReceivableAnticipation\": 945,\n \"Comments\": \"string\",\n \"IDAccountPayableReceivable\": \"string\",\n \"IDOrder\": \"string\"\n },\n {\n \"IDAccountsPayableReceivableConciliation\": 6326,\n \"AccountName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"IDCompanyIntegration\": 6656,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ExternalIDOrderReference\": \"string\",\n \"Installment\": 8851,\n \"InstallmentTotal\": 8185,\n \"SaleDate\": \"1952-12-08\",\n \"ReceivedDate\": \"1996-12-07\",\n \"RecordTimestamp\": \"1980-09-12T15:05:25.320Z\",\n \"TotalValue\": 7859.356109517162,\n \"ReceivedValue\": 8889.709634263829,\n \"MerchantDiscountRateEffectiveValue\": 8295.486350612953,\n \"MerchantDiscountRateEffectiveValueRate\": 5166.209129981578,\n \"AnticipationRateEffectiveValue\": 9372.137281132722,\n \"AnticipationRateEffectiveValueRate\": 3900.221620600661,\n \"IDTypePaymentFrom\": 9313,\n \"TypePayment\": \"string\",\n \"IDTypeAcquirerReleaseType\": 3886,\n \"ReceivableIDBankAccount\": 6100,\n \"Bank\": \"string\",\n \"Status\": 5737,\n \"TypeAcquirerStatus\": \"string\",\n \"ConciliationStatus\": 4,\n \"AutomaticReceivableAnticipation\": 7967,\n \"Comments\": \"string\",\n \"IDAccountPayableReceivable\": \"string\",\n \"IDOrder\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15c86014-d013-4052-b142-fbe3a884f62c", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "receivable", "conciliation" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "AuditRate", "value": "1" }, { "key": "IDAuditStatus", "value": "string" }, { "key": "IDAccountsPayableReceivableConciliation", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDTypePaymentFrom", "value": "2232" }, { "key": "IDOrder", "value": "2232" }, { "key": "TID", "value": "string" }, { "key": "NSU", "value": "string" }, { "key": "ExternalIDOrderReference", "value": "string" }, { "key": "Status", "value": "2232" }, { "key": "ConciliationStatus", "value": "4" }, { "key": "ReceivableIDBank", "value": "string" }, { "key": "IDTypeAcquirerReleaseType", "value": "2232" }, { "key": "SaleDateFrom", "value": "1980-02-08" }, { "key": "SaleDateTo", "value": "1980-02-08" }, { "key": "ReceivedDateFrom", "value": "1980-02-08" }, { "key": "ReceivedDateTo", "value": "1980-02-08" }, { "key": "RecordTimestampFrom", "value": "1980-02-08" }, { "key": "RecordTimestampTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abe92a6f-5789-4c61-aa82-a82ba60d0ed3", "name": "Atualiza observações de uma conciliação", "request": { "name": "Atualiza observações de uma conciliação", "description": { "content": "Atualiza apenas o campo `Comments` da conciliação. Demais campos da conciliação não podem ser alterados por esta rota. A resposta é a conciliação atualizada no mesmo formato da listagem default.", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", "conciliation", ":idaccountspayablereceivableconciliation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountspayablereceivableconciliation", "description": "(Required) Identificador da conciliação de adquirente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "47579766-3bf7-464a-bc08-1c0139838a5f", "name": "Conciliação atualizada. Retorna a conciliação no mesmo formato de `GET /accounts/receivable/conciliation`.", "originalRequest": { "url": { "path": [ "accounts", "receivable", "conciliation", ":idaccountspayablereceivableconciliation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountspayablereceivableconciliation", "description": "(Required) Identificador da conciliação de adquirente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDAccountsPayableReceivableConciliation\": 6046,\n \"AccountName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"IDCompanyIntegration\": 8968,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ExternalIDOrderReference\": \"string\",\n \"Installment\": 2779,\n \"InstallmentTotal\": 2308,\n \"SaleDate\": \"2003-12-14\",\n \"ReceivedDate\": \"2000-02-03\",\n \"RecordTimestamp\": \"1969-06-13T11:29:05.186Z\",\n \"TotalValue\": 8932.019627099584,\n \"ReceivedValue\": 8292.082206846368,\n \"MerchantDiscountRateEffectiveValue\": 3498.689602200187,\n \"MerchantDiscountRateEffectiveValueRate\": 2668.090758064363,\n \"AnticipationRateEffectiveValue\": 9567.187610248604,\n \"AnticipationRateEffectiveValueRate\": 7689.797220519518,\n \"IDTypePaymentFrom\": 4384,\n \"TypePayment\": \"string\",\n \"IDTypeAcquirerReleaseType\": 3495,\n \"ReceivableIDBankAccount\": 9026,\n \"Bank\": \"string\",\n \"Status\": 8176,\n \"TypeAcquirerStatus\": \"string\",\n \"ConciliationStatus\": 4,\n \"AutomaticReceivableAnticipation\": 4033,\n \"Comments\": \"string\",\n \"IDAccountPayableReceivable\": \"string\",\n \"IDOrder\": \"string\"\n },\n {\n \"IDAccountsPayableReceivableConciliation\": 5091,\n \"AccountName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"IDCompanyIntegration\": 6597,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ExternalIDOrderReference\": \"string\",\n \"Installment\": 1376,\n \"InstallmentTotal\": 3219,\n \"SaleDate\": \"1976-09-27\",\n \"ReceivedDate\": \"1988-10-04\",\n \"RecordTimestamp\": \"1987-08-21T01:24:44.682Z\",\n \"TotalValue\": 4573.2468695699245,\n \"ReceivedValue\": 7409.481640552011,\n \"MerchantDiscountRateEffectiveValue\": 7428.470125811788,\n \"MerchantDiscountRateEffectiveValueRate\": 4628.789506853163,\n \"AnticipationRateEffectiveValue\": 1526.8051731797084,\n \"AnticipationRateEffectiveValueRate\": 33.91821498726966,\n \"IDTypePaymentFrom\": 6906,\n \"TypePayment\": \"string\",\n \"IDTypeAcquirerReleaseType\": 2422,\n \"ReceivableIDBankAccount\": 5174,\n \"Bank\": \"string\",\n \"Status\": 4554,\n \"TypeAcquirerStatus\": \"string\",\n \"ConciliationStatus\": 1,\n \"AutomaticReceivableAnticipation\": 859,\n \"Comments\": \"string\",\n \"IDAccountPayableReceivable\": \"string\",\n \"IDOrder\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8910874f-4371-427e-986c-af836d5ba022", "name": "Conciliação não existe. Mensagem: `[BadRequest] - Conciliação não existe`.", "originalRequest": { "url": { "path": [ "accounts", "receivable", "conciliation", ":idaccountspayablereceivableconciliation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountspayablereceivableconciliation", "description": "(Required) Identificador da conciliação de adquirente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be55391-a922-4dda-aa21-e82b2493f788", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "receivable", "conciliation", ":idaccountspayablereceivableconciliation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountspayablereceivableconciliation", "description": "(Required) Identificador da conciliação de adquirente." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d16c329-8cae-4c17-8199-00c9bfe9a064", "name": "Lista conciliações de marketplace", "request": { "name": "Lista conciliações de marketplace", "description": { "content": "Retorna as conciliações de marketplace, ou seja, os valores liberados por integrações de marketplace para cada pedido — já decompostos em comissão (`MarketplaceFeeValue`), antecipação (`MarketplaceFinancingFeeValue`), frete (`MarketplaceShippingFeeValue`), cupom (`MarketplaceCouponValue`), impostos (`MarketplaceTaxesValue`) e outras taxas (`MarketplaceOtherFeeValue`).\n\nCada item agrupa as contas a receber internas vinculadas (`InternalAccounts`) e soma os valores líquidos em `ERPValueTotal`, permitindo bater o que entrou no banco com o que o marketplace declara.\n\nPaginação por `Page` (5000 itens por página).", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", "marketplace-conciliation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "Filtra pela integração de marketplace." }, { "disabled": false, "key": "IDOrder", "value": "2232", "description": "Filtra pelo pedido interno vinculado (via `HubOrder`)." }, { "disabled": false, "key": "OrderId", "value": "string", "description": "Filtra pelo identificador do pedido no marketplace. A correspondência é exata — não faz busca parcial." }, { "disabled": false, "key": "TID", "value": "string", "description": "Filtra pelo TID da conciliação." }, { "disabled": false, "key": "IDTypeAcquirerStatus", "value": "2232", "description": "Filtra pelo status do marketplace (`IDTypeAcquirerStatus`)." }, { "disabled": false, "key": "IDTypeStatusConciliation", "value": "3", "description": "Filtra pelo status de conciliação: `1` Não conciliado, `2` Conciliado automaticamente, `3` Conciliado manualmente, `4` Conciliado parcialmente, `5` Conciliado por contrapartida." }, { "disabled": false, "key": "Installment", "value": "2232", "description": "Filtra pelo número da parcela." }, { "disabled": false, "key": "InstallmentTotal", "value": "2232", "description": "Filtra pelo total de parcelas." }, { "disabled": false, "key": "SaleDateFrom", "value": "1980-02-08", "description": "Data da venda a partir de." }, { "disabled": false, "key": "SaleDateTo", "value": "1980-02-08", "description": "Data da venda até. Default `4000-01-01`." }, { "disabled": false, "key": "ReceivedDateFrom", "value": "1980-02-08", "description": "Data de recebimento a partir de." }, { "disabled": false, "key": "ReceivedDateTo", "value": "1980-02-08", "description": "Data de recebimento até. Default `4000-01-01`." }, { "disabled": false, "key": "RecordTimestampFrom", "value": "1980-02-08", "description": "Data de criação do registro de conciliação a partir de (inclusive). É esta data que ativa o filtro de período de criação: informar apenas `RecordTimestampTo` não restringe o período." }, { "disabled": false, "key": "RecordTimestampTo", "value": "1980-02-08", "description": "Data de criação do registro de conciliação até, considerando o dia inteiro (até `23:59:59`). Default `4000-01-01` (sem limite superior)." }, { "disabled": false, "key": "Page", "value": "0", "description": "Página dos resultados, começando em `0`. Cada página retorna até 5000 conciliações, ordenadas da data de recebimento mais recente para a mais antiga." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "564a304a-bb38-44f6-89f0-22281124f10b", "name": "Lista de conciliações de marketplace agrupadas, cada uma com suas contas internas vinculadas. O corte de 5.000 de `Page` é aplicado às linhas ANTES do agrupamento: como cada conciliação ocupa uma linha por conta interna vinculada, uma página quase sempre devolve menos de 5.000 conciliações, e uma mesma conciliação pode ficar partida entre duas páginas (parte de `InternalAccounts` numa página e o restante na seguinte).", "originalRequest": { "url": { "path": [ "accounts", "receivable", "marketplace-conciliation" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDOrder", "value": "2232" }, { "key": "OrderId", "value": "string" }, { "key": "TID", "value": "string" }, { "key": "IDTypeAcquirerStatus", "value": "2232" }, { "key": "IDTypeStatusConciliation", "value": "3" }, { "key": "Installment", "value": "2232" }, { "key": "InstallmentTotal", "value": "2232" }, { "key": "SaleDateFrom", "value": "1980-02-08" }, { "key": "SaleDateTo", "value": "1980-02-08" }, { "key": "ReceivedDateFrom", "value": "1980-02-08" }, { "key": "ReceivedDateTo", "value": "1980-02-08" }, { "key": "RecordTimestampFrom", "value": "1980-02-08" }, { "key": "RecordTimestampTo", "value": "1980-02-08" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDAccountsPayableReceivableConciliationMarketplace\": 4201,\n \"RecordTimestamp\": \"2025-09-18T19:35:24.333Z\",\n \"IDCompanyIntegration\": 7402,\n \"CompanyIntegration\": \"string\",\n \"AccountName\": \"string\",\n \"TID\": \"string\",\n \"OrderId\": \"string\",\n \"IDOrder\": 9886,\n \"ShippingId\": \"string\",\n \"Installment\": 5634,\n \"InstallmentTotal\": 77,\n \"SaleDate\": \"1982-09-21\",\n \"ReceivedDate\": \"1997-07-26\",\n \"Comments\": \"string\",\n \"TotalValue\": 8934.50050565006,\n \"ReceivedValue\": 1869.8875060707421,\n \"MarketplaceFeeValue\": 9015.145377355158,\n \"MarketplaceFeePct\": 4300.29946935433,\n \"MarketplaceShippingFeeValue\": 9774.353919845524,\n \"MarketplaceShippingFeePct\": 2098.6671758478524,\n \"MarketplaceFinancingFeeValue\": 4684.9090322179345,\n \"MarketplaceFinancingFeePct\": 7635.487154849361,\n \"MarketplaceTaxesValue\": 4066.403076191991,\n \"MarketplaceTaxesPct\": 7117.86284834409,\n \"MarketplaceCouponValue\": 3878.5640569934167,\n \"MarketplaceCouponPct\": 3899.8980722921538,\n \"MarketplaceCouponCode\": \"string\",\n \"IDTypeAcquirerStatus\": 8577,\n \"TypeAcquirerStatus\": \"string\",\n \"IDTypeStatusConciliation\": 4,\n \"IDAccountsPayableReceivableConciliationMarketplacePair\": 2105,\n \"IDBankAccount\": \"string\",\n \"ValueDifferenceAllow\": 8356.980200171969,\n \"IDAccountPayableReceivable\": 6283,\n \"IDBankStatement\": 9793,\n \"DocumentNumber\": \"string\",\n \"Value\": 3988.1297442424834,\n \"ValueInterest\": 3605.1057122822594,\n \"ValuePenalty\": 8900.151794990046,\n \"ValueDiscount\": 8469.432286665726,\n \"IDTypeAccount\": 1,\n \"InternalAccounts\": [\n {\n \"IDBankStatement\": 9804,\n \"IDAccountPayableReceivable\": 8910,\n \"Document\": \"string\",\n \"Description\": \"string\",\n \"Value\": 6583.348512116027,\n \"IDTypeAccount\": 0\n },\n {\n \"IDBankStatement\": 3780,\n \"IDAccountPayableReceivable\": 235,\n \"Document\": \"string\",\n \"Description\": \"string\",\n \"Value\": 4682.684232800849,\n \"IDTypeAccount\": 1\n }\n ],\n \"ERPValueTotal\": 2742.6204192131377,\n \"MarketplaceOtherFeeValue\": 6190.094769654408,\n \"MarketplaceOtherFeePct\": 43.43438235196784\n },\n {\n \"IDAccountsPayableReceivableConciliationMarketplace\": 8570,\n \"RecordTimestamp\": \"1991-02-18T11:08:46.082Z\",\n \"IDCompanyIntegration\": 2474,\n \"CompanyIntegration\": \"string\",\n \"AccountName\": \"string\",\n \"TID\": \"string\",\n \"OrderId\": \"string\",\n \"IDOrder\": 1148,\n \"ShippingId\": \"string\",\n \"Installment\": 2411,\n \"InstallmentTotal\": 8433,\n \"SaleDate\": \"1993-10-11\",\n \"ReceivedDate\": \"1954-05-25\",\n \"Comments\": \"string\",\n \"TotalValue\": 1397.131229770321,\n \"ReceivedValue\": 4642.621798164246,\n \"MarketplaceFeeValue\": 9875.673265115196,\n \"MarketplaceFeePct\": 5665.798760265743,\n \"MarketplaceShippingFeeValue\": 82.19354823188141,\n \"MarketplaceShippingFeePct\": 1428.9266371405286,\n \"MarketplaceFinancingFeeValue\": 3663.5690786170303,\n \"MarketplaceFinancingFeePct\": 7163.813285094864,\n \"MarketplaceTaxesValue\": 9562.87150599771,\n \"MarketplaceTaxesPct\": 3793.705627274815,\n \"MarketplaceCouponValue\": 1232.9095412977974,\n \"MarketplaceCouponPct\": 9145.996300104482,\n \"MarketplaceCouponCode\": \"string\",\n \"IDTypeAcquirerStatus\": 5053,\n \"TypeAcquirerStatus\": \"string\",\n \"IDTypeStatusConciliation\": 3,\n \"IDAccountsPayableReceivableConciliationMarketplacePair\": 9256,\n \"IDBankAccount\": \"string\",\n \"ValueDifferenceAllow\": 7125.640665427393,\n \"IDAccountPayableReceivable\": 5895,\n \"IDBankStatement\": 9460,\n \"DocumentNumber\": \"string\",\n \"Value\": 3510.998533090188,\n \"ValueInterest\": 2055.5421569972054,\n \"ValuePenalty\": 3500.4062755578125,\n \"ValueDiscount\": 6943.286657367859,\n \"IDTypeAccount\": 0,\n \"InternalAccounts\": [\n {\n \"IDBankStatement\": 4380,\n \"IDAccountPayableReceivable\": 6996,\n \"Document\": \"string\",\n \"Description\": \"string\",\n \"Value\": 5523.855690820008,\n \"IDTypeAccount\": 0\n },\n {\n \"IDBankStatement\": 5816,\n \"IDAccountPayableReceivable\": 3481,\n \"Document\": \"string\",\n \"Description\": \"string\",\n \"Value\": 398.0227836645622,\n \"IDTypeAccount\": 1\n }\n ],\n \"ERPValueTotal\": 4408.590329360282,\n \"MarketplaceOtherFeeValue\": 7377.734075084308,\n \"MarketplaceOtherFeePct\": 2981.4494895149023\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d4efcea-d584-41cf-9bc3-e3dc2bbd5b60", "name": "Detalha uma conta a receber", "request": { "name": "Detalha uma conta a receber", "description": { "content": "Retorna a conta a receber completa: dados próprios, status, cliente ou fornecedor, tipo de documento, tipo de pagamento, plano de contas, banco previsto, integração originadora, lista de pagamentos lançados, arquivos anexados, histórico de alterações, centros de custo rateados e as contas filhas geradas por conciliação (taxa adquirente, comissão de marketplace, etc.).\n\nAtenção: quando o id não existe ou a conta pertence a outra empresa, a resposta é `200` com `[]` (array vazio) — este endpoint não retorna erro para \"não encontrado\".", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "028e8027-a62c-406e-8f2c-a6f2b670c621", "name": "Conta encontrada (objeto único em array) ou array vazio quando não encontrada.", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 6965,\n \"IDStatusAccountPayableReceivable\": 2,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2020-05-06\",\n \"DateDocument\": \"2002-01-15\",\n \"DateDue\": \"1969-08-24\",\n \"DaysDue\": 118,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2001-04-04T19:07:41.944Z\",\n \"IDConsumer\": 8223,\n \"IDSupplier\": 2090,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 4352,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 2230,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 6719,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 7995,\n \"Order\": \"string\",\n \"IDStatusOrder\": 2454,\n \"OrderFinishConfirmation\": 4369,\n \"IDServiceOrder\": 9690,\n \"Installment\": 7685,\n \"InstallmentTotal\": 199,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 8526,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 3021,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 9029,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 7269.300493853283,\n \"ValueDiscount\": 6257.023534275751,\n \"ValueInterest\": 5760.289984264075,\n \"ValuePenalty\": 4247.391903601283,\n \"ValueTotal\": 900.006126205819,\n \"Files\": [\n {\n \"RecordTimestamp\": \"1948-09-29T09:07:05.535Z\",\n \"IDFile\": 8842,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7079,\n \"IDAccountPayableReceivable\": 663\n },\n {\n \"RecordTimestamp\": \"2023-03-12T15:08:36.049Z\",\n \"IDFile\": 8015,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 6455,\n \"IDAccountPayableReceivable\": 2812\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1967-08-29T21:07:32.653Z\",\n \"IDBankAccount\": 906,\n \"IDBankStatement\": 6186,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 8235.296195945417,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"2011-06-21T10:37:50.613Z\",\n \"IDBankAccount\": 7669,\n \"IDBankStatement\": 4330,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 2993.3115988629797,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1949-07-28T19:26:13.622Z\",\n \"IDAccountsPayableReceivableLog\": 5681,\n \"RecordUserCreated\": 3653,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2003-03-29T16:02:26.568Z\",\n \"IDAccountsPayableReceivableLog\": 4881,\n \"RecordUserCreated\": 895,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 2683,\n \"ValueRatio\": 6910.52516019117,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 991.7148069152448\n },\n {\n \"IDTypeCostCenter\": 9060,\n \"ValueRatio\": 4349.266762837689,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8021.739525381196\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 3360,\n \"DateDue\": \"1955-05-10\",\n \"DateDocument\": \"1998-10-21\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 6618,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 8481,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 8865.39785194077,\n \"ValueDiscount\": 920.7747561024537,\n \"ValueInterest\": 4621.697521051727,\n \"ValuePenalty\": 2684.45816134562,\n \"ValueTotal\": 7491.7891814813765\n },\n {\n \"IDAccountPayableReceivable\": 8906,\n \"DateDue\": \"1950-10-20\",\n \"DateDocument\": \"1965-06-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 5206,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 7298,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 4238.850498150954,\n \"ValueDiscount\": 6807.597818549742,\n \"ValueInterest\": 8671.242329788933,\n \"ValuePenalty\": 8771.414878259975,\n \"ValueTotal\": 9534.176770272466\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "969ea1e0-8b75-4a86-81b0-d5e3abf5ebd5", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e687a44e-ba56-46c7-b735-9253334139d9", "name": "Atualiza uma conta a receber", "request": { "name": "Atualiza uma conta a receber", "description": { "content": "Atualiza a conta a receber de forma parcial — apenas os campos enviados são alterados (o `PUT` se comporta como `PATCH`), com duas exceções: `IDTypeDocument` e `IDTypeAccountPayableReceivable` precisam ser enviados e válidos em toda chamada, mesmo quando não estão sendo alterados. A diferença campo a campo é registrada no histórico de alterações da conta.\n\nAtenção: `IDSupplier` também foge da atualização parcial, mas de outro jeito — omitir o campo não preserva o fornecedor atual, ele é gravado como vazio. Para manter o fornecedor de um título que já tem um, reenvie `IDSupplier` em toda chamada. `IDConsumer` não tem esse comportamento: omitido, o cliente é preservado.\n\nQuando `IDSupplier` é enviado, `IDConsumer` é zerado (e vice-versa) — não é possível ter os dois ao mesmo tempo. Alterar a data de vencimento recalcula o prazo `DaysDue` em relação à data de hoje. A resposta é a representação completa da conta atualizada.", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypeDocument\": 9642,\n \"IDTypeAccountPayableReceivable\": 5309,\n \"Comments\": \"string\",\n \"DateCompetence\": \"2013-05-09\",\n \"DateDocument\": \"1951-02-25\",\n \"DateDue\": \"2015-10-21\",\n \"DocumentNumber\": \"string\",\n \"IDConsumer\": 3740,\n \"IDSupplier\": 5185,\n \"IDTypePayment\": 6617,\n \"Value\": 2378.480240195655,\n \"Installment\": 9888,\n \"InstallmentTotal\": 7598,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDBankAccountForecast\": 109,\n \"ValueDiscount\": 6578.716162065123,\n \"ValueInterest\": 5953.278851784867,\n \"ValuePenalty\": 8585.889609044018,\n \"IDCompanyIntegration\": 9745,\n \"IDCompanyInvoice\": 6100,\n \"Forecast\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2ddc27f-99a0-4525-8daf-6041498d4772", "name": "Conta atualizada. Retorna o mesmo formato de `GET /accounts/receivable/{idaccountreceivable}`.", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypeDocument\": 9642,\n \"IDTypeAccountPayableReceivable\": 5309,\n \"Comments\": \"string\",\n \"DateCompetence\": \"2013-05-09\",\n \"DateDocument\": \"1951-02-25\",\n \"DateDue\": \"2015-10-21\",\n \"DocumentNumber\": \"string\",\n \"IDConsumer\": 3740,\n \"IDSupplier\": 5185,\n \"IDTypePayment\": 6617,\n \"Value\": 2378.480240195655,\n \"Installment\": 9888,\n \"InstallmentTotal\": 7598,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDBankAccountForecast\": 109,\n \"ValueDiscount\": 6578.716162065123,\n \"ValueInterest\": 5953.278851784867,\n \"ValuePenalty\": 8585.889609044018,\n \"IDCompanyIntegration\": 9745,\n \"IDCompanyInvoice\": 6100,\n \"Forecast\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 1192,\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"1991-01-12\",\n \"DateDocument\": \"1971-04-18\",\n \"DateDue\": \"2011-03-14\",\n \"DaysDue\": 8311,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2003-08-17T08:26:59.857Z\",\n \"IDConsumer\": 4910,\n \"IDSupplier\": 3551,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 6285,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 5864,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7725,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 5218,\n \"Order\": \"string\",\n \"IDStatusOrder\": 7815,\n \"OrderFinishConfirmation\": 4777,\n \"IDServiceOrder\": 9498,\n \"Installment\": 3746,\n \"InstallmentTotal\": 2548,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 4658,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 1910,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 1211,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 5449.036458719139,\n \"ValueDiscount\": 1318.8424055188764,\n \"ValueInterest\": 3932.708727526937,\n \"ValuePenalty\": 5727.107936322318,\n \"ValueTotal\": 9763.97884403835,\n \"Files\": [\n {\n \"RecordTimestamp\": \"1996-06-05T09:27:22.360Z\",\n \"IDFile\": 7591,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 655,\n \"IDAccountPayableReceivable\": 43\n },\n {\n \"RecordTimestamp\": \"2019-11-25T03:13:13.286Z\",\n \"IDFile\": 9764,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3708,\n \"IDAccountPayableReceivable\": 1781\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1970-07-21T03:23:36.418Z\",\n \"IDBankAccount\": 4552,\n \"IDBankStatement\": 2812,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5499.893903610051,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1999-01-30T23:20:10.599Z\",\n \"IDBankAccount\": 6903,\n \"IDBankStatement\": 2050,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5633.984671975285,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1955-10-30T15:21:21.970Z\",\n \"IDAccountsPayableReceivableLog\": 6920,\n \"RecordUserCreated\": 3011,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2019-10-20T11:36:32.257Z\",\n \"IDAccountsPayableReceivableLog\": 6129,\n \"RecordUserCreated\": 382,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 6029,\n \"ValueRatio\": 6921.138546281458,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8862.628247161609\n },\n {\n \"IDTypeCostCenter\": 7207,\n \"ValueRatio\": 620.724589591899,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8745.770316705099\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 9162,\n \"DateDue\": \"2017-06-10\",\n \"DateDocument\": \"1972-09-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2565,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4018,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5266.978167827554,\n \"ValueDiscount\": 9989.758292120727,\n \"ValueInterest\": 8942.323066714502,\n \"ValuePenalty\": 2453.1420391347992,\n \"ValueTotal\": 6648.225430861172\n },\n {\n \"IDAccountPayableReceivable\": 7685,\n \"DateDue\": \"1980-09-25\",\n \"DateDocument\": \"1979-06-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 1,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 5973,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1072,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 8300.510932607518,\n \"ValueDiscount\": 1347.6672489906227,\n \"ValueInterest\": 8970.62460672871,\n \"ValuePenalty\": 5215.476273913761,\n \"ValueTotal\": 425.07848850579677\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 2243,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2014-12-27\",\n \"DateDocument\": \"1964-12-07\",\n \"DateDue\": \"2016-12-25\",\n \"DaysDue\": 7454,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2013-07-27T20:27:57.139Z\",\n \"IDConsumer\": 7765,\n \"IDSupplier\": 3553,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 9266,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 7933,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 5508,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 828,\n \"Order\": \"string\",\n \"IDStatusOrder\": 2488,\n \"OrderFinishConfirmation\": 7283,\n \"IDServiceOrder\": 1089,\n \"Installment\": 5166,\n \"InstallmentTotal\": 6665,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 1318,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 6234,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 5984,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 8170.583953936956,\n \"ValueDiscount\": 5873.007842017643,\n \"ValueInterest\": 7624.031093756965,\n \"ValuePenalty\": 2048.8932019475683,\n \"ValueTotal\": 5424.827904940806,\n \"Files\": [\n {\n \"RecordTimestamp\": \"2004-01-12T11:45:13.307Z\",\n \"IDFile\": 1882,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3662,\n \"IDAccountPayableReceivable\": 9969\n },\n {\n \"RecordTimestamp\": \"2015-04-04T10:47:05.509Z\",\n \"IDFile\": 3550,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7876,\n \"IDAccountPayableReceivable\": 2908\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1953-07-24T04:10:50.858Z\",\n \"IDBankAccount\": 9709,\n \"IDBankStatement\": 9496,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5593.718230468087,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1969-04-16T13:43:00.322Z\",\n \"IDBankAccount\": 8599,\n \"IDBankStatement\": 2881,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3586.3234411151425,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1963-05-10T21:27:46.378Z\",\n \"IDAccountsPayableReceivableLog\": 2069,\n \"RecordUserCreated\": 4523,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"1986-03-09T01:06:59.488Z\",\n \"IDAccountsPayableReceivableLog\": 3145,\n \"RecordUserCreated\": 6333,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 1608,\n \"ValueRatio\": 8603.169373658666,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 7162.643509218283\n },\n {\n \"IDTypeCostCenter\": 7666,\n \"ValueRatio\": 4129.5933507322015,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 2095.1764919786942\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 1505,\n \"DateDue\": \"1967-01-10\",\n \"DateDocument\": \"1957-08-01\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4982,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 6858,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 6490.315641395053,\n \"ValueDiscount\": 4853.64124975445,\n \"ValueInterest\": 4202.45204606802,\n \"ValuePenalty\": 6835.426140987764,\n \"ValueTotal\": 2037.2021709689147\n },\n {\n \"IDAccountPayableReceivable\": 4528,\n \"DateDue\": \"1967-06-19\",\n \"DateDocument\": \"2021-07-14\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1539,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4423,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 943.6076362302437,\n \"ValueDiscount\": 1264.0925979920903,\n \"ValueInterest\": 7155.227116108586,\n \"ValuePenalty\": 7183.738908909189,\n \"ValueTotal\": 2864.926824378622\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa2ba792-e237-43f1-b1f8-b8313fa91688", "name": "Validação falhou (prefixo `[BadRequest]`). Possíveis mensagens:\n- `Conta a receber não existe`\n- `Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)`\n- `Cliente não existe` / `Fornecedor não existe`\n- `Faturador não existe`\n- `Pagamento não existe` / `Banco não existe`\n- `Tipo documento não existe` / `Plano de contas não existe`\n- `Integração não existe`\n- `Boleto / link pagamento já está pago e não pode ser alterado`", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypeDocument\": 9642,\n \"IDTypeAccountPayableReceivable\": 5309,\n \"Comments\": \"string\",\n \"DateCompetence\": \"2013-05-09\",\n \"DateDocument\": \"1951-02-25\",\n \"DateDue\": \"2015-10-21\",\n \"DocumentNumber\": \"string\",\n \"IDConsumer\": 3740,\n \"IDSupplier\": 5185,\n \"IDTypePayment\": 6617,\n \"Value\": 2378.480240195655,\n \"Installment\": 9888,\n \"InstallmentTotal\": 7598,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDBankAccountForecast\": 109,\n \"ValueDiscount\": 6578.716162065123,\n \"ValueInterest\": 5953.278851784867,\n \"ValuePenalty\": 8585.889609044018,\n \"IDCompanyIntegration\": 9745,\n \"IDCompanyInvoice\": 6100,\n \"Forecast\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53e584ba-e186-420c-9f9a-b92bdb615b52", "name": "Exclui uma conta a receber", "request": { "name": "Exclui uma conta a receber", "description": { "content": "Exclui a conta a receber. Bloqueado quando: (a) o título está agendado para pagamento automático (`Scheduled=1`); (b) já existe pelo menos um pagamento lançado; (c) o título está vinculado a um recebimento de mercadoria e a parametrização **Não permitir excluir contas pagar com recebimento** está ativa.\n\nA exclusão também desfaz o vínculo de eventuais GNREs com o título.\n\nQuando `ChangeNextRepeat=1`, as próximas ocorrências da série de recorrência são excluídas junto.", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ChangeNextRepeat", "value": "1", "description": "Quando `1`, exclui também as próximas ocorrências da mesma série de recorrência (vinculadas pelo `IDAccountPayableReceivableMain`, com `DateDue` posterior à do título atual)." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "0b29969d-7748-44e2-a455-584697302e33", "name": "Conta excluída. Retorna a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeb2b037-207e-4177-875e-de1ce0fb1d23", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Pagamento não existe`\n- `Título está agendado e não pode ser excluído`\n- `Não é possível excluir um contas a pagar atrelado a um recebimento`\n- `Contas a pagar já tem pagamento`", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ChangeNextRepeat", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74e1a991-7838-4456-a696-85d4fbae0ba0", "name": "Define o rateio de centros de custo", "request": { "name": "Define o rateio de centros de custo", "description": { "content": "Substitui completamente o rateio de centros de custo da conta a receber. Enviar array vazio remove todos os centros. A soma de `ValueRatio` de todos os itens deve ser exatamente `1` (100%). Os centros enviados precisam estar ativos e pertencer à empresa da conta.", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 9197,\n \"ValueRatio\": 8964.987636085127\n },\n {\n \"IDTypeCostCenter\": 5109,\n \"ValueRatio\": 6169.135888968709\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5c050f2c-93fe-4611-8fe7-4c696e0463e6", "name": "Rateio atualizado. Retorna a conta a receber atualizada ou `\"sucesso\"` quando o array foi vazio.", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 2011,\n \"ValueRatio\": 4328.627972395862\n },\n {\n \"IDTypeCostCenter\": 7993,\n \"ValueRatio\": 3242.6994103913366\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 1192,\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"1991-01-12\",\n \"DateDocument\": \"1971-04-18\",\n \"DateDue\": \"2011-03-14\",\n \"DaysDue\": 8311,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2003-08-17T08:26:59.857Z\",\n \"IDConsumer\": 4910,\n \"IDSupplier\": 3551,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 6285,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 5864,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7725,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 5218,\n \"Order\": \"string\",\n \"IDStatusOrder\": 7815,\n \"OrderFinishConfirmation\": 4777,\n \"IDServiceOrder\": 9498,\n \"Installment\": 3746,\n \"InstallmentTotal\": 2548,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 4658,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 1910,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 1211,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 5449.036458719139,\n \"ValueDiscount\": 1318.8424055188764,\n \"ValueInterest\": 3932.708727526937,\n \"ValuePenalty\": 5727.107936322318,\n \"ValueTotal\": 9763.97884403835,\n \"Files\": [\n {\n \"RecordTimestamp\": \"1996-06-05T09:27:22.360Z\",\n \"IDFile\": 7591,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 655,\n \"IDAccountPayableReceivable\": 43\n },\n {\n \"RecordTimestamp\": \"2019-11-25T03:13:13.286Z\",\n \"IDFile\": 9764,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3708,\n \"IDAccountPayableReceivable\": 1781\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1970-07-21T03:23:36.418Z\",\n \"IDBankAccount\": 4552,\n \"IDBankStatement\": 2812,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5499.893903610051,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1999-01-30T23:20:10.599Z\",\n \"IDBankAccount\": 6903,\n \"IDBankStatement\": 2050,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5633.984671975285,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1955-10-30T15:21:21.970Z\",\n \"IDAccountsPayableReceivableLog\": 6920,\n \"RecordUserCreated\": 3011,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2019-10-20T11:36:32.257Z\",\n \"IDAccountsPayableReceivableLog\": 6129,\n \"RecordUserCreated\": 382,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 6029,\n \"ValueRatio\": 6921.138546281458,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8862.628247161609\n },\n {\n \"IDTypeCostCenter\": 7207,\n \"ValueRatio\": 620.724589591899,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8745.770316705099\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 9162,\n \"DateDue\": \"2017-06-10\",\n \"DateDocument\": \"1972-09-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2565,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4018,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5266.978167827554,\n \"ValueDiscount\": 9989.758292120727,\n \"ValueInterest\": 8942.323066714502,\n \"ValuePenalty\": 2453.1420391347992,\n \"ValueTotal\": 6648.225430861172\n },\n {\n \"IDAccountPayableReceivable\": 7685,\n \"DateDue\": \"1980-09-25\",\n \"DateDocument\": \"1979-06-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 1,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 5973,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1072,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 8300.510932607518,\n \"ValueDiscount\": 1347.6672489906227,\n \"ValueInterest\": 8970.62460672871,\n \"ValuePenalty\": 5215.476273913761,\n \"ValueTotal\": 425.07848850579677\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 2243,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2014-12-27\",\n \"DateDocument\": \"1964-12-07\",\n \"DateDue\": \"2016-12-25\",\n \"DaysDue\": 7454,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2013-07-27T20:27:57.139Z\",\n \"IDConsumer\": 7765,\n \"IDSupplier\": 3553,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 9266,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 7933,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 5508,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 828,\n \"Order\": \"string\",\n \"IDStatusOrder\": 2488,\n \"OrderFinishConfirmation\": 7283,\n \"IDServiceOrder\": 1089,\n \"Installment\": 5166,\n \"InstallmentTotal\": 6665,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 1318,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 6234,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 5984,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 8170.583953936956,\n \"ValueDiscount\": 5873.007842017643,\n \"ValueInterest\": 7624.031093756965,\n \"ValuePenalty\": 2048.8932019475683,\n \"ValueTotal\": 5424.827904940806,\n \"Files\": [\n {\n \"RecordTimestamp\": \"2004-01-12T11:45:13.307Z\",\n \"IDFile\": 1882,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3662,\n \"IDAccountPayableReceivable\": 9969\n },\n {\n \"RecordTimestamp\": \"2015-04-04T10:47:05.509Z\",\n \"IDFile\": 3550,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7876,\n \"IDAccountPayableReceivable\": 2908\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1953-07-24T04:10:50.858Z\",\n \"IDBankAccount\": 9709,\n \"IDBankStatement\": 9496,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5593.718230468087,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1969-04-16T13:43:00.322Z\",\n \"IDBankAccount\": 8599,\n \"IDBankStatement\": 2881,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3586.3234411151425,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1963-05-10T21:27:46.378Z\",\n \"IDAccountsPayableReceivableLog\": 2069,\n \"RecordUserCreated\": 4523,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"1986-03-09T01:06:59.488Z\",\n \"IDAccountsPayableReceivableLog\": 3145,\n \"RecordUserCreated\": 6333,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 1608,\n \"ValueRatio\": 8603.169373658666,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 7162.643509218283\n },\n {\n \"IDTypeCostCenter\": 7666,\n \"ValueRatio\": 4129.5933507322015,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 2095.1764919786942\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 1505,\n \"DateDue\": \"1967-01-10\",\n \"DateDocument\": \"1957-08-01\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4982,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 6858,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 6490.315641395053,\n \"ValueDiscount\": 4853.64124975445,\n \"ValueInterest\": 4202.45204606802,\n \"ValuePenalty\": 6835.426140987764,\n \"ValueTotal\": 2037.2021709689147\n },\n {\n \"IDAccountPayableReceivable\": 4528,\n \"DateDue\": \"1967-06-19\",\n \"DateDocument\": \"2021-07-14\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1539,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4423,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 943.6076362302437,\n \"ValueDiscount\": 1264.0925979920903,\n \"ValueInterest\": 7155.227116108586,\n \"ValuePenalty\": 7183.738908909189,\n \"ValueTotal\": 2864.926824378622\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dc7e546-f7bc-4a5d-9745-c7f0760f7b07", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Conta a receber/pagar não existe`\n- `Rateio precisa somar 100%`\n- `Centro de custo(s) não localizado(s): {ids}`\n- `Precisa enviar ao menos um centro de custo`", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "cost-center" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDTypeCostCenter\": 2011,\n \"ValueRatio\": 4328.627972395862\n },\n {\n \"IDTypeCostCenter\": 7993,\n \"ValueRatio\": 3242.6994103913366\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6344c32c-6e93-4620-b351-0db59fce4ead", "name": "Lança um pagamento na conta a receber", "request": { "name": "Lança um pagamento na conta a receber", "description": { "content": "Registra um pagamento na conta a receber, atualizando o status conforme o saldo pendente. Regras:\n\n- Quando a conta tinha **previsão** (`Forecast=1`), a flag é zerada após o lançamento.\n- Quando a conta não tinha banco previsto (`IDBankAccountForecast`), assume o banco do pagamento como previsão.\n- Quando `IDAccountsPayableReceivableConciliation` **ou** `IDAccountsPayableReceivableConciliationMarketplace` é informado e o valor pago difere do total do título — valor `Value` mais juros `ValueInterest` e multa `ValuePenalty`, menos desconto `ValueDiscount` — o sistema procura outro título em aberto do mesmo pedido com o mesmo `TID` ou `NSU` e redistribui a diferença entre os dois. Se não encontrar, a requisição falha e nada é gravado.\n- Com `IDAccountsPayableReceivableConciliation`, cria adicionalmente o lançamento de **taxa adquirente** abatendo o valor da comissão, usando o plano de contas e o tipo de documento configurados na integração.\n- Quando `IDAccountsPayableReceivableConciliationMarketplace` é informado, gera automaticamente as contas filhas das taxas do marketplace, vinculadas ao título da baixa: comissão (`MarketplaceFeeValue`), antecipação (`MarketplaceFinancingFeeValue`), frete (`MarketplaceShippingFeeValue`), cupom (`MarketplaceCouponValue`), impostos (`MarketplaceTaxesValue`) e outras taxas (`MarketplaceOtherFeeValue`). Cada categoria só vira título próprio quando a integração tem um plano de contas configurado para ela e o valor é diferente de zero; antecipação, frete, cupom e outras taxas sem plano de contas configurado são somadas ao valor da comissão. O plano de contas de impostos não é oferecido nas integrações de marketplace hoje, então na prática impostos não geram título — e, por não entrarem na regra de absorção, também não são somados à comissão. Cada conta filha recebe também o lançamento correspondente no extrato bancário e, quando a integração tem centro de custo configurado, o rateio nesse centro. Os valores entram com o sinal invertido em relação à taxa: taxa cobrada vira débito e taxa devolvida (cancelamento) vira crédito. Concluído o vínculo, a conciliação é fechada como conciliada manualmente (`IDTypeStatusConciliation=3`).\n- Pagamentos em conta de **caixinha** (`BankNumber=000`) só são aceitos com a caixinha fechada.\n- Quando `FinishIfPossible=1` e há pedido vinculado, e nenhum título do pedido continua em aberto após este lançamento, o pedido é levado adiante no fluxo (fechamento do pedido, sujeito às validações de saldo, crédito e margem configuradas).", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "FinishIfPossible", "value": "1", "description": "Quando `1`, tenta finalizar o pedido vinculado se todos os seus títulos estiverem pagos após este lançamento." }, { "disabled": false, "key": "query", "value": "1", "description": "Quando `1`, a resposta é apenas a string `\"sucesso\"`, sem os dados completos da conta. Útil em baixas em massa, para reduzir o tempo de resposta." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6352,\n \"DateTransactionTimestamp\": \"1972-09-13T22:43:03.491Z\",\n \"Value\": 3278.3750957704337,\n \"TransactionDescription\": \"\",\n \"TransactionDocument\": \"\",\n \"IDAccountsPayableReceivableConciliation\": 3921,\n \"IDAccountsPayableReceivableConciliationMarketplace\": 6596\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f4dc53af-9ad8-48fe-bfa3-fdb36b09edcd", "name": "Pagamento lançado. Retorna a conta a receber atualizada (ou a string `\"sucesso\"` quando `query=1`).", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FinishIfPossible", "value": "1" }, { "key": "query", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6352,\n \"DateTransactionTimestamp\": \"1972-09-13T22:43:03.491Z\",\n \"Value\": 3278.3750957704337,\n \"TransactionDescription\": \"\",\n \"TransactionDocument\": \"\",\n \"IDAccountsPayableReceivableConciliation\": 3921,\n \"IDAccountsPayableReceivableConciliationMarketplace\": 6596\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 1192,\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"1991-01-12\",\n \"DateDocument\": \"1971-04-18\",\n \"DateDue\": \"2011-03-14\",\n \"DaysDue\": 8311,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2003-08-17T08:26:59.857Z\",\n \"IDConsumer\": 4910,\n \"IDSupplier\": 3551,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 6285,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 5864,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7725,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 5218,\n \"Order\": \"string\",\n \"IDStatusOrder\": 7815,\n \"OrderFinishConfirmation\": 4777,\n \"IDServiceOrder\": 9498,\n \"Installment\": 3746,\n \"InstallmentTotal\": 2548,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 4658,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 1910,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 1211,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 5449.036458719139,\n \"ValueDiscount\": 1318.8424055188764,\n \"ValueInterest\": 3932.708727526937,\n \"ValuePenalty\": 5727.107936322318,\n \"ValueTotal\": 9763.97884403835,\n \"Files\": [\n {\n \"RecordTimestamp\": \"1996-06-05T09:27:22.360Z\",\n \"IDFile\": 7591,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 655,\n \"IDAccountPayableReceivable\": 43\n },\n {\n \"RecordTimestamp\": \"2019-11-25T03:13:13.286Z\",\n \"IDFile\": 9764,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3708,\n \"IDAccountPayableReceivable\": 1781\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1970-07-21T03:23:36.418Z\",\n \"IDBankAccount\": 4552,\n \"IDBankStatement\": 2812,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5499.893903610051,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1999-01-30T23:20:10.599Z\",\n \"IDBankAccount\": 6903,\n \"IDBankStatement\": 2050,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5633.984671975285,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1955-10-30T15:21:21.970Z\",\n \"IDAccountsPayableReceivableLog\": 6920,\n \"RecordUserCreated\": 3011,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2019-10-20T11:36:32.257Z\",\n \"IDAccountsPayableReceivableLog\": 6129,\n \"RecordUserCreated\": 382,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 6029,\n \"ValueRatio\": 6921.138546281458,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8862.628247161609\n },\n {\n \"IDTypeCostCenter\": 7207,\n \"ValueRatio\": 620.724589591899,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8745.770316705099\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 9162,\n \"DateDue\": \"2017-06-10\",\n \"DateDocument\": \"1972-09-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2565,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4018,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5266.978167827554,\n \"ValueDiscount\": 9989.758292120727,\n \"ValueInterest\": 8942.323066714502,\n \"ValuePenalty\": 2453.1420391347992,\n \"ValueTotal\": 6648.225430861172\n },\n {\n \"IDAccountPayableReceivable\": 7685,\n \"DateDue\": \"1980-09-25\",\n \"DateDocument\": \"1979-06-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 1,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 5973,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1072,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 8300.510932607518,\n \"ValueDiscount\": 1347.6672489906227,\n \"ValueInterest\": 8970.62460672871,\n \"ValuePenalty\": 5215.476273913761,\n \"ValueTotal\": 425.07848850579677\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 2243,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2014-12-27\",\n \"DateDocument\": \"1964-12-07\",\n \"DateDue\": \"2016-12-25\",\n \"DaysDue\": 7454,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2013-07-27T20:27:57.139Z\",\n \"IDConsumer\": 7765,\n \"IDSupplier\": 3553,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 9266,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 7933,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 5508,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 828,\n \"Order\": \"string\",\n \"IDStatusOrder\": 2488,\n \"OrderFinishConfirmation\": 7283,\n \"IDServiceOrder\": 1089,\n \"Installment\": 5166,\n \"InstallmentTotal\": 6665,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 1318,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 6234,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 5984,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 8170.583953936956,\n \"ValueDiscount\": 5873.007842017643,\n \"ValueInterest\": 7624.031093756965,\n \"ValuePenalty\": 2048.8932019475683,\n \"ValueTotal\": 5424.827904940806,\n \"Files\": [\n {\n \"RecordTimestamp\": \"2004-01-12T11:45:13.307Z\",\n \"IDFile\": 1882,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3662,\n \"IDAccountPayableReceivable\": 9969\n },\n {\n \"RecordTimestamp\": \"2015-04-04T10:47:05.509Z\",\n \"IDFile\": 3550,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7876,\n \"IDAccountPayableReceivable\": 2908\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1953-07-24T04:10:50.858Z\",\n \"IDBankAccount\": 9709,\n \"IDBankStatement\": 9496,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5593.718230468087,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1969-04-16T13:43:00.322Z\",\n \"IDBankAccount\": 8599,\n \"IDBankStatement\": 2881,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3586.3234411151425,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1963-05-10T21:27:46.378Z\",\n \"IDAccountsPayableReceivableLog\": 2069,\n \"RecordUserCreated\": 4523,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"1986-03-09T01:06:59.488Z\",\n \"IDAccountsPayableReceivableLog\": 3145,\n \"RecordUserCreated\": 6333,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 1608,\n \"ValueRatio\": 8603.169373658666,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 7162.643509218283\n },\n {\n \"IDTypeCostCenter\": 7666,\n \"ValueRatio\": 4129.5933507322015,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 2095.1764919786942\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 1505,\n \"DateDue\": \"1967-01-10\",\n \"DateDocument\": \"1957-08-01\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4982,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 6858,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 6490.315641395053,\n \"ValueDiscount\": 4853.64124975445,\n \"ValueInterest\": 4202.45204606802,\n \"ValuePenalty\": 6835.426140987764,\n \"ValueTotal\": 2037.2021709689147\n },\n {\n \"IDAccountPayableReceivable\": 4528,\n \"DateDue\": \"1967-06-19\",\n \"DateDocument\": \"2021-07-14\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1539,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4423,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 943.6076362302437,\n \"ValueDiscount\": 1264.0925979920903,\n \"ValueInterest\": 7155.227116108586,\n \"ValuePenalty\": 7183.738908909189,\n \"ValueTotal\": 2864.926824378622\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29db6e98-f8eb-41ce-8807-bafff7ac6ec4", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Conta a receber/pagar não existe`\n- `Conta bancária não existe`\n- `Caixinha está aberto e não pode ter pagamentos efetuados`\n- `Valor a conciliar divergente de valor do título e não há outro lançamento relacionado`\n- `Erro ao criar lançamento de taxa adquirente`", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "FinishIfPossible", "value": "1" }, { "key": "query", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDBankAccount\": 6352,\n \"DateTransactionTimestamp\": \"1972-09-13T22:43:03.491Z\",\n \"Value\": 3278.3750957704337,\n \"TransactionDescription\": \"\",\n \"TransactionDocument\": \"\",\n \"IDAccountsPayableReceivableConciliation\": 3921,\n \"IDAccountsPayableReceivableConciliationMarketplace\": 6596\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2aea162d-e993-499c-9072-0fd026d62923", "name": "Cancela um pagamento lançado", "request": { "name": "Cancela um pagamento lançado", "description": { "content": "Remove o lançamento de pagamento e reverte o status da conta a receber. Regras:\n\n- Pagamentos lançados em **caixa** (`IDStoreFrontCashier` preenchido) não podem ser excluídos por esta rota.\n- Pagamentos em conta de **caixinha** (`BankNumber=000`) só podem ser excluídos com a caixinha fechada.\n- Quando o pagamento está vinculado a uma **conciliação bancária**, o vínculo é desfeito e a conciliação volta para `IDTypeStatusConciliation=4` (Conciliado parcialmente) se ainda restarem outros pagamentos vinculados a ela, ou para `1` (Não conciliado) quando era o último.\n- Quando o pagamento está vinculado a uma **conciliação de adquirente**, o vínculo é desfeito e a conciliação volta para `ConciliationStatus=1` (Não conciliado), sem recálculo por lançamentos remanescentes.\n- Quando o pagamento está vinculado a uma **conciliação de marketplace**, a referência é desfeita e a conciliação volta para `IDTypeStatusConciliation=1` (Não conciliado), voltando a ser listada como pendente.\n- O estorno não é simétrico à baixa: apenas o lançamento do título informado é removido. As contas filhas de comissão, antecipação, frete, cupom e outras taxas criadas na baixa permanecem, com seus próprios lançamentos, e precisam ser tratadas individualmente.\n- A exclusão é registrada no histórico da conta.", "type": "text/plain" }, "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "payment", ":idaccountpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDBankStatementConciliation", "value": "2232", "description": "Quando informado, garante que o pagamento só seja excluído se pertencer a esta conciliação bancária. Pagamentos vinculados a outra conciliação são bloqueados." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayment", "description": "(Required) Identificador do lançamento de pagamento (`IDBankStatement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7fa0095f-3694-4605-b7f8-8f1902bf7232", "name": "Pagamento excluído. Atenção: nesta rota o corpo devolvido vem sempre vazio (`[]`) — a exclusão é efetivada normalmente, mas a conta a receber atualizada não é retornada. Para atualizar a tela, refaça `GET /accounts/receivable/{idaccountreceivable}` depois da exclusão. Na rota equivalente de contas a pagar a conta volta preenchida.", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "payment", ":idaccountpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankStatementConciliation", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayment", "description": "(Required) Identificador do lançamento de pagamento (`IDBankStatement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 1192,\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"1991-01-12\",\n \"DateDocument\": \"1971-04-18\",\n \"DateDue\": \"2011-03-14\",\n \"DaysDue\": 8311,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2003-08-17T08:26:59.857Z\",\n \"IDConsumer\": 4910,\n \"IDSupplier\": 3551,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 6285,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 5864,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 7725,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 5218,\n \"Order\": \"string\",\n \"IDStatusOrder\": 7815,\n \"OrderFinishConfirmation\": 4777,\n \"IDServiceOrder\": 9498,\n \"Installment\": 3746,\n \"InstallmentTotal\": 2548,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 4658,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 1910,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 1211,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 5449.036458719139,\n \"ValueDiscount\": 1318.8424055188764,\n \"ValueInterest\": 3932.708727526937,\n \"ValuePenalty\": 5727.107936322318,\n \"ValueTotal\": 9763.97884403835,\n \"Files\": [\n {\n \"RecordTimestamp\": \"1996-06-05T09:27:22.360Z\",\n \"IDFile\": 7591,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 655,\n \"IDAccountPayableReceivable\": 43\n },\n {\n \"RecordTimestamp\": \"2019-11-25T03:13:13.286Z\",\n \"IDFile\": 9764,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3708,\n \"IDAccountPayableReceivable\": 1781\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1970-07-21T03:23:36.418Z\",\n \"IDBankAccount\": 4552,\n \"IDBankStatement\": 2812,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5499.893903610051,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1999-01-30T23:20:10.599Z\",\n \"IDBankAccount\": 6903,\n \"IDBankStatement\": 2050,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5633.984671975285,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1955-10-30T15:21:21.970Z\",\n \"IDAccountsPayableReceivableLog\": 6920,\n \"RecordUserCreated\": 3011,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2019-10-20T11:36:32.257Z\",\n \"IDAccountsPayableReceivableLog\": 6129,\n \"RecordUserCreated\": 382,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 6029,\n \"ValueRatio\": 6921.138546281458,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8862.628247161609\n },\n {\n \"IDTypeCostCenter\": 7207,\n \"ValueRatio\": 620.724589591899,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 8745.770316705099\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 9162,\n \"DateDue\": \"2017-06-10\",\n \"DateDocument\": \"1972-09-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 2565,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4018,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 5266.978167827554,\n \"ValueDiscount\": 9989.758292120727,\n \"ValueInterest\": 8942.323066714502,\n \"ValuePenalty\": 2453.1420391347992,\n \"ValueTotal\": 6648.225430861172\n },\n {\n \"IDAccountPayableReceivable\": 7685,\n \"DateDue\": \"1980-09-25\",\n \"DateDocument\": \"1979-06-11\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 1,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 5973,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 1072,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 1,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 8300.510932607518,\n \"ValueDiscount\": 1347.6672489906227,\n \"ValueInterest\": 8970.62460672871,\n \"ValuePenalty\": 5215.476273913761,\n \"ValueTotal\": 425.07848850579677\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDAccountPayableReceivable\": 2243,\n \"IDStatusAccountPayableReceivable\": 0,\n \"StatusAccountPayableReceivable\": \"string\",\n \"Comments\": \"string\",\n \"DateCompetence\": \"2014-12-27\",\n \"DateDocument\": \"1964-12-07\",\n \"DateDue\": \"2016-12-25\",\n \"DaysDue\": 7454,\n \"DocumentNumber\": \"string\",\n \"RecordTimestamp\": \"2013-07-27T20:27:57.139Z\",\n \"IDConsumer\": 7765,\n \"IDSupplier\": 3553,\n \"ConsumerNameCorporateName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 9266,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 7933,\n \"TypeDocument\": \"string\",\n \"IDTypePayment\": 5508,\n \"TypePaymentDescription\": \"string\",\n \"IDOrder\": 828,\n \"Order\": \"string\",\n \"IDStatusOrder\": 2488,\n \"OrderFinishConfirmation\": 7283,\n \"IDServiceOrder\": 1089,\n \"Installment\": 5166,\n \"InstallmentTotal\": 6665,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDCompanyInvoice\": 1318,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyIntegration\": 6234,\n \"CompanyIntegration\": \"string\",\n \"IDBankAccountForecast\": 5984,\n \"Bank\": \"string\",\n \"BankForecastAccountNumber\": \"string\",\n \"Forecast\": 0,\n \"Value\": 8170.583953936956,\n \"ValueDiscount\": 5873.007842017643,\n \"ValueInterest\": 7624.031093756965,\n \"ValuePenalty\": 2048.8932019475683,\n \"ValueTotal\": 5424.827904940806,\n \"Files\": [\n {\n \"RecordTimestamp\": \"2004-01-12T11:45:13.307Z\",\n \"IDFile\": 1882,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 3662,\n \"IDAccountPayableReceivable\": 9969\n },\n {\n \"RecordTimestamp\": \"2015-04-04T10:47:05.509Z\",\n \"IDFile\": 3550,\n \"IDTypeFile\": \"string\",\n \"TypeFile\": \"string\",\n \"FileUrl\": \"string\",\n \"IDGnre\": 7876,\n \"IDAccountPayableReceivable\": 2908\n }\n ],\n \"Payments\": [\n {\n \"DateTransactionTimestamp\": \"1953-07-24T04:10:50.858Z\",\n \"IDBankAccount\": 9709,\n \"IDBankStatement\": 9496,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 5593.718230468087,\n \"Bank\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1969-04-16T13:43:00.322Z\",\n \"IDBankAccount\": 8599,\n \"IDBankStatement\": 2881,\n \"TransactionDescription\": \"string\",\n \"TransactionDocument\": \"string\",\n \"Value\": 3586.3234411151425,\n \"Bank\": \"string\"\n }\n ],\n \"AccountsPayableReceivableLog\": [\n {\n \"RecordTimestamp\": \"1963-05-10T21:27:46.378Z\",\n \"IDAccountsPayableReceivableLog\": 2069,\n \"RecordUserCreated\": 4523,\n \"Data\": \"string\",\n \"Login\": \"string\"\n },\n {\n \"RecordTimestamp\": \"1986-03-09T01:06:59.488Z\",\n \"IDAccountsPayableReceivableLog\": 3145,\n \"RecordUserCreated\": 6333,\n \"Data\": \"string\",\n \"Login\": \"string\"\n }\n ],\n \"AccountsPayableReceivableCostCenter\": [\n {\n \"IDTypeCostCenter\": 1608,\n \"ValueRatio\": 8603.169373658666,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 7162.643509218283\n },\n {\n \"IDTypeCostCenter\": 7666,\n \"ValueRatio\": 4129.5933507322015,\n \"TypeCostCenter\": \"string\",\n \"ExternalCode\": \"string\",\n \"Value\": 2095.1764919786942\n }\n ],\n \"RelatedAccountsPayableReceivable\": [\n {\n \"IDAccountPayableReceivable\": 1505,\n \"DateDue\": \"1967-01-10\",\n \"DateDocument\": \"1957-08-01\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 6,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 4982,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 6858,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 6490.315641395053,\n \"ValueDiscount\": 4853.64124975445,\n \"ValueInterest\": 4202.45204606802,\n \"ValuePenalty\": 6835.426140987764,\n \"ValueTotal\": 2037.2021709689147\n },\n {\n \"IDAccountPayableReceivable\": 4528,\n \"DateDue\": \"1967-06-19\",\n \"DateDocument\": \"2021-07-14\",\n \"DocumentNumber\": \"string\",\n \"IDStatusAccountPayableReceivable\": 3,\n \"StatusAccountPayableReceivable\": \"string\",\n \"IDConsumer\": 1539,\n \"ConsumerNameCorporateName\": \"string\",\n \"IDSupplier\": 4423,\n \"SupplierNameCorporateName\": \"string\",\n \"IDTypeAccount\": 0,\n \"TypeAccountPaybleDescription\": \"string\",\n \"Value\": 943.6076362302437,\n \"ValueDiscount\": 1264.0925979920903,\n \"ValueInterest\": 7155.227116108586,\n \"ValuePenalty\": 7183.738908909189,\n \"ValueTotal\": 2864.926824378622\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80ff20a8-5133-410c-949b-73338e6b42f2", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Pagamento não existe`\n- `Pagamento foi realizado em um caixa e não pode ser excluído`\n- `Caixinha está aberto e não pode ter pagamentos efetuados`\n- `Não é possível excluir um pagamento vinculado a outra conciliação bancária`\n- `Erro ao atualizar conciliação bancária`\n- `Erro ao verificar vínculos de conciliação`\n- `Problema ao deletar pagamento`", "originalRequest": { "url": { "path": [ "accounts", "receivable", ":idaccountreceivable", "payment", ":idaccountpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankStatementConciliation", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idaccountreceivable", "description": "(Required) Identificador da conta a receber." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayment", "description": "(Required) Identificador do lançamento de pagamento (`IDBankStatement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "958f6e92-a4a2-4b5e-8e2d-668062b48f57", "name": "Correios — PI", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9366346f-c1f7-4449-b99e-57e851d22574", "name": "Lista as Postagens Imediatas Correios", "request": { "name": "Lista as Postagens Imediatas Correios", "description": { "content": "Retorna as PIs (Postagens Imediatas) Correios abertas para os pacotes da empresa, com identificador da PI, status, datas de abertura e postagem, prazo máximo de entrega, motivo da reclamação e última mensagem de retorno. Pagina por blocos de 3.000 registros (`Page`) limitando 1.000 por página.", "type": "text/plain" }, "url": { "path": [ "correios", "pi" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Order", "value": "string", "description": "Filtra pelo número do pedido (busca parcial via `LIKE`)." }, { "disabled": false, "key": "OrderFrom", "value": "string", "description": "Filtra por uma origem associada ao pedido." }, { "disabled": false, "key": "ShippingDateFrom", "value": "1980-02-08", "description": "Data inicial do embarque do pacote." }, { "disabled": false, "key": "ShippingDateTo", "value": "1980-02-08", "description": "Data final do embarque do pacote. O sistema concatena `23:59:59`." }, { "disabled": false, "key": "DateOpeningPIFrom", "value": "1980-02-08", "description": "Data inicial de abertura da PI." }, { "disabled": false, "key": "DateOpeningPITo", "value": "1980-02-08", "description": "Data final de abertura da PI. O sistema concatena `23:59:59`." }, { "disabled": false, "key": "StatusPI", "value": "string", "description": "Filtra pelo status da PI (busca parcial via `LIKE`)." }, { "disabled": false, "key": "Page", "value": "4675", "description": "Número da página. Cada página retorna até 1.000 registros, com offset de 3.000 por página." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e87636fa-63ff-427e-b54a-b8eeffb5f5ca", "name": "PIs retornadas.", "originalRequest": { "url": { "path": [ "correios", "pi" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Order", "value": "string" }, { "key": "OrderFrom", "value": "string" }, { "key": "ShippingDateFrom", "value": "1980-02-08" }, { "key": "ShippingDateTo", "value": "1980-02-08" }, { "key": "DateOpeningPIFrom", "value": "1980-02-08" }, { "key": "DateOpeningPITo", "value": "1980-02-08" }, { "key": "StatusPI", "value": "string" }, { "key": "Page", "value": "4675" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCorreiosPI\": 1936,\n \"RecordTimestamp\": \"1958-09-25T14:13:47.855Z\",\n \"IDPackage\": 3827,\n \"PINumber\": \"string\",\n \"PICode\": \"string\",\n \"IDComplaintReason\": 8306,\n \"ComplaintReason\": \"string\",\n \"DateOpeningPI\": \"2025-06-15T17:28:59.381Z\",\n \"DatePostingObject\": \"1964-04-26T04:00:28.193Z\",\n \"DateMaxDelivery\": \"1990-10-02T21:16:09.564Z\",\n \"DateLastEvent\": \"1985-12-03T06:27:55.665Z\",\n \"StatusPI\": \"string\",\n \"SubStatusPI\": \"string\",\n \"LastMessageResponse\": \"string\",\n \"DateLastResponse\": \"1981-11-03T20:58:45.807Z\",\n \"ShippingId\": \"string\",\n \"ShippingDate\": \"1950-09-05T16:36:31.555Z\",\n \"IDOrder\": 6609,\n \"Order\": \"string\",\n \"CarrierDeliveryDate\": \"1968-04-14T04:12:42.759Z\",\n \"AccountName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"OrderFrom\": \"string\"\n },\n {\n \"IDCorreiosPI\": 1229,\n \"RecordTimestamp\": \"1998-07-17T06:06:21.874Z\",\n \"IDPackage\": 7323,\n \"PINumber\": \"string\",\n \"PICode\": \"string\",\n \"IDComplaintReason\": 1940,\n \"ComplaintReason\": \"string\",\n \"DateOpeningPI\": \"2005-11-19T15:07:36.724Z\",\n \"DatePostingObject\": \"1948-08-11T08:27:25.748Z\",\n \"DateMaxDelivery\": \"2008-11-22T15:10:24.188Z\",\n \"DateLastEvent\": \"1980-04-26T10:40:22.734Z\",\n \"StatusPI\": \"string\",\n \"SubStatusPI\": \"string\",\n \"LastMessageResponse\": \"string\",\n \"DateLastResponse\": \"2026-03-03T09:27:43.833Z\",\n \"ShippingId\": \"string\",\n \"ShippingDate\": \"2006-03-09T01:34:39.477Z\",\n \"IDOrder\": 2075,\n \"Order\": \"string\",\n \"CarrierDeliveryDate\": \"1972-10-27T05:47:50.740Z\",\n \"AccountName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"OrderFrom\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b801a7f2-c974-4491-8867-1db4e63d6d2d", "name": "Cotação de Frete", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "71b956a2-a007-49d7-bfe2-8455e9b706be", "name": "Lista regras de simulação de frete", "request": { "name": "Lista regras de simulação de frete", "description": { "content": "Retorna as regras da empresa **ordenadas por `Priority` crescente** e, em empate, por `IDCarrierQuotationRule` DESC (até 1000 itens). Inclui regras Ativas (`Status=1`) e Inativas (`Status=0`), mas oculta as Excluídas (`Status=2`). Cada item já vem com `ConditionsRules` (array de condições com `ConditionValue` quebrado em vetor pelo separador `,`), `ConditionNames` (string concatenada com nomes das condições, usada na grid) e `CarrierQuotationRuleLog` (histórico de alterações em formato `DE: PARA: `).", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation", "rule" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "0", "description": "Índice da página para paginação, começando em `0`. Cada página retorna até 1000 regras; informe `1` para as próximas 1000, e assim por diante. Quando omitido, assume `0` (primeira página)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "49ff15a9-0dc3-41da-bd97-05de9fb64f30", "name": "Lista das regras (até 1000).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDCarrierQuotationRule\": 2304,\n \"RecordTimestamp\": \"1952-11-20T04:00:50.468Z\",\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 3279,\n \"Status\": 0,\n \"DateFrom\": \"1995-05-17\",\n \"DateTo\": \"2021-05-28\",\n \"IDTypeCarrierQuotationActionRule\": 9,\n \"TypeCarrierQuotationActionRule\": \"string\",\n \"ActionValue\": \"string\",\n \"ConditionsRules\": [\n {\n \"IDCarrierQuotationRuleCondition\": 5554,\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDCarrierQuotationRuleCondition\": 6887,\n \"IDTypeCarrierQuotationConditionRule\": 10,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"ConditionNames\": \"string\",\n \"CarrierQuotationRuleLog\": [\n {\n \"IDCarrierQuotationRuleLog\": 864,\n \"RecordTimestamp\": \"1954-06-02T10:12:34.198Z\",\n \"RecordUserCreated\": 4959,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDCarrierQuotationRuleLog\": 2115,\n \"RecordTimestamp\": \"1970-07-11T15:07:54.255Z\",\n \"RecordUserCreated\": 1150,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDCarrierQuotationRule\": 5011,\n \"RecordTimestamp\": \"1979-08-25T17:02:05.596Z\",\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 1751,\n \"Status\": 1,\n \"DateFrom\": \"1979-07-02\",\n \"DateTo\": \"1963-08-15\",\n \"IDTypeCarrierQuotationActionRule\": 8,\n \"TypeCarrierQuotationActionRule\": \"string\",\n \"ActionValue\": \"string\",\n \"ConditionsRules\": [\n {\n \"IDCarrierQuotationRuleCondition\": 7890,\n \"IDTypeCarrierQuotationConditionRule\": 4,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDCarrierQuotationRuleCondition\": 5103,\n \"IDTypeCarrierQuotationConditionRule\": 5,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"ConditionNames\": \"string\",\n \"CarrierQuotationRuleLog\": [\n {\n \"IDCarrierQuotationRuleLog\": 3944,\n \"RecordTimestamp\": \"1993-07-24T20:29:23.730Z\",\n \"RecordUserCreated\": 4147,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDCarrierQuotationRuleLog\": 9867,\n \"RecordTimestamp\": \"2013-05-12T23:33:33.567Z\",\n \"RecordUserCreated\": 6804,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af2854e1-7a0e-4f89-a4cc-b2afbf8be176", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "994723e0-9d1a-43d1-b401-ff48640cd01e", "name": "Cria uma regra de simulação de frete", "request": { "name": "Cria uma regra de simulação de frete", "description": { "content": "Cria uma regra para a empresa autenticada, com 1+ condições e 1 ação. O sistema valida cada condição pelo `IDTypeCarrierQuotationConditionRule` informado:\n\n- **1 — Estado/Região**: cada item é a sigla UF (2 letras) opcionalmente concatenada com `CAPITAL` ou `INTERIOR` (ex.: `SP`, `SPCAPITAL`, `RJINTERIOR`). UFs aceitas: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.\n- **2 — CEP Destino** e **10 — CEP Origem**: cada item é a faixa `|`, sem hífens, 8 dígitos cada. `CEPDe` precisa ser **menor** que `CEPAté`.\n- **3 — Transportadora**: cada item é o `IDSupplier` de um fornecedor da empresa com `IDTypeSupplier=2` (Transportadora). Quando a ação é `9` (Excluir transportadoras), a condição 3 é **obrigatória** e a UI marca automaticamente.\n- **4 — Valor do pedido**: cada item é a faixa `|` em reais. `ValorDe` precisa ser **menor** que `ValorAté`, ambos ≥ 0.\n- **6 — Integração**: cada item é o `IDCompanyIntegration` de uma integração configurada pela empresa.\n- **7 — Peso (kg)**: cada item é a faixa `|` em kg.\n- **8 — SKUs iguais a** e **9 — SKUs diferentes de**: cada item tem o formato `|`. Não há validação de existência do SKU no sistema.\n\nA regra passa a valer imediatamente para a próxima cotação. Devolve o detalhe da regra recém-criada (formato do GET por id).", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation", "rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 8716,\n \"IDTypeCarrierQuotationActionRule\": 12,\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 8,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Status\": 0,\n \"DateFrom\": \"1993-05-26\",\n \"DateTo\": \"2003-02-11\",\n \"ActionValue\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "582535a2-4c75-4582-a313-2884c56667dd", "name": "Regra criada.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 3709,\n \"IDTypeCarrierQuotationActionRule\": 7,\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 5,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Status\": 1,\n \"DateFrom\": \"1976-08-01\",\n \"DateTo\": \"2020-07-13\",\n \"ActionValue\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDCarrierQuotationRule\": 2597,\n \"RecordTimestamp\": \"2020-05-04T18:43:56.697Z\",\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 3224,\n \"Status\": 1,\n \"DateFrom\": \"2000-11-21\",\n \"DateTo\": \"2006-02-02\",\n \"IDTypeCarrierQuotationActionRule\": 12,\n \"TypeCarrierQuotationActionRule\": \"string\",\n \"ActionValue\": \"string\",\n \"ConditionsRules\": [\n {\n \"IDCarrierQuotationRuleCondition\": 6205,\n \"IDTypeCarrierQuotationConditionRule\": 2,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDCarrierQuotationRuleCondition\": 4517,\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"ConditionNames\": \"string\",\n \"CarrierQuotationRuleLog\": [\n {\n \"IDCarrierQuotationRuleLog\": 8605,\n \"RecordTimestamp\": \"2011-09-12T03:53:41.555Z\",\n \"RecordUserCreated\": 8382,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDCarrierQuotationRuleLog\": 7123,\n \"RecordTimestamp\": \"1958-07-09T12:19:39.522Z\",\n \"RecordUserCreated\": 8787,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f27c9fd6-37e7-477c-a6e1-873a72c1dc23", "name": "Validações: `[BadRequest] - Empresa não existe`; `[BadRequest] - Ação inativa ou não existe`; `[BadRequest] - Estado não encontrado`; `[BadRequest] - Faixa de cep - inválida`; `[BadRequest] - ID da transportadora não encontrado`; `[BadRequest] - Preço | inválido, preço De precisa ser menor que preço Para`; `[BadRequest] - ID da integração não encontrado`; `[BadRequest] - Falha ao adicionar regra de cotação`; `[BadRequest] - Falha ao adicionar condições da regra de cotação`.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 3709,\n \"IDTypeCarrierQuotationActionRule\": 7,\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 5,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Status\": 1,\n \"DateFrom\": \"1976-08-01\",\n \"DateTo\": \"2020-07-13\",\n \"ActionValue\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "559b65fe-ec4d-4176-b466-70cb8f3d15ab", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 3709,\n \"IDTypeCarrierQuotationActionRule\": 7,\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 5,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Status\": 1,\n \"DateFrom\": \"1976-08-01\",\n \"DateTo\": \"2020-07-13\",\n \"ActionValue\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e2d2e6e-640f-4c0e-a336-2e6c4bda6ed5", "name": "Detalha uma regra de simulação de frete", "request": { "name": "Detalha uma regra de simulação de frete", "description": { "content": "Retorna a regra completa: cabeçalho (`CarrierQuotationRuleName`, `Priority`, `Status`, `DateFrom`, `DateTo`, ação e valor), `ConditionsRules` com cada condição quebrada em vetor pelo separador `,`, e `CarrierQuotationRuleLog` ordenado por `IDCarrierQuotationRuleLog` DESC (histórico de alterações em formato `DE: PARA: ` e `_Adicionado` / `_Removido`).", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5719aecd-4b90-4819-bf24-8541ca07656d", "name": "Detalhe da regra.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDCarrierQuotationRule\": 2597,\n \"RecordTimestamp\": \"2020-05-04T18:43:56.697Z\",\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 3224,\n \"Status\": 1,\n \"DateFrom\": \"2000-11-21\",\n \"DateTo\": \"2006-02-02\",\n \"IDTypeCarrierQuotationActionRule\": 12,\n \"TypeCarrierQuotationActionRule\": \"string\",\n \"ActionValue\": \"string\",\n \"ConditionsRules\": [\n {\n \"IDCarrierQuotationRuleCondition\": 6205,\n \"IDTypeCarrierQuotationConditionRule\": 2,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDCarrierQuotationRuleCondition\": 4517,\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"ConditionNames\": \"string\",\n \"CarrierQuotationRuleLog\": [\n {\n \"IDCarrierQuotationRuleLog\": 8605,\n \"RecordTimestamp\": \"2011-09-12T03:53:41.555Z\",\n \"RecordUserCreated\": 8382,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDCarrierQuotationRuleLog\": 7123,\n \"RecordTimestamp\": \"1958-07-09T12:19:39.522Z\",\n \"RecordUserCreated\": 8787,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb8a491c-40d7-4916-a776-4a1eb897b755", "name": "`[BadRequest] - Regra de cotação não encontrada`; `[BadRequest] - Parâmetros inválidos`.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "414f7d65-0494-4f87-b526-0af6f109f970", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c396775-0abd-4105-8f07-fc42262430c5", "name": "Atualiza uma regra de simulação de frete", "request": { "name": "Atualiza uma regra de simulação de frete", "description": { "content": "**Atualização total** do cabeçalho (`CarrierQuotationRuleName`, `Priority`, `Status`, `DateFrom`, `DateTo`, `IDTypeCarrierQuotationActionRule`, `ActionValue`) — campos que não vêm no body são gravados como NULL. As **condições** seguem a lógica de diff: o sistema compara `Conditions` com o que já está em `CarrierQuotationRuleCondition` e:\n\n- Insere o que está no body e não existe (grava `_Adicionado` no log).\n- Apaga o que existe e não veio no body (grava `_Removido` no log).\n- Mantém o que já estava igual.\n\nQualquer mudança de campo do cabeçalho gera linha no log no formato `DE: PARA: `. Datas são comparadas truncadas para `YYYY-MM-DD`. As alterações passam a valer imediatamente. Devolve o detalhe da regra atualizada.", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 5511,\n \"Status\": 1,\n \"DateFrom\": \"2012-09-05\",\n \"DateTo\": \"1980-03-29\",\n \"IDTypeCarrierQuotationActionRule\": 9,\n \"ActionValue\": \"string\",\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 2,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4de0cd31-fb96-418b-8d33-c956da45706b", "name": "Regra atualizada.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 8275,\n \"Status\": 1,\n \"DateFrom\": \"1951-05-31\",\n \"DateTo\": \"2024-07-08\",\n \"IDTypeCarrierQuotationActionRule\": 13,\n \"ActionValue\": \"string\",\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDTypeCarrierQuotationConditionRule\": 5,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDCarrierQuotationRule\": 2597,\n \"RecordTimestamp\": \"2020-05-04T18:43:56.697Z\",\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 3224,\n \"Status\": 1,\n \"DateFrom\": \"2000-11-21\",\n \"DateTo\": \"2006-02-02\",\n \"IDTypeCarrierQuotationActionRule\": 12,\n \"TypeCarrierQuotationActionRule\": \"string\",\n \"ActionValue\": \"string\",\n \"ConditionsRules\": [\n {\n \"IDCarrierQuotationRuleCondition\": 6205,\n \"IDTypeCarrierQuotationConditionRule\": 2,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDCarrierQuotationRuleCondition\": 4517,\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"TypeCarrierQuotationConditionRule\": \"string\",\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"ConditionNames\": \"string\",\n \"CarrierQuotationRuleLog\": [\n {\n \"IDCarrierQuotationRuleLog\": 8605,\n \"RecordTimestamp\": \"2011-09-12T03:53:41.555Z\",\n \"RecordUserCreated\": 8382,\n \"Login\": \"string\",\n \"Data\": \"string\"\n },\n {\n \"IDCarrierQuotationRuleLog\": 7123,\n \"RecordTimestamp\": \"1958-07-09T12:19:39.522Z\",\n \"RecordUserCreated\": 8787,\n \"Login\": \"string\",\n \"Data\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18eccacc-cd7e-4c2b-9d6d-9259495806be", "name": "Validações: `[BadRequest] - Regra de cotação não existe`; `[BadRequest] - Estado não encontrado`; `[BadRequest] - Faixa de cep - inválida`; `[BadRequest] - ID da transportadora não encontrado`; `[BadRequest] - Preço | inválido, preço De precisa ser menor que preço Até`; `[BadRequest] - ID da integração não encontrado`.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 8275,\n \"Status\": 1,\n \"DateFrom\": \"1951-05-31\",\n \"DateTo\": \"2024-07-08\",\n \"IDTypeCarrierQuotationActionRule\": 13,\n \"ActionValue\": \"string\",\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDTypeCarrierQuotationConditionRule\": 5,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f729843-27f0-4c34-b2cf-a7754dcf7abf", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CarrierQuotationRuleName\": \"string\",\n \"Priority\": 8275,\n \"Status\": 1,\n \"DateFrom\": \"1951-05-31\",\n \"DateTo\": \"2024-07-08\",\n \"IDTypeCarrierQuotationActionRule\": 13,\n \"ActionValue\": \"string\",\n \"Conditions\": [\n {\n \"IDTypeCarrierQuotationConditionRule\": 6,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDTypeCarrierQuotationConditionRule\": 5,\n \"ConditionValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ef36383-5316-4dbf-809e-145f94333b8b", "name": "Exclui uma regra de simulação de frete", "request": { "name": "Exclui uma regra de simulação de frete", "description": { "content": "**Exclusão lógica** — a regra é marcada como excluída (`Status` `2`) em vez de ser apagada. Ela deixa de aparecer na listagem de regras (que traz apenas os status `0` e `1`) e deixa de ser considerada nas próximas cotações de frete. Devolve a string literal `\"Sucesso!\"`.", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "01c54565-892b-4dbe-95fe-f198c73a5382", "name": "Regra excluída.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Sucesso!\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13fc7c6e-d71e-4a86-90dc-7ac7630664af", "name": "`[BadRequest] - Regra de cotação não existe`; `[BadRequest] - Erro ao executar ação`.", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b7ab684-c423-4f1b-8f5b-72a3d7baaa47", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "rule", ":idcarrierquotationrule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotationrule", "description": "(Required) Identificador da regra." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad5131de-9471-4a12-981c-8e89c6760a4a", "name": "Lista simulações de frete", "request": { "name": "Lista simulações de frete", "description": { "content": "Lista as simulações de frete já feitas pela empresa, ordenadas por `IDCarrierQuotation` DESC (até 5000 por página). Cada item traz cabeçalho da simulação (CEP destino, peso, dimensões totais, valor da nota, usuário que rodou, integração de origem quando veio de canal externo) e o resumo das transportadoras que responderam (`CarriersName` — lista de razões sociais separadas por vírgula).\n\nNão devolve as linhas detalhadas de cada transportadora — para isso use `GET /carrier/quotation/{idcarrierquotation}`.", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Filtra `RecordTimestamp` ≥ esta data." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Filtra `RecordTimestamp` ≤ esta data 23:59:59." }, { "disabled": false, "key": "ShippingPostalCode", "value": "string", "description": "Filtra por CEP destino (apenas dígitos; pontuação é ignorada na comparação)." }, { "disabled": false, "key": "Description", "value": "string", "description": "Busca parcial (`LIKE`) por descrição." }, { "disabled": false, "key": "IDCarrierQuotation", "value": "2232", "description": "Filtra por id da simulação." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "Filtra simulações originadas de uma integração específica." }, { "disabled": false, "key": "Page", "value": "4675", "description": "Página de paginação (offset = `Page * 5000`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a88b46fc-a8bb-422e-93c5-509d7d5b478a", "name": "Lista das simulações (até 5000 por página).", "originalRequest": { "url": { "path": [ "carrier", "quotation" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "ShippingPostalCode", "value": "string" }, { "key": "Description", "value": "string" }, { "key": "IDCarrierQuotation", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "Page", "value": "4675" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierQuotation\": 1777,\n \"RecordTimestamp\": \"2008-01-22T13:24:59.132Z\",\n \"AccountName\": \"string\",\n \"Login\": \"string\",\n \"Description\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"string\",\n \"Weight\": 3040.0225645475066,\n \"Height\": 2799.504256448104,\n \"Width\": 8144.6696264027005,\n \"Length\": 9442.540250542872,\n \"ValueInvoice\": 654.3901598873192,\n \"Volumes\": 2485,\n \"IDOrder\": 9503,\n \"IDCompanyIntegration\": 2998,\n \"CompanyIntegration\": \"string\",\n \"IDSkuHub\": \"string\",\n \"CarriersName\": \"string\",\n \"CarrierQuotationUUID\": \"string\"\n },\n {\n \"IDCarrierQuotation\": 6248,\n \"RecordTimestamp\": \"2017-07-02T21:47:30.014Z\",\n \"AccountName\": \"string\",\n \"Login\": \"string\",\n \"Description\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"string\",\n \"Weight\": 8694.828140267635,\n \"Height\": 714.8296782443886,\n \"Width\": 5676.770416765895,\n \"Length\": 3343.402352197511,\n \"ValueInvoice\": 7668.435158270146,\n \"Volumes\": 7017,\n \"IDOrder\": 7506,\n \"IDCompanyIntegration\": 3864,\n \"CompanyIntegration\": \"string\",\n \"IDSkuHub\": \"string\",\n \"CarriersName\": \"string\",\n \"CarrierQuotationUUID\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65eb05e4-619c-4169-9b73-1eaae8bc91eb", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "quotation" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "ShippingPostalCode", "value": "string" }, { "key": "Description", "value": "string" }, { "key": "IDCarrierQuotation", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "Page", "value": "4675" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86d8aa59-45fb-434c-b928-36fa652d6efc", "name": "Roda uma simulação de frete", "request": { "name": "Roda uma simulação de frete", "description": { "content": "Roda uma cotação para o CEP destino + lista de volumes/produtos.\n\nValidações iniciais (retornam 400):\n- `ShippingPostalCode` precisa estar preenchido.\n- Pelo menos 1 item em `Quotations` com `Weight > 0`.\n- CEP precisa existir na base de CEPs (caso contrário grava erro tipo `3` em `CarrierQuotationError`).\n\nLógica:\n- Peso total = soma dos `Weight` de cada item.\n- Largura total = soma dos `Width`.\n- Altura e comprimento totais = **máximo** entre os itens.\n- Para cada transportadora ativa de leilão de frete (`CarrierAuction = 1`):\n - Calcula cubagem usando `CarrierCubageKmM` (padrão 167) e compara com `CarrierCubageFreeWeight` para definir `WeightSelected` (peso real ou cubado).\n - Busca a faixa de CEP em `CarrierScope`; se não atende, marca `Attended=0`.\n - Busca preço em `CarrierRate` por `RateType` + `WeightFrom/WeightTo`; quando o peso excede a maior faixa e existe entrada com `WeightTo=-1`, extrapola linearmente.\n - Soma componentes do frete (rate, gris, advalorem, pedágio, taxas de difícil acesso, despacho, etc.) → subtotal.\n - Aplica ICMS interestadual (se origem e destino diferem de estado **e** transportadora não tem `CarrierICMSIncluded`).\n - Aplica `CarrierAuctionPenalty` da transportadora e regras de **Regras Simulação Frete** (adição de dias e/ou valor).\n- Persiste cabeçalho em `CarrierQuotation` e linhas em `CarrierQuotationRate`.\n\nDevolve um array com 1 item: o detalhe da simulação criada (mesmo formato do GET por id).", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ShippingPostalCode\": \"string\",\n \"Quotations\": [\n {\n \"Weight\": 8875.436948871202,\n \"Height\": 6083.486083866616,\n \"Width\": 6890.771459609526,\n \"Length\": 2160.42752661201,\n \"ValueInvoice\": 3576.9669630317467,\n \"Quantity\": 1457.2316566133536\n }\n ],\n \"Description\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"IDOrder\": 241,\n \"IDCompanyIntegration\": 921,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "179ff89d-fb64-4a90-acd4-65dc4f8fc918", "name": "Simulação criada.", "originalRequest": { "url": { "path": [ "carrier", "quotation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingPostalCode\": \"string\",\n \"Quotations\": [\n {\n \"Weight\": 8875.436948871202,\n \"Height\": 6083.486083866616,\n \"Width\": 6890.771459609526,\n \"Length\": 2160.42752661201,\n \"ValueInvoice\": 3576.9669630317467,\n \"Quantity\": 1457.2316566133536\n }\n ],\n \"Description\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"IDOrder\": 241,\n \"IDCompanyIntegration\": 921,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierQuotation\": 458,\n \"RecordTimestamp\": \"1954-01-28T20:41:48.561Z\",\n \"AccountName\": \"string\",\n \"Login\": \"string\",\n \"Description\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"string\",\n \"Weight\": 647.8392402292955,\n \"Height\": 8632.964137103163,\n \"Width\": 6405.795738582867,\n \"Length\": 1233.5569866921858,\n \"ValueInvoice\": 1039.6193342536874,\n \"Volumes\": 34,\n \"IDOrder\": 1482,\n \"IDCompanyIntegration\": 9230,\n \"CompanyIntegration\": \"string\",\n \"IDSkuHub\": \"string\",\n \"CarriersName\": \"string\",\n \"CarrierQuotationUUID\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"ShippingIbgeCode\": \"string\",\n \"ShippingSameCity\": 1,\n \"CarrierQuotations\": [\n {\n \"IDCarrierQuotationRate\": 5905,\n \"IDCarrier\": 6715,\n \"SupplierNameCorporateName\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"CarrierModal\": \"string\",\n \"Attended\": 0,\n \"AttendedDescription\": \"string\",\n \"RateType\": \"string\",\n \"WeightSelected\": 8665.282630176484,\n \"WeightCubed\": 8862.73930283288,\n \"Weight\": 7960.706666412105,\n \"CarrierCubageKmM\": 3393.721250066406,\n \"CarrierCubageFreeWeight\": 8740.87648733643,\n \"DaysTime\": 6786.253758663923,\n \"CarrierAdditionalBusinessDays\": 9964.900728030625,\n \"CutDaysTime\": 4368,\n \"RuleAdditionalDays\": 1629.8870228220608,\n \"TotalDaysTime\": 1771.093685189209,\n \"TotalShowDaysTime\": 4410.634822862913,\n \"ShipingValue\": 1687.437141169439,\n \"AdvaloremValue\": 4181.368559914742,\n \"AdvaloremValuePercent\": 4921.537675891912,\n \"GrisValue\": 4515.637722938777,\n \"GrisValuePercent\": 1705.0868910424865,\n \"TollValue\": 8821.545111774065,\n \"TollFractionValue\": 887.7568071725906,\n \"AccessDifficultyRateValue\": 6068.57490746282,\n \"DispatchFeeValue\": 6122.011136206144,\n \"DeliveryDifficultyRateValue\": 260.0260875195071,\n \"SECCATValue\": 7072.043706688056,\n \"TrafficRestrictionFeeValue\": 8398.96938149032,\n \"AdministrationFeeValue\": 2281.27903655597,\n \"CTEFeeValue\": 9947.614198065097,\n \"SUFRAMAFeeValue\": 1158.8548388477936,\n \"FluvialInsuranceFee\": 1435.2866143485187,\n \"OtherFee\": 3486.622568921682,\n \"OtherFeeValue\": 8536.529038164534,\n \"IcmsValue\": 8107.314403320829,\n \"AdjustedValue\": 5426.139221816211,\n \"RuleAdditionalValue\": 9113.013007809986,\n \"CarrierQuotationRuleValueName\": \"string\",\n \"CarrierQuotationRuleDaysName\": \"string\",\n \"IDCarrierQuotationRuleValue\": 770,\n \"IDCarrierQuotationRuleDays\": 4398,\n \"PriceRounding\": 4927.345812507384,\n \"SubtotalShippingValue\": 1664.6169812249268,\n \"TotalShippingValue\": 4695.442259966134,\n \"IcmsValuePercent\": 746.5011680225886,\n \"ShippingShowValue\": 2399.898164656562\n },\n {\n \"IDCarrierQuotationRate\": 4411,\n \"IDCarrier\": 1052,\n \"SupplierNameCorporateName\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"CarrierModal\": \"string\",\n \"Attended\": 4,\n \"AttendedDescription\": \"string\",\n \"RateType\": \"string\",\n \"WeightSelected\": 9745.559752080613,\n \"WeightCubed\": 9744.189140211847,\n \"Weight\": 5242.536222327812,\n \"CarrierCubageKmM\": 6781.450837820007,\n \"CarrierCubageFreeWeight\": 1831.0472948147983,\n \"DaysTime\": 2681.471260710846,\n \"CarrierAdditionalBusinessDays\": 4566.94132577913,\n \"CutDaysTime\": 7705,\n \"RuleAdditionalDays\": 7097.630551696719,\n \"TotalDaysTime\": 7619.929156915071,\n \"TotalShowDaysTime\": 8691.804670062886,\n \"ShipingValue\": 7787.320660392316,\n \"AdvaloremValue\": 7290.361213027596,\n \"AdvaloremValuePercent\": 4439.580720103389,\n \"GrisValue\": 6212.713995171744,\n \"GrisValuePercent\": 2463.953002294175,\n \"TollValue\": 5110.898020189383,\n \"TollFractionValue\": 6318.360078223395,\n \"AccessDifficultyRateValue\": 6536.140511396397,\n \"DispatchFeeValue\": 5552.1045827670505,\n \"DeliveryDifficultyRateValue\": 1159.0078280019234,\n \"SECCATValue\": 843.2323492664251,\n \"TrafficRestrictionFeeValue\": 5083.1614742356605,\n \"AdministrationFeeValue\": 4350.538318364452,\n \"CTEFeeValue\": 734.3811801043221,\n \"SUFRAMAFeeValue\": 686.7570475133023,\n \"FluvialInsuranceFee\": 1086.8332982986174,\n \"OtherFee\": 2168.0685594644933,\n \"OtherFeeValue\": 5214.660351347961,\n \"IcmsValue\": 7191.9587751039635,\n \"AdjustedValue\": 5564.748780372423,\n \"RuleAdditionalValue\": 2798.4355004243544,\n \"CarrierQuotationRuleValueName\": \"string\",\n \"CarrierQuotationRuleDaysName\": \"string\",\n \"IDCarrierQuotationRuleValue\": 9301,\n \"IDCarrierQuotationRuleDays\": 8090,\n \"PriceRounding\": 1356.1811805072987,\n \"SubtotalShippingValue\": 4664.4619595924805,\n \"TotalShippingValue\": 3209.89224780011,\n \"IcmsValuePercent\": 7595.452832038432,\n \"ShippingShowValue\": 6829.16424670299\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71b2430a-d2c1-47b5-b501-9518a12aab35", "name": "`Precisa enviar o CEP destino`; `Peso precisa ser maior que zero`; `Dados para cotação não enviados`; `CEP destino não existe`; `Empresa não localizada (2)`. (Mensagens sem o prefixo `[BadRequest]`.)", "originalRequest": { "url": { "path": [ "carrier", "quotation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingPostalCode\": \"string\",\n \"Quotations\": [\n {\n \"Weight\": 8875.436948871202,\n \"Height\": 6083.486083866616,\n \"Width\": 6890.771459609526,\n \"Length\": 2160.42752661201,\n \"ValueInvoice\": 3576.9669630317467,\n \"Quantity\": 1457.2316566133536\n }\n ],\n \"Description\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"IDOrder\": 241,\n \"IDCompanyIntegration\": 921,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c578855f-d607-49e6-9746-d31c5c310cc4", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "carrier", "quotation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingPostalCode\": \"string\",\n \"Quotations\": [\n {\n \"Weight\": 8875.436948871202,\n \"Height\": 6083.486083866616,\n \"Width\": 6890.771459609526,\n \"Length\": 2160.42752661201,\n \"ValueInvoice\": 3576.9669630317467,\n \"Quantity\": 1457.2316566133536\n }\n ],\n \"Description\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"IDOrder\": 241,\n \"IDCompanyIntegration\": 921,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "210794a2-94a9-4306-b775-b8329a2af1e7", "name": "Detalha uma simulação de frete", "request": { "name": "Detalha uma simulação de frete", "description": { "content": "Retorna a simulação com **todas** as linhas por transportadora. Cada linha (`CarrierQuotations[]`) traz:\n\n- `IDCarrier` + `SupplierNameCorporateName` + `CarrierLogoUrl` + `CarrierModal` (modalidade da transportadora).\n- `Attended` (1=Atende, 0=Não atende, 3=Excluído por regra, 4=Fora da faixa) e `AttendedDescription` (texto pronto para exibição).\n- Componentes do preço: `ShipingValue`, `GrisValue`, `AdvaloremValue`, `TollValue`, `AccessDifficultyRateValue`, `DispatchFeeValue`, `DeliveryDifficultyRateValue`, `SECCATValue`, `TollFractionValue`, `TrafficRestrictionFeeValue`, `AdministrationFeeValue`, `CTEFeeValue`, `SUFRAMAFeeValue`, `FluvialInsuranceFee`, `OtherFee`, `OtherFeeValue`, `IcmsValue`.\n- Totais calculados pelo sistema: `SubtotalShippingValue` (soma dos componentes), `TotalShippingValue` (subtotal + ICMS), `IcmsValuePercent`, `ShippingShowValue` (total + ajustes de regra + `PriceRounding`).\n- Prazo: `DaysTime` (transportadora) + `CarrierAdditionalBusinessDays` (transportadora) + `CutDaysTime` (1 quando saiu fora do horário de corte) + `RuleAdditionalDays` (regra) → `TotalDaysTime` / `TotalShowDaysTime`.\n- Cubagem: `WeightCubed`, `WeightSelected`, `CarrierCubageKmM`, `CarrierCubageFreeWeight`.\n- Quando regras de simulação foram aplicadas: `CarrierQuotationRuleValueName`, `CarrierQuotationRuleDaysName`, `RuleAdditionalValue`, `RuleAdditionalDays`.\n\nOrdenação: `Attended DESC` (quem atende primeiro), `TotalDaysTime ASC` (prazo curto primeiro), `TotalShippingValue ASC` (preço baixo).", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation", ":idcarrierquotation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotation", "description": "(Required) Identificador da simulação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c4b9ec12-fe37-425c-a583-6c0f635dd36d", "name": "Detalhe da simulação. `[]` quando o id não existe ou pertence a outra empresa.", "originalRequest": { "url": { "path": [ "carrier", "quotation", ":idcarrierquotation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotation", "description": "(Required) Identificador da simulação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierQuotation\": 7662,\n \"RecordTimestamp\": \"2001-12-07T09:58:36.891Z\",\n \"AccountName\": \"string\",\n \"Login\": \"string\",\n \"Description\": \"string\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingState\": \"string\",\n \"Weight\": 9165.662974097717,\n \"Height\": 2055.4537075942635,\n \"Width\": 7999.388882112912,\n \"Length\": 6274.89776214873,\n \"ValueInvoice\": 2467.5773812743505,\n \"Volumes\": 154,\n \"IDOrder\": 659,\n \"IDCompanyIntegration\": 8887,\n \"CompanyIntegration\": \"string\",\n \"IDSkuHub\": \"string\",\n \"CarriersName\": \"string\",\n \"CarrierQuotationUUID\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"ShippingIbgeCode\": \"string\",\n \"ShippingSameCity\": 1,\n \"CarrierQuotations\": [\n {\n \"IDCarrierQuotationRate\": 8709,\n \"IDCarrier\": 1731,\n \"SupplierNameCorporateName\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"CarrierModal\": \"string\",\n \"Attended\": 3,\n \"AttendedDescription\": \"string\",\n \"RateType\": \"string\",\n \"WeightSelected\": 3699.7257725901322,\n \"WeightCubed\": 7754.5551477166155,\n \"Weight\": 5015.904284566055,\n \"CarrierCubageKmM\": 8290.041930491687,\n \"CarrierCubageFreeWeight\": 2948.4285612094886,\n \"DaysTime\": 6882.19518409193,\n \"CarrierAdditionalBusinessDays\": 1358.87248690981,\n \"CutDaysTime\": 8238,\n \"RuleAdditionalDays\": 5240.865199648403,\n \"TotalDaysTime\": 7571.576272758889,\n \"TotalShowDaysTime\": 972.340343018605,\n \"ShipingValue\": 1947.5659644857046,\n \"AdvaloremValue\": 3883.191173291487,\n \"AdvaloremValuePercent\": 4006.246011961778,\n \"GrisValue\": 5109.0972112174595,\n \"GrisValuePercent\": 2560.4270465415757,\n \"TollValue\": 9571.057403368823,\n \"TollFractionValue\": 669.1866752926389,\n \"AccessDifficultyRateValue\": 9198.958577603207,\n \"DispatchFeeValue\": 1846.223137225409,\n \"DeliveryDifficultyRateValue\": 3434.683456791925,\n \"SECCATValue\": 5063.382907155098,\n \"TrafficRestrictionFeeValue\": 963.325269812918,\n \"AdministrationFeeValue\": 4572.414328748196,\n \"CTEFeeValue\": 5582.157822252229,\n \"SUFRAMAFeeValue\": 9811.612260004506,\n \"FluvialInsuranceFee\": 2818.1140164751773,\n \"OtherFee\": 6467.529251284632,\n \"OtherFeeValue\": 8352.494517941075,\n \"IcmsValue\": 40.17667280813653,\n \"AdjustedValue\": 5055.176298768384,\n \"RuleAdditionalValue\": 3574.822996408489,\n \"CarrierQuotationRuleValueName\": \"string\",\n \"CarrierQuotationRuleDaysName\": \"string\",\n \"IDCarrierQuotationRuleValue\": 107,\n \"IDCarrierQuotationRuleDays\": 6594,\n \"PriceRounding\": 6380.6232017170505,\n \"SubtotalShippingValue\": 8863.600448645155,\n \"TotalShippingValue\": 9748.840830780391,\n \"IcmsValuePercent\": 9876.633751868863,\n \"ShippingShowValue\": 8737.65903839861\n },\n {\n \"IDCarrierQuotationRate\": 4506,\n \"IDCarrier\": 3187,\n \"SupplierNameCorporateName\": \"string\",\n \"CarrierLogoUrl\": \"string\",\n \"CarrierModal\": \"string\",\n \"Attended\": 0,\n \"AttendedDescription\": \"string\",\n \"RateType\": \"string\",\n \"WeightSelected\": 5185.454642564162,\n \"WeightCubed\": 9668.350497433454,\n \"Weight\": 1821.0059186297967,\n \"CarrierCubageKmM\": 1379.8386308609633,\n \"CarrierCubageFreeWeight\": 6442.292822262463,\n \"DaysTime\": 9414.940322918277,\n \"CarrierAdditionalBusinessDays\": 5768.297077982876,\n \"CutDaysTime\": 4566,\n \"RuleAdditionalDays\": 5786.279064572093,\n \"TotalDaysTime\": 3919.796088214096,\n \"TotalShowDaysTime\": 8822.28198694403,\n \"ShipingValue\": 3350.6550567453774,\n \"AdvaloremValue\": 5888.465818517685,\n \"AdvaloremValuePercent\": 772.1391867579231,\n \"GrisValue\": 505.09402972986226,\n \"GrisValuePercent\": 5771.503501553588,\n \"TollValue\": 6971.6257295592295,\n \"TollFractionValue\": 9390.89648815552,\n \"AccessDifficultyRateValue\": 4675.901928827613,\n \"DispatchFeeValue\": 6011.999159306123,\n \"DeliveryDifficultyRateValue\": 6816.223346457054,\n \"SECCATValue\": 3561.7338129902487,\n \"TrafficRestrictionFeeValue\": 8121.9918843815385,\n \"AdministrationFeeValue\": 5457.361556680163,\n \"CTEFeeValue\": 5638.4360645350125,\n \"SUFRAMAFeeValue\": 5984.178726886533,\n \"FluvialInsuranceFee\": 8661.057596486145,\n \"OtherFee\": 4711.16220980778,\n \"OtherFeeValue\": 1620.2452152975134,\n \"IcmsValue\": 9976.089767072033,\n \"AdjustedValue\": 4717.914313913885,\n \"RuleAdditionalValue\": 4568.017460773009,\n \"CarrierQuotationRuleValueName\": \"string\",\n \"CarrierQuotationRuleDaysName\": \"string\",\n \"IDCarrierQuotationRuleValue\": 8085,\n \"IDCarrierQuotationRuleDays\": 7818,\n \"PriceRounding\": 751.6391069973727,\n \"SubtotalShippingValue\": 7311.01319972209,\n \"TotalShippingValue\": 4544.088564049371,\n \"IcmsValuePercent\": 748.855818125036,\n \"ShippingShowValue\": 4146.2994011806995\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb23f267-de82-432e-bff7-9b11a9d8651a", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "carrier", "quotation", ":idcarrierquotation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarrierquotation", "description": "(Required) Identificador da simulação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "661045a2-b751-4164-bea2-c5d058c7c819", "name": "Lista erros de simulação de frete", "request": { "name": "Lista erros de simulação de frete", "description": { "content": "Lista os erros de simulação de frete da empresa em páginas de até 3000 registros (avance com `Page`), ordenados por `IDCarrierQuotationError` decrescente.", "type": "text/plain" }, "url": { "path": [ "carrier", "quotation", "error" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Filtra erros com `RecordTimestamp` ≥ esta data." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Filtra erros com `RecordTimestamp` ≤ esta data 23:59:59." }, { "disabled": false, "key": "Page", "value": "0", "description": "Índice da página para paginação, começando em `0`. Cada página retorna até 3000 erros; informe `1` para os próximos 3000, e assim por diante. Quando omitido, assume `0` (primeira página)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "97464503-c7b1-438d-ba92-3c0d94e3b4a8", "name": "Lista dos erros (até 3000).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "error" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDCarrierQuotationError\": 3450,\n \"RecordTimestamp\": \"1985-03-25T11:46:41.057Z\",\n \"ShippingPostalCode\": \"string\",\n \"RecordUserCreated\": 2308,\n \"IDTypeCarrierQuotationError\": 6,\n \"TypeCarrierQuotationError\": \"string\",\n \"IDSkuHub\": \"string\",\n \"IDCompanyIntegration\": 9833,\n \"CompanyIntegrationName\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDCarrierQuotationError\": 2122,\n \"RecordTimestamp\": \"1994-10-13T01:30:20.343Z\",\n \"ShippingPostalCode\": \"string\",\n \"RecordUserCreated\": 4523,\n \"IDTypeCarrierQuotationError\": 1,\n \"TypeCarrierQuotationError\": \"string\",\n \"IDSkuHub\": \"string\",\n \"IDCompanyIntegration\": 6209,\n \"CompanyIntegrationName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94417ce1-f691-49aa-aa9f-e58a21513088", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "quotation", "error" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8bdf21c1-9643-4e1e-b765-08ea21298eea", "name": "Códigos Similares", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "de031594-4059-4b03-b74a-f3aea907cc7d", "name": "Lista códigos similares", "request": { "name": "Lista códigos similares", "description": { "content": "Lista os códigos similares da empresa autenticada com o grupo (`SkuGroupName`) e a conta (`AccountName`) já resolvidos. Em contexto multi-conta (`accountname = all`), traz todas as contas acessíveis. Ordenado por `SkuGroupName ASC`, paginado em blocos de 10000.", "type": "text/plain" }, "url": { "path": [ "sku", "similar-code" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SkuGroupName", "value": "string", "description": "Filtra pelo nome exato do grupo SKU (igualdade)." }, { "disabled": false, "key": "IDStockKeepingUnitGroup", "value": "string", "description": "Filtra pelo id do grupo SKU." }, { "disabled": false, "key": "SkuSimilarCode", "value": "string", "description": "Filtra pelo código similar (igualdade)." }, { "disabled": false, "key": "SkuSimilarCodeTag", "value": "string", "description": "Filtra pela tag do código similar (igualdade)." }, { "disabled": false, "key": "IDStockKeepingUnitSimilarCode", "value": "string", "description": "Filtra pelo id do código similar." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Página (offset = `Page * 10000`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7b63d5b8-1d39-4420-a94b-fee968a7df42", "name": "Lista de códigos similares.", "originalRequest": { "url": { "path": [ "sku", "similar-code" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SkuGroupName", "value": "string" }, { "key": "IDStockKeepingUnitGroup", "value": "string" }, { "key": "SkuSimilarCode", "value": "string" }, { "key": "SkuSimilarCodeTag", "value": "string" }, { "key": "IDStockKeepingUnitSimilarCode", "value": "string" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSimilarCode\": 5982,\n \"RecordTimestamp\": \"1963-10-04T08:33:40.885Z\",\n \"IDStockKeepingUnitGroup\": 307,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\",\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 4752,\n \"RecordTimestamp\": \"1963-02-18T22:28:33.035Z\",\n \"IDStockKeepingUnitGroup\": 5408,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\",\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4f3c68a-340b-45e4-aea1-aa97370fb670", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "similar-code" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SkuGroupName", "value": "string" }, { "key": "IDStockKeepingUnitGroup", "value": "string" }, { "key": "SkuSimilarCode", "value": "string" }, { "key": "SkuSimilarCodeTag", "value": "string" }, { "key": "IDStockKeepingUnitSimilarCode", "value": "string" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd03ec71-5667-4c3b-9941-643e4edc6737", "name": "Cria código similar", "request": { "name": "Cria código similar", "description": { "content": "Cria um código similar vinculado a um grupo SKU da empresa autenticada. Valida que o grupo existe e pertence à empresa, e que `SkuSimilarCode` ainda não existe no grupo. Após inserir, reinvoca `skuSimilarCodeList` e devolve o código criado (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "sku", "similar-code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "094ea869-3514-40e9-817b-4d29e2da8ea5", "name": "Código criado (devolve o código em formato de lista).", "originalRequest": { "url": { "path": [ "sku", "similar-code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSimilarCode\": 5982,\n \"RecordTimestamp\": \"1963-10-04T08:33:40.885Z\",\n \"IDStockKeepingUnitGroup\": 307,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\",\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 4752,\n \"RecordTimestamp\": \"1963-02-18T22:28:33.035Z\",\n \"IDStockKeepingUnitGroup\": 5408,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\",\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77b44bde-51e0-4fa3-96f0-725e94df7eeb", "name": "`[BadRequest] - Grupo não existe`; `[BadRequest] - Já existe esse código cadastrado para o grupo`.", "originalRequest": { "url": { "path": [ "sku", "similar-code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e19bd9f-e00a-4fe9-9994-898c1c1b73b3", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "similar-code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c69dfc45-2983-4074-b89d-833f44c07c48", "name": "Lista tags de códigos similares", "request": { "name": "Lista tags de códigos similares", "description": { "content": "Lista as tags (`SkuSimilarCodeTag`) já em uso pelos códigos similares da empresa autenticada, em ordem alfabética. Ignora valores nulos e vazios. Usada para popular o autocomplete do campo `SkuSimilarCodeTag` na tela.", "type": "text/plain" }, "url": { "path": [ "sku", "similar-code", "tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "eef9852a-138d-4f4a-9d66-cb674eddafcd", "name": "Lista de tags distintas.", "originalRequest": { "url": { "path": [ "sku", "similar-code", "tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"SkuSimilarCodeTag\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"SkuSimilarCodeTag\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a39fdd5c-b13e-49c6-84b7-4f6317558a6d", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "similar-code", "tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ebc596e-995d-4e38-92f2-f00264af3b4c", "name": "Atualiza código similar", "request": { "name": "Atualiza código similar", "description": { "content": "Atualiza grupo, código e/ou tag de um código similar da empresa autenticada. Quando `SkuSimilarCode` muda, valida que o novo código ainda não existe no grupo. Quando `IDStockKeepingUnitGroup` muda, valida que o novo grupo pertence à empresa. Após atualizar, reinvoca `skuSimilarCodeList` e devolve o registro (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d7050642-33b5-4365-bad3-4bfb40b54d25", "name": "Código atualizado (em formato de lista).", "originalRequest": { "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSimilarCode\": 5982,\n \"RecordTimestamp\": \"1963-10-04T08:33:40.885Z\",\n \"IDStockKeepingUnitGroup\": 307,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\",\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 4752,\n \"RecordTimestamp\": \"1963-02-18T22:28:33.035Z\",\n \"IDStockKeepingUnitGroup\": 5408,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\",\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3837fee1-44be-43ca-862f-44c91e261fa0", "name": "`[BadRequest] - Código similar não existe`; `[BadRequest] - Grupo não existe`; `[BadRequest] - Já existe esse código cadastrado para o grupo`.", "originalRequest": { "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4a50add-d419-482d-86d4-27aa9171a13e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 8726,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b02d1873-9615-4a79-872b-d4d324d4f596", "name": "Exclui código similar", "request": { "name": "Exclui código similar", "description": { "content": "Exclui fisicamente o código similar da empresa autenticada. Sem regras de bloqueio — o vínculo é apenas com o grupo SKU, que não trava a exclusão.", "type": "text/plain" }, "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f3020cb9-16d2-4f71-ab4f-3a3e3413b43e", "name": "Código excluído. Corpo: string `\"Sucesso\"`.", "originalRequest": { "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "303b7d39-49a7-4254-867d-54668bf802e0", "name": "`[BadRequest] - Código similar não existe`.", "originalRequest": { "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d62473a6-fc2f-4115-ab6c-f43213485a2f", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "similar-code", ":idstockkeepingunitsimilarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsimilarcode", "description": "(Required) Id do código similar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "33d13236-73e0-48d1-a65a-7d2c747b1429", "name": "Códigos de Barras", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7fe10b21-91cb-4850-9f55-071c949ac49f", "name": "Adiciona um código de barras adicional ao SKU", "request": { "name": "Adiciona um código de barras adicional ao SKU", "description": { "content": "Cadastra um código de barras adicional (além do principal). Bloqueia se o código já existe como principal, adicional ou de embalagem em qualquer SKU da empresa.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"BarCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9b4420a4-bda7-4f8a-bc14-7713be483605", "name": "Código cadastrado. Retorna o detalhe do SKU.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"BarCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSku\": 4077,\n \"IDCompany\": 874,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 214,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 7592,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 3,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 1,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 3641,\n \"Brand\": \"string\",\n \"IDCategory\": 7781,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 1406,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 2741,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 8311.907150501776,\n \"SkuLength\": 4212.702835099649,\n \"SkuWidth\": 9248.599123458504,\n \"SkuWeight\": 6184.29068786535,\n \"SkuWeightNet\": 6013.372428710737,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 3334,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 474.90814923510925,\n \"CostAverage\": 3033.0177600663656,\n \"CostLastPurchase\": 528.633615765699,\n \"InventoryValue\": 6270.056088699192,\n \"Batch\": 1271,\n \"BatchRequired\": 7402,\n \"BestBeforeRequired\": 7222,\n \"BestBeforeMinimumDays\": 2860,\n \"BestBeforeDays\": 9537,\n \"RastroControl\": 1048,\n \"SerialNumber\": 8440,\n \"Package\": 9931,\n \"PackageOccupation\": 4779.339460699288,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 1865.3136916885992,\n \"MinimumPickingLocationQuantity\": 6950.0676478602145,\n \"MaximumPickingLocationQuantity\": 9917.874212829973,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 2930,\n \"BuyOrderAlertManualQuantity\": 9779,\n \"KitsRelatedCount\": 3496,\n \"InfiniteInventory\": 8930,\n \"OwnProduction\": 28,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 8617,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 9232,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 7956,\n \"NfeFactorPercentSku\": 9496.575738417903,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 9897.119761380307,\n \"LeadTimeDays\": 7292,\n \"EstimatedDateArrival\": \"1965-06-03\",\n \"ShareProductImage\": 9937,\n \"KitAutomaticMeasureUpdate\": 5308,\n \"KitAutomaticPricingUpdate\": 6223,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 3684,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"1955-08-16T14:58:36.855Z\",\n \"DateLastRecordModification\": \"2023-05-23T01:02:11.041Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 73,\n \"IDSupplier\": 3330,\n \"PackageSize\": 5540.990421126066,\n \"QuantityMultiply\": 2427.274349676063,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 7996,\n \"IDSupplier\": 1486,\n \"PackageSize\": 790.7365089522477,\n \"QuantityMultiply\": 5447.883615656641,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 1095,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 6112,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 4475,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5567,\n \"IDSkuKit\": 7462,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 6704,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8854,\n \"IDSkuKit\": 1052,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n },\n {\n \"IDSku\": 5933,\n \"IDCompany\": 6385,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 3696,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 2454,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 0,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 3,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 6126,\n \"Brand\": \"string\",\n \"IDCategory\": 3234,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 4142,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 7803,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 5970.332044071957,\n \"SkuLength\": 1119.3015878038582,\n \"SkuWidth\": 5281.924962571467,\n \"SkuWeight\": 7192.346192288548,\n \"SkuWeightNet\": 1148.6528765236126,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 7928,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 7405.774613144274,\n \"CostAverage\": 8855.428105505438,\n \"CostLastPurchase\": 5845.3830110143845,\n \"InventoryValue\": 9169.378073162017,\n \"Batch\": 4710,\n \"BatchRequired\": 320,\n \"BestBeforeRequired\": 6340,\n \"BestBeforeMinimumDays\": 5043,\n \"BestBeforeDays\": 7442,\n \"RastroControl\": 499,\n \"SerialNumber\": 9744,\n \"Package\": 7124,\n \"PackageOccupation\": 5031.4296880254215,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 7889.386758528174,\n \"MinimumPickingLocationQuantity\": 4267.677432640593,\n \"MaximumPickingLocationQuantity\": 5937.101338660651,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 3823,\n \"BuyOrderAlertManualQuantity\": 8201,\n \"KitsRelatedCount\": 2629,\n \"InfiniteInventory\": 5053,\n \"OwnProduction\": 6326,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 6771,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 2103,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 2528,\n \"NfeFactorPercentSku\": 2594.0660458284005,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 5758.468788600874,\n \"LeadTimeDays\": 7062,\n \"EstimatedDateArrival\": \"2003-04-30\",\n \"ShareProductImage\": 2279,\n \"KitAutomaticMeasureUpdate\": 4829,\n \"KitAutomaticPricingUpdate\": 8576,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 5594,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"2023-02-19T05:10:27.160Z\",\n \"DateLastRecordModification\": \"1982-06-13T08:44:09.886Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 7335,\n \"IDSupplier\": 2751,\n \"PackageSize\": 3071.4360812565733,\n \"QuantityMultiply\": 6980.519976325545,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 158,\n \"IDSupplier\": 5457,\n \"PackageSize\": 3851.4787265641635,\n \"QuantityMultiply\": 9663.355564964791,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 6813,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 9857,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 842,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3260,\n \"IDSkuKit\": 9797,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 2306,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 2558,\n \"IDSkuKit\": 782,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd7b880d-7c0e-4a3b-bf67-609c6cab80a5", "name": "Prefixo `[BadRequest]`. Mensagens: `Sku não existe`, `Código de Barras precisa ser preenchido`, `Código de barras embalagem precisa ser preenchido`, `Código de Barras já existe no sku: `, `Código de barras já existe no sku: `.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"BarCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87ceb1cc-3743-44d2-94a8-3a616c897244", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"BarCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfce8cac-9b71-4f8c-8254-ee87dc557414", "name": "Remove um código de barras adicional do SKU", "request": { "name": "Remove um código de barras adicional do SKU", "description": { "content": "Remove o código de barras adicional. Notifica webhooks da empresa.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "barcode", ":idstockkeepingunitbarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcode", "description": "(Required) Identificador do código de barras adicional." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "da80d071-2c45-4eaa-aa94-8e8ce43e2ed7", "name": "Código removido. Retorna o detalhe do SKU.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcode", ":idstockkeepingunitbarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcode", "description": "(Required) Identificador do código de barras adicional." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSku\": 4077,\n \"IDCompany\": 874,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 214,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 7592,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 3,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 1,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 3641,\n \"Brand\": \"string\",\n \"IDCategory\": 7781,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 1406,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 2741,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 8311.907150501776,\n \"SkuLength\": 4212.702835099649,\n \"SkuWidth\": 9248.599123458504,\n \"SkuWeight\": 6184.29068786535,\n \"SkuWeightNet\": 6013.372428710737,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 3334,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 474.90814923510925,\n \"CostAverage\": 3033.0177600663656,\n \"CostLastPurchase\": 528.633615765699,\n \"InventoryValue\": 6270.056088699192,\n \"Batch\": 1271,\n \"BatchRequired\": 7402,\n \"BestBeforeRequired\": 7222,\n \"BestBeforeMinimumDays\": 2860,\n \"BestBeforeDays\": 9537,\n \"RastroControl\": 1048,\n \"SerialNumber\": 8440,\n \"Package\": 9931,\n \"PackageOccupation\": 4779.339460699288,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 1865.3136916885992,\n \"MinimumPickingLocationQuantity\": 6950.0676478602145,\n \"MaximumPickingLocationQuantity\": 9917.874212829973,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 2930,\n \"BuyOrderAlertManualQuantity\": 9779,\n \"KitsRelatedCount\": 3496,\n \"InfiniteInventory\": 8930,\n \"OwnProduction\": 28,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 8617,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 9232,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 7956,\n \"NfeFactorPercentSku\": 9496.575738417903,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 9897.119761380307,\n \"LeadTimeDays\": 7292,\n \"EstimatedDateArrival\": \"1965-06-03\",\n \"ShareProductImage\": 9937,\n \"KitAutomaticMeasureUpdate\": 5308,\n \"KitAutomaticPricingUpdate\": 6223,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 3684,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"1955-08-16T14:58:36.855Z\",\n \"DateLastRecordModification\": \"2023-05-23T01:02:11.041Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 73,\n \"IDSupplier\": 3330,\n \"PackageSize\": 5540.990421126066,\n \"QuantityMultiply\": 2427.274349676063,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 7996,\n \"IDSupplier\": 1486,\n \"PackageSize\": 790.7365089522477,\n \"QuantityMultiply\": 5447.883615656641,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 1095,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 6112,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 4475,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5567,\n \"IDSkuKit\": 7462,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 6704,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8854,\n \"IDSkuKit\": 1052,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n },\n {\n \"IDSku\": 5933,\n \"IDCompany\": 6385,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 3696,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 2454,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 0,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 3,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 6126,\n \"Brand\": \"string\",\n \"IDCategory\": 3234,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 4142,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 7803,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 5970.332044071957,\n \"SkuLength\": 1119.3015878038582,\n \"SkuWidth\": 5281.924962571467,\n \"SkuWeight\": 7192.346192288548,\n \"SkuWeightNet\": 1148.6528765236126,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 7928,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 7405.774613144274,\n \"CostAverage\": 8855.428105505438,\n \"CostLastPurchase\": 5845.3830110143845,\n \"InventoryValue\": 9169.378073162017,\n \"Batch\": 4710,\n \"BatchRequired\": 320,\n \"BestBeforeRequired\": 6340,\n \"BestBeforeMinimumDays\": 5043,\n \"BestBeforeDays\": 7442,\n \"RastroControl\": 499,\n \"SerialNumber\": 9744,\n \"Package\": 7124,\n \"PackageOccupation\": 5031.4296880254215,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 7889.386758528174,\n \"MinimumPickingLocationQuantity\": 4267.677432640593,\n \"MaximumPickingLocationQuantity\": 5937.101338660651,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 3823,\n \"BuyOrderAlertManualQuantity\": 8201,\n \"KitsRelatedCount\": 2629,\n \"InfiniteInventory\": 5053,\n \"OwnProduction\": 6326,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 6771,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 2103,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 2528,\n \"NfeFactorPercentSku\": 2594.0660458284005,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 5758.468788600874,\n \"LeadTimeDays\": 7062,\n \"EstimatedDateArrival\": \"2003-04-30\",\n \"ShareProductImage\": 2279,\n \"KitAutomaticMeasureUpdate\": 4829,\n \"KitAutomaticPricingUpdate\": 8576,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 5594,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"2023-02-19T05:10:27.160Z\",\n \"DateLastRecordModification\": \"1982-06-13T08:44:09.886Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 7335,\n \"IDSupplier\": 2751,\n \"PackageSize\": 3071.4360812565733,\n \"QuantityMultiply\": 6980.519976325545,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 158,\n \"IDSupplier\": 5457,\n \"PackageSize\": 3851.4787265641635,\n \"QuantityMultiply\": 9663.355564964791,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 6813,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 9857,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 842,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3260,\n \"IDSkuKit\": 9797,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 2306,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 2558,\n \"IDSkuKit\": 782,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3079aa76-7337-48f1-917a-e780c215094a", "name": "Prefixo `[BadRequest]`. Mensagem: `Código de barras não existe`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcode", ":idstockkeepingunitbarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcode", "description": "(Required) Identificador do código de barras adicional." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02f37864-335a-46a2-9518-9cb8e567f5b8", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcode", ":idstockkeepingunitbarcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcode", "description": "(Required) Identificador do código de barras adicional." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a20dbbb9-5214-4db4-bd71-cea0a70001c4", "name": "Códigos de Barras (Embalagem)", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7a0bf283-bb6b-47b4-b9bb-a42fad245b1d", "name": "Adiciona um código de barras de embalagem ao SKU", "request": { "name": "Adiciona um código de barras de embalagem ao SKU", "description": { "content": "Cadastra um código de barras de embalagem (caixa, fardo, master) para o SKU, com o fator de conversão para unidades. Valida unicidade contra os demais códigos da empresa.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "barcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7827\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "723353a3-4230-443e-9640-778a75615fc0", "name": "Código cadastrado. Retorna o detalhe do SKU.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7827\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSku\": 4077,\n \"IDCompany\": 874,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 214,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 7592,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 3,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 1,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 3641,\n \"Brand\": \"string\",\n \"IDCategory\": 7781,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 1406,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 2741,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 8311.907150501776,\n \"SkuLength\": 4212.702835099649,\n \"SkuWidth\": 9248.599123458504,\n \"SkuWeight\": 6184.29068786535,\n \"SkuWeightNet\": 6013.372428710737,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 3334,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 474.90814923510925,\n \"CostAverage\": 3033.0177600663656,\n \"CostLastPurchase\": 528.633615765699,\n \"InventoryValue\": 6270.056088699192,\n \"Batch\": 1271,\n \"BatchRequired\": 7402,\n \"BestBeforeRequired\": 7222,\n \"BestBeforeMinimumDays\": 2860,\n \"BestBeforeDays\": 9537,\n \"RastroControl\": 1048,\n \"SerialNumber\": 8440,\n \"Package\": 9931,\n \"PackageOccupation\": 4779.339460699288,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 1865.3136916885992,\n \"MinimumPickingLocationQuantity\": 6950.0676478602145,\n \"MaximumPickingLocationQuantity\": 9917.874212829973,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 2930,\n \"BuyOrderAlertManualQuantity\": 9779,\n \"KitsRelatedCount\": 3496,\n \"InfiniteInventory\": 8930,\n \"OwnProduction\": 28,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 8617,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 9232,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 7956,\n \"NfeFactorPercentSku\": 9496.575738417903,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 9897.119761380307,\n \"LeadTimeDays\": 7292,\n \"EstimatedDateArrival\": \"1965-06-03\",\n \"ShareProductImage\": 9937,\n \"KitAutomaticMeasureUpdate\": 5308,\n \"KitAutomaticPricingUpdate\": 6223,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 3684,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"1955-08-16T14:58:36.855Z\",\n \"DateLastRecordModification\": \"2023-05-23T01:02:11.041Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 73,\n \"IDSupplier\": 3330,\n \"PackageSize\": 5540.990421126066,\n \"QuantityMultiply\": 2427.274349676063,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 7996,\n \"IDSupplier\": 1486,\n \"PackageSize\": 790.7365089522477,\n \"QuantityMultiply\": 5447.883615656641,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 1095,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 6112,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 4475,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5567,\n \"IDSkuKit\": 7462,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 6704,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8854,\n \"IDSkuKit\": 1052,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n },\n {\n \"IDSku\": 5933,\n \"IDCompany\": 6385,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 3696,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 2454,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 0,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 3,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 6126,\n \"Brand\": \"string\",\n \"IDCategory\": 3234,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 4142,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 7803,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 5970.332044071957,\n \"SkuLength\": 1119.3015878038582,\n \"SkuWidth\": 5281.924962571467,\n \"SkuWeight\": 7192.346192288548,\n \"SkuWeightNet\": 1148.6528765236126,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 7928,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 7405.774613144274,\n \"CostAverage\": 8855.428105505438,\n \"CostLastPurchase\": 5845.3830110143845,\n \"InventoryValue\": 9169.378073162017,\n \"Batch\": 4710,\n \"BatchRequired\": 320,\n \"BestBeforeRequired\": 6340,\n \"BestBeforeMinimumDays\": 5043,\n \"BestBeforeDays\": 7442,\n \"RastroControl\": 499,\n \"SerialNumber\": 9744,\n \"Package\": 7124,\n \"PackageOccupation\": 5031.4296880254215,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 7889.386758528174,\n \"MinimumPickingLocationQuantity\": 4267.677432640593,\n \"MaximumPickingLocationQuantity\": 5937.101338660651,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 3823,\n \"BuyOrderAlertManualQuantity\": 8201,\n \"KitsRelatedCount\": 2629,\n \"InfiniteInventory\": 5053,\n \"OwnProduction\": 6326,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 6771,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 2103,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 2528,\n \"NfeFactorPercentSku\": 2594.0660458284005,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 5758.468788600874,\n \"LeadTimeDays\": 7062,\n \"EstimatedDateArrival\": \"2003-04-30\",\n \"ShareProductImage\": 2279,\n \"KitAutomaticMeasureUpdate\": 4829,\n \"KitAutomaticPricingUpdate\": 8576,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 5594,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"2023-02-19T05:10:27.160Z\",\n \"DateLastRecordModification\": \"1982-06-13T08:44:09.886Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 7335,\n \"IDSupplier\": 2751,\n \"PackageSize\": 3071.4360812565733,\n \"QuantityMultiply\": 6980.519976325545,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 158,\n \"IDSupplier\": 5457,\n \"PackageSize\": 3851.4787265641635,\n \"QuantityMultiply\": 9663.355564964791,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 6813,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 9857,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 842,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3260,\n \"IDSkuKit\": 9797,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 2306,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 2558,\n \"IDSkuKit\": 782,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f195ef03-d144-4e0a-8d17-fb96fe6f6626", "name": "Prefixo `[BadRequest]`. Mensagens: `Sku não existe`, `Código de barras embalagem precisa ser preenchido`, `Código de barras já existe no sku: `, `Código de Barras já existe no sku: `.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7827\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "663faa61-e47e-4be4-9504-4cd054b47954", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7827\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "364d8303-34b6-404b-b4fa-545999f8058a", "name": "Atualiza um código de barras de embalagem", "request": { "name": "Atualiza um código de barras de embalagem", "description": { "content": "Atualiza o código de embalagem ou o fator. Reaplica as validações de unicidade.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3011\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "73a6b6f6-6437-4f10-a779-ce0e23fe0f21", "name": "Código atualizado. Retorna o detalhe do SKU.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3011\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSku\": 4077,\n \"IDCompany\": 874,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 214,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 7592,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 3,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 1,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 3641,\n \"Brand\": \"string\",\n \"IDCategory\": 7781,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 1406,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 2741,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 8311.907150501776,\n \"SkuLength\": 4212.702835099649,\n \"SkuWidth\": 9248.599123458504,\n \"SkuWeight\": 6184.29068786535,\n \"SkuWeightNet\": 6013.372428710737,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 3334,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 474.90814923510925,\n \"CostAverage\": 3033.0177600663656,\n \"CostLastPurchase\": 528.633615765699,\n \"InventoryValue\": 6270.056088699192,\n \"Batch\": 1271,\n \"BatchRequired\": 7402,\n \"BestBeforeRequired\": 7222,\n \"BestBeforeMinimumDays\": 2860,\n \"BestBeforeDays\": 9537,\n \"RastroControl\": 1048,\n \"SerialNumber\": 8440,\n \"Package\": 9931,\n \"PackageOccupation\": 4779.339460699288,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 1865.3136916885992,\n \"MinimumPickingLocationQuantity\": 6950.0676478602145,\n \"MaximumPickingLocationQuantity\": 9917.874212829973,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 2930,\n \"BuyOrderAlertManualQuantity\": 9779,\n \"KitsRelatedCount\": 3496,\n \"InfiniteInventory\": 8930,\n \"OwnProduction\": 28,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 8617,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 9232,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 7956,\n \"NfeFactorPercentSku\": 9496.575738417903,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 9897.119761380307,\n \"LeadTimeDays\": 7292,\n \"EstimatedDateArrival\": \"1965-06-03\",\n \"ShareProductImage\": 9937,\n \"KitAutomaticMeasureUpdate\": 5308,\n \"KitAutomaticPricingUpdate\": 6223,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 3684,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"1955-08-16T14:58:36.855Z\",\n \"DateLastRecordModification\": \"2023-05-23T01:02:11.041Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 73,\n \"IDSupplier\": 3330,\n \"PackageSize\": 5540.990421126066,\n \"QuantityMultiply\": 2427.274349676063,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 7996,\n \"IDSupplier\": 1486,\n \"PackageSize\": 790.7365089522477,\n \"QuantityMultiply\": 5447.883615656641,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 1095,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 6112,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 4475,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5567,\n \"IDSkuKit\": 7462,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 6704,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8854,\n \"IDSkuKit\": 1052,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n },\n {\n \"IDSku\": 5933,\n \"IDCompany\": 6385,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 3696,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 2454,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 0,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 3,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 6126,\n \"Brand\": \"string\",\n \"IDCategory\": 3234,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 4142,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 7803,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 5970.332044071957,\n \"SkuLength\": 1119.3015878038582,\n \"SkuWidth\": 5281.924962571467,\n \"SkuWeight\": 7192.346192288548,\n \"SkuWeightNet\": 1148.6528765236126,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 7928,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 7405.774613144274,\n \"CostAverage\": 8855.428105505438,\n \"CostLastPurchase\": 5845.3830110143845,\n \"InventoryValue\": 9169.378073162017,\n \"Batch\": 4710,\n \"BatchRequired\": 320,\n \"BestBeforeRequired\": 6340,\n \"BestBeforeMinimumDays\": 5043,\n \"BestBeforeDays\": 7442,\n \"RastroControl\": 499,\n \"SerialNumber\": 9744,\n \"Package\": 7124,\n \"PackageOccupation\": 5031.4296880254215,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 7889.386758528174,\n \"MinimumPickingLocationQuantity\": 4267.677432640593,\n \"MaximumPickingLocationQuantity\": 5937.101338660651,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 3823,\n \"BuyOrderAlertManualQuantity\": 8201,\n \"KitsRelatedCount\": 2629,\n \"InfiniteInventory\": 5053,\n \"OwnProduction\": 6326,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 6771,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 2103,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 2528,\n \"NfeFactorPercentSku\": 2594.0660458284005,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 5758.468788600874,\n \"LeadTimeDays\": 7062,\n \"EstimatedDateArrival\": \"2003-04-30\",\n \"ShareProductImage\": 2279,\n \"KitAutomaticMeasureUpdate\": 4829,\n \"KitAutomaticPricingUpdate\": 8576,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 5594,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"2023-02-19T05:10:27.160Z\",\n \"DateLastRecordModification\": \"1982-06-13T08:44:09.886Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 7335,\n \"IDSupplier\": 2751,\n \"PackageSize\": 3071.4360812565733,\n \"QuantityMultiply\": 6980.519976325545,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 158,\n \"IDSupplier\": 5457,\n \"PackageSize\": 3851.4787265641635,\n \"QuantityMultiply\": 9663.355564964791,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 6813,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 9857,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 842,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3260,\n \"IDSkuKit\": 9797,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 2306,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 2558,\n \"IDSkuKit\": 782,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df45472d-335c-4456-915c-5d1b0e49aa13", "name": "Prefixo `[BadRequest]`. Mensagens: `Código de Barras Embalagem não existe`, `Código de Barras embalagem precisa ser preenchido`, `Código de Barras Embalagem já existe`, `Código de barras já existe no sku: `, `Código de Barras já existe no sku: `.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3011\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0ad4e52-f66b-4a94-a258-2c2b1054acdc", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3011\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee3cb303-97d6-4f0c-8449-475baffb92d3", "name": "Remove um código de barras de embalagem", "request": { "name": "Remove um código de barras de embalagem", "description": { "content": "Remove o código de barras de embalagem.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "bae06332-20dc-48ec-997d-f28df30566df", "name": "Código removido. Retorna o detalhe do SKU.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSku\": 4077,\n \"IDCompany\": 874,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 214,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 7592,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 3,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 1,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 3641,\n \"Brand\": \"string\",\n \"IDCategory\": 7781,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 1406,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 2741,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 8311.907150501776,\n \"SkuLength\": 4212.702835099649,\n \"SkuWidth\": 9248.599123458504,\n \"SkuWeight\": 6184.29068786535,\n \"SkuWeightNet\": 6013.372428710737,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 3334,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 474.90814923510925,\n \"CostAverage\": 3033.0177600663656,\n \"CostLastPurchase\": 528.633615765699,\n \"InventoryValue\": 6270.056088699192,\n \"Batch\": 1271,\n \"BatchRequired\": 7402,\n \"BestBeforeRequired\": 7222,\n \"BestBeforeMinimumDays\": 2860,\n \"BestBeforeDays\": 9537,\n \"RastroControl\": 1048,\n \"SerialNumber\": 8440,\n \"Package\": 9931,\n \"PackageOccupation\": 4779.339460699288,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 1865.3136916885992,\n \"MinimumPickingLocationQuantity\": 6950.0676478602145,\n \"MaximumPickingLocationQuantity\": 9917.874212829973,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 2930,\n \"BuyOrderAlertManualQuantity\": 9779,\n \"KitsRelatedCount\": 3496,\n \"InfiniteInventory\": 8930,\n \"OwnProduction\": 28,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 8617,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 9232,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 7956,\n \"NfeFactorPercentSku\": 9496.575738417903,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 9897.119761380307,\n \"LeadTimeDays\": 7292,\n \"EstimatedDateArrival\": \"1965-06-03\",\n \"ShareProductImage\": 9937,\n \"KitAutomaticMeasureUpdate\": 5308,\n \"KitAutomaticPricingUpdate\": 6223,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 3684,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"1955-08-16T14:58:36.855Z\",\n \"DateLastRecordModification\": \"2023-05-23T01:02:11.041Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 73,\n \"IDSupplier\": 3330,\n \"PackageSize\": 5540.990421126066,\n \"QuantityMultiply\": 2427.274349676063,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 7996,\n \"IDSupplier\": 1486,\n \"PackageSize\": 790.7365089522477,\n \"QuantityMultiply\": 5447.883615656641,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 1095,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 6112,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 4475,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5567,\n \"IDSkuKit\": 7462,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 6704,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8854,\n \"IDSkuKit\": 1052,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n },\n {\n \"IDSku\": 5933,\n \"IDCompany\": 6385,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"SkuName\": \"string\",\n \"ProductName\": \"string\",\n \"IDProduct\": 3696,\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"IDTypeSku\": 2454,\n \"TypeProduct\": \"string\",\n \"IDStatusSku\": 0,\n \"TypeStatusSku\": \"string\",\n \"IDTypeSkuCondition\": 3,\n \"TypeSkuCondition\": \"string\",\n \"IDBrand\": 6126,\n \"Brand\": \"string\",\n \"IDCategory\": 3234,\n \"Category\": \"string\",\n \"IDTaxDepartment\": 4142,\n \"TaxDepartmentDescription\": \"string\",\n \"IDCompanyInvoice\": 7803,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompanyInvoiceIDCompanyIntegrationList\": \"string\",\n \"SkuHeight\": 5970.332044071957,\n \"SkuLength\": 1119.3015878038582,\n \"SkuWidth\": 5281.924962571467,\n \"SkuWeight\": 7192.346192288548,\n \"SkuWeightNet\": 1148.6528765236126,\n \"SkuNCM\": \"string\",\n \"SkuNCMExTipi\": \"str\",\n \"SkuCest\": \"string\",\n \"SkuCst\": 7928,\n \"SkuCstDescription\": \"string\",\n \"MeasurementUnit\": \"string\",\n \"MeasurementUnitDescription\": \"string\",\n \"CostSet\": 7405.774613144274,\n \"CostAverage\": 8855.428105505438,\n \"CostLastPurchase\": 5845.3830110143845,\n \"InventoryValue\": 9169.378073162017,\n \"Batch\": 4710,\n \"BatchRequired\": 320,\n \"BestBeforeRequired\": 6340,\n \"BestBeforeMinimumDays\": 5043,\n \"BestBeforeDays\": 7442,\n \"RastroControl\": 499,\n \"SerialNumber\": 9744,\n \"Package\": 7124,\n \"PackageOccupation\": 5031.4296880254215,\n \"QtyAvailable\": \"string\",\n \"QtyReserved\": \"string\",\n \"QtySafetyStock\": 7889.386758528174,\n \"MinimumPickingLocationQuantity\": 4267.677432640593,\n \"MaximumPickingLocationQuantity\": 5937.101338660651,\n \"BuyOrdemQuantity\": \"string\",\n \"BuyOrderAlert\": 3823,\n \"BuyOrderAlertManualQuantity\": 8201,\n \"KitsRelatedCount\": 2629,\n \"InfiniteInventory\": 5053,\n \"OwnProduction\": 6326,\n \"AbcCurve\": \"s\",\n \"AbcCurveAdjust\": \"s\",\n \"IDStockKeepingUnitProductionLine\": 6771,\n \"ProductionLineName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 2103,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"WarrantyTime\": \"string\",\n \"WarrantyTimeType\": \"string\",\n \"Comments\": \"string\",\n \"NfeComments\": \"string\",\n \"NfeInvoiceAsKit\": 2528,\n \"NfeFactorPercentSku\": 2594.0660458284005,\n \"NfeFactorPercentSkuIDCompanyIntegrationList\": \"string\",\n \"NfeFactorFixedSkuValue\": 5758.468788600874,\n \"LeadTimeDays\": 7062,\n \"EstimatedDateArrival\": \"2003-04-30\",\n \"ShareProductImage\": 2279,\n \"KitAutomaticMeasureUpdate\": 4829,\n \"KitAutomaticPricingUpdate\": 8576,\n \"EcommerceDescription\": \"string\",\n \"EcommerceDescriptionShort\": \"string\",\n \"EcommerceKeyWords\": \"string\",\n \"EcommerceLinkId\": \"string\",\n \"EcommerceMetaTagDescription\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"EcommerceVideoUrl\": \"string\",\n \"EcommerceKitAutomaticDescription\": 5594,\n \"MainImageURL\": \"string\",\n \"RecordTimestamp\": \"2023-02-19T05:10:27.160Z\",\n \"DateLastRecordModification\": \"1982-06-13T08:44:09.886Z\",\n \"Tags\": [\n \"string\",\n \"string\"\n ],\n \"Suppliers\": [\n {\n \"IDStockKeepingUnitSuplierCode\": 7335,\n \"IDSupplier\": 2751,\n \"PackageSize\": 3071.4360812565733,\n \"QuantityMultiply\": 6980.519976325545,\n \"SupplierCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 158,\n \"IDSupplier\": 5457,\n \"PackageSize\": 3851.4787265641635,\n \"QuantityMultiply\": 9663.355564964791,\n \"SupplierCode\": \"string\"\n }\n ],\n \"BarCodeList\": [\n {\n \"IDStockKeepingUnitBarCode\": 6813,\n \"AdditionalBarCode\": \"string\"\n },\n {\n \"IDStockKeepingUnitBarCode\": 9857,\n \"AdditionalBarCode\": \"string\"\n }\n ],\n \"BarCodePackageList\": [\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 842,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3260,\n \"IDSkuKit\": 9797,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitBarCodePackage\": 2306,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 2558,\n \"IDSkuKit\": 782,\n \"IDSkuCompanyKit\": \"string\",\n \"SkuNameKit\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d36ab99a-3277-4018-923f-fe4a300bbd81", "name": "Prefixo `[BadRequest]`. Mensagem: `Código de Barras Embalagem não existe`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55b4005d-9552-4067-bf78-abcf31e26264", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "barcodepackage", ":idstockkeepingunitbarcodepackage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitbarcodepackage", "description": "(Required) Identificador do código de barras de embalagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "32320c30-4543-4fc0-9c10-3fb8559718af", "name": "DE-PARA CFOP Recebimento", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7619d5f2-7d08-4fd2-9945-ba9325d99e14", "name": "Lista regras DE-PARA de CFOP de recebimento", "request": { "name": "Lista regras DE-PARA de CFOP de recebimento", "description": { "content": "Retorna todos os pares CFOP origem → CFOP destino cadastrados para a empresa, ordenados pelo CFOP de origem. Cada item já vem com a descrição de cada CFOP. Quando a empresa autenticada é a `all` (multi-conta), retorna as regras de todas as empresas vinculadas.", "type": "text/plain" }, "url": { "path": [ "purchase", "cfop-inbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5eb1575b-62c7-4ab1-8490-3bc52f78275f", "name": "Lista de regras DE-PARA.", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 1234,\n \"IDCompany\": 7007,\n \"CfopFrom\": 5571,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 1150,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1971-09-27T11:51:15.345Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 6611,\n \"IDCompany\": 472,\n \"CfopFrom\": 5270,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 5037,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1975-04-29T06:35:17.773Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1d26194-62e0-4c19-8e5b-c9237492c346", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e965505-eef0-407e-b7e0-b01b6d660841", "name": "Cadastra uma regra DE-PARA de CFOP", "request": { "name": "Cadastra uma regra DE-PARA de CFOP", "description": { "content": "Cria uma regra para a empresa autenticada. Valida que `CfopFrom` e `CfopTo` existem no catálogo nacional de CFOPs e que o par ainda não foi cadastrado para a empresa (a tabela tem chave única em `CfopFrom + CfopTo + IDCompany`). A resposta é a **lista completa atualizada** das regras da empresa.", "type": "text/plain" }, "url": { "path": [ "purchase", "cfop-inbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 2243,\n \"CfopTo\": 207\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc2f5697-ba06-45aa-b5d2-6f72b576fd0d", "name": "Regra criada. Devolve a lista atualizada.", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 2243,\n \"CfopTo\": 207\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 1234,\n \"IDCompany\": 7007,\n \"CfopFrom\": 5571,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 1150,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1971-09-27T11:51:15.345Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 6611,\n \"IDCompany\": 472,\n \"CfopFrom\": 5270,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 5037,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1975-04-29T06:35:17.773Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f685ad87-9c9d-424f-ad61-a11c1d5831da", "name": "Erros de validação. Mensagens possíveis: `[BadRequest] - Esta regra já existe e não será adicionada novamente`; `[BadRequest] - CFOP de origem não existe`; `[BadRequest] - CFOP de destino não existe`; `[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 2243,\n \"CfopTo\": 207\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a79b56bd-87fd-45c0-b517-24f84d8266e1", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 2243,\n \"CfopTo\": 207\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3a2eceb-47ac-48ab-ae97-62db11dbfe78", "name": "Atualiza uma regra DE-PARA", "request": { "name": "Atualiza uma regra DE-PARA", "description": { "content": "Atualiza o par `CfopFrom`/`CfopTo` de uma regra existente. Ambos os campos são considerados em toda chamada (não é atualização parcial). Aplica as mesmas validações do POST: os CFOPs precisam existir no catálogo nacional e o novo par não pode colidir com outra regra da empresa. A resposta é a lista completa atualizada.", "type": "text/plain" }, "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 3771,\n \"CfopTo\": 8650\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8eda5d59-e737-4568-b499-1bae403eb97c", "name": "Regra atualizada. Devolve a lista atualizada.", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 3771,\n \"CfopTo\": 8650\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 1234,\n \"IDCompany\": 7007,\n \"CfopFrom\": 5571,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 1150,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1971-09-27T11:51:15.345Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 6611,\n \"IDCompany\": 472,\n \"CfopFrom\": 5270,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 5037,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1975-04-29T06:35:17.773Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f1763f-3a50-4055-9965-d131ba782970", "name": "Erros de validação. Mensagens possíveis: `[BadRequest] - De/Para de CFOP não existe`; `[BadRequest] - Esta regra já existe e não será adicionada novamente`; `[BadRequest] - CFOP de origem não existe`; `[BadRequest] - CFOP de destino não existe`.", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 3771,\n \"CfopTo\": 8650\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "473827f9-876c-41da-98db-50260f29a4e6", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CfopFrom\": 3771,\n \"CfopTo\": 8650\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd6391f4-bff0-4841-8f73-89e4b55ad34f", "name": "Exclui uma regra DE-PARA", "request": { "name": "Exclui uma regra DE-PARA", "description": { "content": "**Remove fisicamente** o registro (não é exclusão lógica). Não há regra de bloqueio: a exclusão é sempre permitida quando a regra pertence à empresa. A resposta é a lista completa atualizada.", "type": "text/plain" }, "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "9213f5ae-1181-447f-83fe-12ad96e0ef1c", "name": "Regra excluída. Devolve a lista atualizada.", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 1234,\n \"IDCompany\": 7007,\n \"CfopFrom\": 5571,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 1150,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1971-09-27T11:51:15.345Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitPurchaseCfopInbound\": 6611,\n \"IDCompany\": 472,\n \"CfopFrom\": 5270,\n \"CfopFromDescription\": \"string\",\n \"CfopTo\": 5037,\n \"CfopToDescription\": \"string\",\n \"RecordTimestamp\": \"1975-04-29T06:35:17.773Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9d820dd-4e6e-4e35-a115-693ddbe87e35", "name": "Regra não encontrada. Mensagem: `[BadRequest] - De/Para de CFOP não existe`.", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9387a64-e62f-4f97-8ef5-ba9221361612", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "purchase", "cfop-inbound", ":idstockkeepingunitpurchasecfopinbound" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitpurchasecfopinbound", "description": "(Required) Identificador da regra DE-PARA." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "350984db-008b-4a10-b8c0-4f46aadad7de", "name": "DRE", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fad05edf-a2d8-458c-856d-769c0233df9b", "name": "DRE gerencial: o plano de contas agrupado pela classificação × meses (com o CMV do estoque na competência), ou o que forma uma célula (títulos, itens ou pedidos)", "request": { "name": "DRE gerencial: o plano de contas agrupado pela classificação × meses (com o CMV do estoque na competência), ou o que forma uma célula (títulos, itens ou pedidos)", "description": { "content": "Monta a **DRE gerencial** (Demonstrativo de Resultado do Exercício). Não há estrutura própria de linhas: a DRE é a **própria árvore do plano de contas** (`GET /type/account/type`, hierarquia por `IDTypeAccountPaybleFather`) agrupada pela **classificação** (natureza) de cada plano — `IDTypeCategoryAccountPayble`, catálogo `GET /type/account/type/category` (1 Ativo, 2 Passivo, 3 Patrimônio, 4 Receita de produto, 5 Despesa fixa, 6 Custo, 7 Outros resultados, 8 Deduções da receita, 9 Despesa variável, 10 Depreciação e amortização, 11 Resultado financeiro, 12 Impostos sobre o lucro, 13 Receita de serviço) — × os meses do período, somando os títulos (`AccountsPayableReceivable`). Classificar é editar o plano de contas (`POST /type/account/type` e `PUT /type/account/type/{idtypeaccount}`); esta rota só lê.\n\nDois modos, controlados por `Type`:\n- **Resumo** (`Type=Summary`, ou sem `Type`): um objeto `IncomeStatementSummary`.\n- **Detalhe** (`Type=Detail`): o que forma **uma** célula do resumo — os títulos (no `DateType=DatePayment`, as baixas) e, nos recortes do estoque e dos descontos de venda, os itens (movimentos de estoque) ou os pedidos. Exige um recorte — `IDTypeCategoryAccountPayble`, `IDTypeAccountPayble`, `Unclassified=1`, `WithoutAccount=1`, `WithoutCompetence=1`, `CostOfGoodsSold=1`, `CostOfGoodsSoldCheck`, `Packaging=1`, `SalesDiscount=1` ou `PurchaseInCost=1` — e é paginado em **1000** linhas por `Page` (a partir de `0`). Com mais de um recorte, vale o primeiro nesta ordem: `CostOfGoodsSoldCheck`, `CostOfGoodsSold`, `Packaging`, `SalesDiscount`, `PurchaseInCost`, `WithoutCompetence`, `WithoutAccount`, `IDTypeAccountPayble`, `IDTypeCategoryAccountPayble`, `Unclassified`; os outros não filtram nem são validados. A exceção é o `IDTypeAccountPayble` junto com `SalesDiscount=1`: aí ele não é recorte próprio e restringe a lista dos descontos à conta-âncora (ver `SalesDiscount`).\n\n**Classificação efetiva**\n- A de um plano é a **própria** ou, sem ela, a do plano superior mais próximo que tiver uma. Pode ser escolhida em **qualquer nível**: classificar `Despesas` leva todas as filhas junto, e só a exceção precisa de classificação própria.\n- É resolvida de cima para baixo, independe da ordem dos ids e é à prova de ciclo no plano de contas: um plano de ciclo sem raiz alcançável fica só com a própria.\n- Planos **inativos** entram (título antigo continua apontando para eles).\n\n**Blocos e subtotais** (`Lines`, nesta ordem fixa)\n- `ProductRevenue` (4 Receita de produto, `+`) → `ServiceRevenue` (13 Receita de serviço, `+`) → **`Revenue`** (Receita bruta) = ProductRevenue + ServiceRevenue → `Deductions` (8 Deduções da receita, `-`) → **`NetRevenue`** (Receita líquida) = Revenue + Deductions → `CostOfGoodsSold` (CMV, `-`, só no `DateType=Competence`) → `Cost` (6 Custo, `-`) → **`GrossProfit`** (Lucro bruto) = NetRevenue + CostOfGoodsSold + Cost → `VariableExpense` (9 Despesa variável, `-`) → **`ContributionMargin`** (Margem de contribuição) = GrossProfit + VariableExpense → `FixedExpense` (5 Despesa fixa, `-`) → **`OperatingResult`** (Resultado operacional (EBITDA)) = ContributionMargin + FixedExpense → `DepreciationAmortization` (10 Depreciação e amortização, `-`) → **`Ebit`** (EBIT) = OperatingResult + DepreciationAmortization → `FinancialResult` (11 Resultado financeiro, `±`) → `OtherResult` (7 Outros resultados, `±`) → **`ProfitBeforeTax`** (Resultado antes dos impostos (LAIR)) = Ebit + FinancialResult + OtherResult → `IncomeTax` (12 Impostos sobre o lucro, `-`) → **`NetResult`** (Resultado do período) = ProfitBeforeTax + IncomeTax.\n- São 19 linhas no `DateType=Competence` e 18 nas outras datas base (sem o CMV). A chave `Expense` não existe mais: a classificação 5 é a linha `FixedExpense`. A `Revenue` deixou de ser bloco de classificação e virou **subtotal**: quem soma a classificação 4 é a `ProductRevenue`.\n- Bloco de classificação (`Kind=Category`): a árvore do plano restrita aos planos com aquela classificação efetiva. O pai de um nó no bloco é o pai real se ele também estiver no bloco; senão o nó é raiz do bloco (o `CategoryTree` dá o contexto). O valor de cada nó **inclui** os descendentes dele no bloco e, com `IncludeSalesDiscount=1`, o desconto de venda ancorado nele e nas contas filhas (ver **Descontos de venda**). Nó sem título nem desconto ancorado no período (na subárvore) é omitido. Depois das raízes do plano podem vir **nós sintéticos**, que não vêm de título e somam na linha: `Embalagens (estoque)` na `VariableExpense` (só no `DateType=Competence`) e, com `IncludeSalesDiscount=1`, `Descontos de venda` nas `Deductions` e, na `ProductRevenue`, o `Descontos concedidos (receita cheia)` do desconto que não coube numa conta de receita — ver `IncomeStatementAccountNode`. O Detalhe da linha (`IDTypeCategoryAccountPayble`) e o do plano (`IDTypeAccountPayble`) listam só os títulos; cada nó sintético abre pelo seu recorte (`Packaging=1`, `SalesDiscount=1`).\n- CMV (`Kind=CostOfGoodsSold`): o custo da mercadoria vendida, que vem do estoque e não de título — ver **CMV** abaixo. `Accounts` vem vazio; a abertura fica em `Groups`.\n- Subtotal (`Kind=Subtotal`): acumula as linhas que vêm antes dele (blocos de classificação, com os nós sintéticos, e o CMV); `Accounts` vem vazio e nenhum nó sintético fica nele. Nada inverte sinal — o sinal vem do título (no CMV, custo negativo), então todo subtotal é soma simples.\n\n**Fora do resultado** (não entra em nenhum subtotal)\n- `OutsideResult`: Ativo (1), Passivo (2) e Patrimônio (3), sempre presentes, mesmo zerados; depois deles, qualquer classificação do catálogo fora de 1..13, só se tiver título. Informativo.\n- `Unclassified`: planos sem classificação efetiva (nem própria nem herdada), títulos sem plano de contas (nó `Sem plano de contas`) e títulos cujo plano não é das empresas consultadas (nó `Plano de contas (de outra empresa)`). A tela deve mostrar quanto ficou de fora em vez de misturar no resultado.\n\n**Títulos sem data de competência** (só no `DateType=Competence`)\n- A competência é **só** `DateCompetence`, sem data substituta: título sem ela fica **fora da DRE inteira** — não entra em bloco, subtotal, `OutsideResult` nem `Unclassified`.\n- O resumo avisa em `WithoutCompetence` quantos são e quanto somam a receber e a pagar, contando os que **vencem** no período (mesmo filtro de empresa, status, filial e pedido, qualquer plano de contas). O Detalhe com `WithoutCompetence=1` lista exatamente esses títulos, para a competência ser preenchida.\n\n**CMV — custo da mercadoria vendida** (só no `DateType=Competence`; nas outras datas base a linha `CostOfGoodsSold` não sai e `CostOfGoodsSoldCheck` vem `null`)\n- Não vem de título: vem do **estoque**, o custo que a venda gravou no movimento (`StockKeepingUnitMovement.ValueCostTotal`, custo histórico; nada de custo de hoje). A compra de mercadoria para revenda e a de embalagem devem ser classificadas como **Ativo** (entram no estoque, fora do resultado); o custo chega à DRE quando o item sai: pelo CMV (mercadoria e bonificação) ou pelo nó `Embalagens (estoque)` da Despesa variável (embalagem de envio). Compra num plano classificado como Custo ou Despesa variável conta em dobro com o estoque — ver `CostOfGoodsSoldCheck.PurchaseInCost`.\n- **Âncora**: o CMV de um pedido entra no mês da **competência da receita** do pedido, não na data da NF. Título de receita do pedido = a receber (`IDTypeAccount=0`), com `IDOrder` e `DateCompetence`, status diferente de Não lançado, das empresas consultadas e, com `IDCompanyInvoice`, da filial. A data-âncora é a **menor** `DateCompetence` entre todos esses títulos, e o pedido entra quando ela está no período — o CMV de um pedido cai num único mês, mesmo com títulos em meses diferentes. Motivo: a NF emitida pelos crons, importada (Bling, Tiny, upload) ou por feed de marketplace não data os títulos; ancorado na receita, quem corrige a competência do título move o CMV junto.\n- **Pedidos**: da empresa consultada (`Orders.IDCompany` — o estoque é do dono do pedido). Ficam fora orçamento (`Budget=1`), transferência (`TypeOrder.IsTransfer=1`), devolução ao fornecedor (`NFeFin=4` com `NfeType=1`) e os pedidos filhos de triangulação (remessa por conta e ordem e remessa simbólica).\n- **Itens**: as linhas de saída (`IDTypeMovement=1`) do pedido, de SKU que não é serviço (`IDTypeSku=5` fica fora). Entram no CMV as que **baixaram estoque** (`BalanceChange=1`) com custo válido. Kit: a venda grava só as linhas dos componentes, cada uma com o seu custo.\n- **Valor**: `Values`/`Total` = −Σ `ValueCostTotal` (custo negativo, na convenção da DRE) e `Qty` = linhas de movimento somadas. `Groups` abre a linha em `Goods` (Mercadorias) e `Gratification` (Bonificações: item bonificado), nesta ordem e só os que têm linha; a soma dos grupos é a linha.\n- **Embalagens**: as linhas de SKU embalagem (`Package=1`) seguem as mesmas regras (âncora, pedidos, itens, custo), mas **não** estão no CMV: a embalagem de envio é despesa de venda e sai na linha `VariableExpense` (Despesa variável), no nó sintético `Embalagens (estoque)` (`Source=Stock`, `StockGroup=Packaging`), depois dos planos de contas e só quando há linha. O Lucro bruto fica sem a embalagem; o EBITDA e o resultado não mudam. Lista: `Packaging=1`.\n- **Custo inválido**: custo unitário acima de R$ 10.000.000 (`|ValueCostTotal| > 10.000.000 × |Quantity|`), o que pega a sentinela ±9.999.999.999.999,99. Fica **fora** da soma (do CMV e das Embalagens) e é contado em `CostOfGoodsSoldCheck.InvalidCost`, de qualquer grupo.\n- **Sem custo**: mercadoria com custo 0 ou nulo entra como 0 (não há custo substituto) e é contada em `CostOfGoodsSoldCheck.ZeroCost`, com a venda dessas linhas.\n- **Devolução de cliente** (`NFeFin=4` e `NfeType=0`) entra pelas mesmas regras: quantidade e custo negativos **reduzem** o CMV no mês da receita estornada.\n- **Limitações**: a devolução feita no modo padrão da tela não baixa estoque (a mercadoria volta por uma compra) e **não estorna** o CMV — o pedido aparece em `CostOfGoodsSoldCheck.WithoutStockOut`. No drop-seller, a receita do fornecedor aponta para o pedido do seller, que não é dele: o fornecedor fica sem esse CMV. E o custo recalculado depois da venda (recálculo de custo, edição do pedido) muda o CMV de um mês já fechado.\n- **Pontos de atenção** em `CostOfGoodsSoldCheck` (ver `IncomeStatementCostOfGoodsSoldCheck`). Cada um tem um recorte do Detalhe que lista exatamente o que foi contado, com o mesmo filtro e a mesma âncora.\n\n**Descontos de venda** (`IncludeSalesDiscount=1`, só no resumo e só no `DateType=Competence`; nas outras datas base o parâmetro é ignorado)\n- O título a receber do pedido é o valor cobrado, já sem o desconto do item. Com o parâmetro, a DRE mostra esse desconto **sem mudar a Receita líquida**: +D na receita (a Receita bruta volta ao valor cheio) e −D na linha `Deductions`, no nó sintético `Descontos de venda`. Os nós do desconto têm `Source=OrderItems` e `StockGroup=SalesDiscount`. Os valores dos subtotais não mudam; o `Qty` deles soma as linhas de desconto duas vezes (na receita e nas Deduções).\n- **Onde entra o +D**: na **conta-âncora** do pedido, o plano de contas do título de receita que deu a âncora (o de menor `DateCompetence`, com desempate pelo id do título). Quando a classificação efetiva dela é **4** (Receita de produto) ou **13** (Receita de serviço), o +D entra **no valor da própria conta**, que passa a mostrar a receita cheia (e, pela soma, os superiores dela e a linha `ProductRevenue` ou `ServiceRevenue`), e a conta ganha no fim de `Children`, depois das subcontas, o nó sintético `Descontos concedidos (receita cheia)` com o quanto. A conta que no período só tem desconto não é omitida.\n- **Resíduo**: quando a conta-âncora não é de receita (título sem plano de contas, plano de outra empresa, plano sem classificação efetiva ou com outra, como um Passivo de adiantamento de cliente), o +D vai para o nó `Descontos concedidos (receita cheia)` no fim de `Accounts` da linha `ProductRevenue`, que só aparece quando há resíduo. Assim o +D nunca sai do resultado enquanto o −D fica nas Deduções.\n- D vem dos itens do pedido (`StockKeepingUnitMovement`): desconto da linha = `ValueDiscount` × `Quantity` (o `ValueDiscount` é **por unidade**), arredondado a centavos na própria linha. Limite conhecido: pedido cuja NF foi importada pelo upload do XML pode ter o `ValueDiscount` gravado como **total da linha**, e aí o desconto sai multiplicado pela quantidade — o mesmo desvio dos relatórios de Vendas e Fiscal. Entram as linhas de saída (`IDTypeMovement=1`) dos pedidos com a **mesma âncora** e os **mesmos filtros de pedido** do CMV (competência da receita; fora orçamento, transferência, devolução ao fornecedor e filhos de triangulação), **sem** exigir baixa de estoque e **com** SKU de serviço (o desconto é da receita, não do estoque). Ficam fora a bonificação (`Gratification=1`: vai com o preço de tabela e desconto de 100%, que não é desconto comercial) e a linha sem desconto. Devolução de cliente (quantidade negativa) reduz.\n- O resumo traz `SalesDiscount` (ver `IncomeStatementSalesDiscount`) e o Detalhe com `SalesDiscount=1` lista as linhas, com `ValueDiscountTotal`: sem conta, todas as do período (o total de `SalesDiscount` e do nó `Descontos de venda`); com `IDTypeAccountPayble=`, só as dos pedidos cuja conta-âncora é exatamente esse plano, sem as contas filhas (a célula do nó `Descontos concedidos (receita cheia)` que fica dentro dele). O nó residual da `ProductRevenue` não tem recorte próprio: a lista sem conta traz também o que entrou dentro das contas.\n\n**Filtros de pedido** (`IDTypeCompanyIntegration`, `IDCompanyIntegration`, `IDOrderType`)\n- Canal de vendas (o `IDTypeCompanyIntegration` da integração do pedido, `CompanyIntegration`), integração (`Orders.IDCompanyIntegration`) e tipo de pedido (`Orders.IDOrderType`). Cada um é uma lista de ids separada por vírgula (ex.: `12,15`), com até 200 ids; vazio é o mesmo que ausente.\n- Com **qualquer** um ativo, a DRE vira a DRE desses pedidos: entram **só os títulos ligados a pedido** (`IDOrder`) cujo pedido é das empresas consultadas e bate com **todos** os filtros ativos. Título sem pedido (aluguel, salários, compras, tarifa de marketplace sem pedido) fica de fora, e também o título cujo pedido é de outra empresa (drop-seller).\n- Vale para tudo que vem de título: linhas, `OutsideResult`, `Unclassified`, `WithoutCompetence`, `CostOfGoodsSoldCheck.PurchaseInCost` e os recortes de título do Detalhe, em qualquer `DateType` (no `DatePayment`, as baixas desses títulos). O CMV, as Embalagens (estoque) e os descontos de venda só ancoram os pedidos que batem com os filtros, no resumo, nos pontos de atenção e nos recortes do Detalhe: cada lista continua batendo com o seu número.\n- **Devolução de cliente** é um pedido próprio (`NFeFin=4`): os títulos do estorno e os movimentos dela (o CMV negativo) apontam para ela, e os filtros valem para a integração e o tipo **dela**, não os da venda estornada. A integração da devolução é a da venda, salvo com o parâmetro *Utilizar integração idworks no pedido de devolução* (`ReturnOrderIDWorksDefaultIntegration`): aí ela vai para a integração padrão da conta, e a DRE do canal ou da integração da venda fica sem o estorno (margem maior), que aparece no canal da integração padrão. O tipo da devolução é sempre um tipo de devolução, nunca o da venda: para o filtro por tipo trazer as devoluções, inclua também o tipo de devolução.\n- Sem filtro de pedido, nada muda.\n\n**Regras**\n- `DateFrom` e `DateTo` são obrigatórios nos dois modos: datas reais no formato `YYYY-MM-DD` (`2026-02-30` é inválida), `DateFrom` ≤ `DateTo`, e o período cobre no máximo **24 meses**, contados por mês-calendário (o mês de `DateFrom` e o de `DateTo` entram na conta).\n- `DateType` decide qual data põe o título num mês: `Competence` (padrão) usa **só** `DateCompetence` — título sem competência fica fora (ver acima). Por isso o total pode diferir do relatório 111 (Demonstrativo Financeiro por Plano de Contas), que usa a data do documento quando falta a competência. `DateDue` usa o vencimento. `DatePayment` usa a data da **baixa** (`AccountsPayableReceivableBankStatement`) e o valor **baixado**, que já inclui juros, multa e desconto — é o regime de caixa. Só a `Competence` tem o CMV, as Embalagens (estoque) e os descontos de venda.\n- Os valores saem **com sinal**: a pagar (`IDTypeAccount=1`) negativo, a receber (`IDTypeAccount=0`) positivo. As somas são feitas em centavos inteiros.\n- Títulos com status **Não lançado** (`IDStatusAccountPayableReceivable=4`) ficam de fora.\n- Na conta principal, consolida todas as empresas do grupo; nas demais, só a empresa do subdomínio. `IDCompanyInvoice` restringe à empresa faturadora (filial).", "type": "text/plain" }, "url": { "path": [ "accounts", "income-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "Summary", "description": "`Summary` (padrão, também quando omitido ou vazio): o demonstrativo do período, um `IncomeStatementSummary`. `Detail`: o que forma uma célula do demonstrativo, com um recorte obrigatório (`IDTypeCategoryAccountPayble`, `IDTypeAccountPayble`, `Unclassified`, `WithoutAccount`, `WithoutCompetence`, `PurchaseInCost`, `CostOfGoodsSold`, `CostOfGoodsSoldCheck`, `Packaging` ou `SalesDiscount`): array de `IncomeStatementDetailItem` (títulos), de `IncomeStatementCostOfGoodsSoldItem` (itens do CMV, das Embalagens (estoque) e, com `ValueDiscountTotal`, dos descontos de venda) ou de `IncomeStatementCostOfGoodsSoldOrder` (pedidos do aviso `WithoutStockOut`). Outro valor: 400." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "(Required) Início do período (`YYYY-MM-DD`, data real). Obrigatório nos dois modos." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "(Required) Fim do período (`YYYY-MM-DD`, data real), igual ou posterior a `DateFrom`. O período vai de `DateFrom` a `DateTo`, inclusive (no `DatePayment`, até 23:59:59 de `DateTo`), e cobre no máximo 24 meses-calendário." }, { "disabled": false, "key": "DateType", "value": "Competence", "description": "Data que põe o título num mês. `Competence` (padrão): só `DateCompetence` — título sem competência fica fora da DRE; o resumo conta em `WithoutCompetence` os que vencem no período, e o Detalhe com `WithoutCompetence=1` os lista. Só a `Competence` tem a linha do CMV (`CostOfGoodsSold`), `CostOfGoodsSoldCheck`, o nó `Embalagens (estoque)` e os descontos de venda (`IncludeSalesDiscount`). `DateDue`: vencimento. `DatePayment`: data da baixa, com o valor baixado (regime de caixa); aí `Qty` conta baixas, não títulos." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "1209", "description": "Empresa faturadora (filial) do título. Inteiro positivo; vazio é ignorado." }, { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "6198,5677", "description": "Filtro de pedido: **canal de vendas**, o `IDTypeCompanyIntegration` da integração do pedido (`CompanyIntegration`). Lista de ids separada por vírgula (ex.: `12,15`), até 200; vazio é ignorado. Com qualquer filtro de pedido, a DRE mostra **só os títulos ligados a pedido** que batem com todos os filtros ativos, e o CMV desses pedidos (ver **Filtros de pedido**). Item que não é inteiro positivo (ex.: `abc`, `0`, `12,`) ou mais de 200 ids: 400 `Canal de vendas inválido`." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "6198,5677", "description": "Filtro de pedido: **integração** do pedido (`Orders.IDCompanyIntegration`). Lista de ids separada por vírgula (ex.: `12,15`), até 200; vazio é ignorado. Com qualquer filtro de pedido, a DRE mostra **só os títulos ligados a pedido** que batem com todos os filtros ativos, e o CMV desses pedidos (ver **Filtros de pedido**). Item que não é inteiro positivo ou mais de 200 ids: 400 `Integração inválida`." }, { "disabled": false, "key": "IDOrderType", "value": "6198,5677", "description": "Filtro de pedido: **tipo de pedido** (`Orders.IDOrderType`, `TypeOrder`). Lista de ids separada por vírgula (ex.: `12,15`), até 200; vazio é ignorado. Com qualquer filtro de pedido, a DRE mostra **só os títulos ligados a pedido** que batem com todos os filtros ativos, e o CMV desses pedidos (ver **Filtros de pedido**). Item que não é inteiro positivo ou mais de 200 ids: 400 `Tipo de pedido inválido`." }, { "disabled": false, "key": "IncludeSalesDiscount", "value": "1", "description": "**Resumo**, só com `DateType=Competence` (nas outras datas base é ignorado; o Detalhe também não olha). `1` mostra os **descontos de venda** dos itens dos pedidos: +D na conta que ancorou o pedido, quando a classificação efetiva dela é 4 ou 13 (a conta passa a mostrar a receita cheia e ganha o nó `Descontos concedidos (receita cheia)` em `Children`), ou, quando a conta-âncora não é de receita, no nó de mesmo nome da linha `ProductRevenue`; e −D no nó `Descontos de venda` da linha `Deductions`. A Receita bruta volta ao valor cheio e a Receita líquida não muda. O resumo traz `SalesDiscount` (`null` sem o parâmetro). Outro valor é desligado. Ver **Descontos de venda**." }, { "disabled": false, "key": "IDTypeCategoryAccountPayble", "value": "1209", "description": "**Modo Detalhe**. Títulos do bloco inteiro de uma classificação — a célula de um item `Kind=Category` de `Lines` ou de `OutsideResult`: todos os planos cuja classificação **efetiva** é esta. Tem de existir no catálogo (`GET /type/account/type/category`). Classificação sem nenhum plano devolve `[]`. Lista **só os títulos**: os nós sintéticos da linha (`Embalagens (estoque)`, descontos de venda) e o desconto de venda que entrou dentro das contas abrem pelos recortes `Packaging=1` e `SalesDiscount=1`." }, { "disabled": false, "key": "IDTypeAccountPayble", "value": "1209", "description": "**Modo Detalhe**. Títulos do plano e dos descendentes dele que estão no **mesmo bloco** (mesma classificação efetiva) — os títulos que o nó do plano somou no resumo. Com `IncludeSalesDiscount=1`, o valor do nó de uma conta de receita inclui também o desconto de venda ancorado nela e nas filhas, que não é título: abre pelo nó `Descontos concedidos (receita cheia)` de cada conta (`SalesDiscount=1&IDTypeAccountPayble=`). Junto com `SalesDiscount=1`, este parâmetro não é recorte próprio: restringe a lista dos descontos (ver `SalesDiscount`). Plano que não é das empresas consultadas (nó `Plano de contas (de outra empresa)` de `Unclassified`): só os títulos dele." }, { "disabled": false, "key": "Unclassified", "value": "1", "description": "**Modo Detalhe**. `1` = tudo que o resumo pôs em `Unclassified`: títulos sem plano de contas, de planos sem classificação efetiva e de planos que não são das empresas consultadas (o complemento de “classificado”)." }, { "disabled": false, "key": "WithoutAccount", "value": "1", "description": "**Modo Detalhe**. `1` = só os títulos sem plano de contas (o nó `Sem plano de contas` de `Unclassified`)." }, { "disabled": false, "key": "WithoutCompetence", "value": "1", "description": "**Modo Detalhe**, só com `DateType=Competence` (com outra data base: 400). `1` = os títulos **sem data de competência** que vencem no período, de qualquer plano de contas (inclusive sem plano) — os que ficaram fora da DRE e o resumo contou em `WithoutCompetence`, com o mesmo filtro de empresa, status, filial e pedido. Ordenados pelo vencimento, com `DateSource` = `DateDue`. Vence `WithoutAccount`, `IDTypeAccountPayble`, `IDTypeCategoryAccountPayble` e `Unclassified`, que então não filtram nem são validados; perde para os recortes do estoque e dos descontos (`CostOfGoodsSoldCheck`, `CostOfGoodsSold`, `Packaging`, `SalesDiscount`) e para o `PurchaseInCost`." }, { "disabled": false, "key": "CostOfGoodsSoldCheck", "value": "ZeroCost", "description": "**Modo Detalhe**, só com `DateType=Competence` (com outra data base: 400). Lista o que um ponto de atenção do CMV (`CostOfGoodsSoldCheck` do resumo) contou, com o mesmo filtro e a mesma âncora: `ZeroCost` e `InvalidCost` = os **itens** do aviso (`IncomeStatementCostOfGoodsSoldItem`, pela âncora, pelo pedido e pelo movimento); `WithoutStockOut` = os **pedidos** do aviso (`IncomeStatementCostOfGoodsSoldOrder`, pela âncora e pelo pedido). Outro valor: 400. É o recorte de maior precedência." }, { "disabled": false, "key": "CostOfGoodsSold", "value": "1", "description": "**Modo Detalhe**, só com `DateType=Competence` (com outra data base: 400). `1` = os itens (movimentos de estoque) somados na linha `CostOfGoodsSold` — a célula da linha do CMV: mercadorias e bonificações; a embalagem é o recorte `Packaging=1` —, em `IncomeStatementCostOfGoodsSoldItem`, pela âncora, pelo pedido e pelo movimento. Com `CostOfGoodsSoldGroup`, só os de um grupo. Perde só para `CostOfGoodsSoldCheck`." }, { "disabled": false, "key": "CostOfGoodsSoldGroup", "value": "Goods", "description": "**Modo Detalhe**, só junto com `CostOfGoodsSold=1` (sem ele, é ignorado): restringe aos itens de um grupo de `Groups` da linha do CMV — a célula do grupo. `Goods` ou `Gratification`; outro valor (inclusive `Packaging`, que virou o recorte `Packaging=1`): 400." }, { "disabled": false, "key": "Packaging", "value": "1", "description": "**Modo Detalhe**, só com `DateType=Competence` (com outra data base: 400). `1` = os itens (movimentos de estoque) do nó sintético `Embalagens (estoque)` da linha `VariableExpense`: as linhas de SKU embalagem (`Package=1`) que baixaram estoque com custo válido, com a âncora e os filtros do CMV, em `IncomeStatementCostOfGoodsSoldItem` (`Group=Packaging`), pela âncora, pelo pedido e pelo movimento. É o antigo `CostOfGoodsSold=1&CostOfGoodsSoldGroup=Packaging`. Perde para `CostOfGoodsSoldCheck` e `CostOfGoodsSold`; vence `SalesDiscount`, `PurchaseInCost`, `WithoutCompetence` e os recortes de plano." }, { "disabled": false, "key": "SalesDiscount", "value": "1", "description": "**Modo Detalhe**, só com `DateType=Competence` (com outra data base: 400). `1` = as linhas de item dos **descontos de venda**: o que o `SalesDiscount` do resumo e o nó `Descontos de venda` somaram com `IncludeSalesDiscount=1` (que aqui não é preciso), em `IncomeStatementCostOfGoodsSoldItem` com `ValueDiscountTotal`, pela âncora, pelo pedido e pelo movimento. Com `IDTypeAccountPayble` junto, só as linhas dos pedidos cuja conta-âncora é exatamente esse plano, sem descer para as filhas: a célula do nó `Descontos concedidos (receita cheia)` que fica dentro da conta. `IDTypeAccountPayble` que não é inteiro positivo: 400 `Plano de contas inválido`. Sem ele, todas as linhas do período, inclusive as do nó residual da `ProductRevenue`. Perde para `CostOfGoodsSoldCheck`, `CostOfGoodsSold` e `Packaging`; vence `PurchaseInCost`, `WithoutCompetence` e os recortes de plano." }, { "disabled": false, "key": "PurchaseInCost", "value": "1", "description": "**Modo Detalhe**, só com `DateType=Competence` (com outra data base: 400). `1` = os títulos de compra (`IDPurchase` ou `IDBuyOrder` preenchido) lançados em planos de classificação efetiva **Custo** ou **Despesa variável** — o que `CostOfGoodsSoldCheck.PurchaseInCost` somou, com o mesmo filtro de empresa, período, status, filial e pedido —, no formato `IncomeStatementDetailItem`. Sem plano classificado como Custo ou Despesa variável, `[]`. Vence `WithoutCompetence` e os recortes de plano; perde para os do estoque e para o `SalesDiscount`." }, { "disabled": false, "key": "Page", "value": "0", "description": "**Modo Detalhe**. Página de 1000 linhas, a partir de `0`. Valor inválido ou negativo vira `0`. Página com 1000 linhas indica que pode haver a próxima." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7c0cf016-2e22-47da-b502-867c9b09cd4a", "name": "`Type=Summary` (ou sem `Type`): o demonstrativo (`IncomeStatementSummary`). `Type=Detail`: array de `IncomeStatementDetailItem`, ordenado pela data do `DateType` (no recorte `WithoutCompetence`, pelo vencimento) e pelo título — vazio quando o recorte não tem títulos ou a página passou do fim. Nos recortes `CostOfGoodsSold`, `Packaging` e `CostOfGoodsSoldCheck=ZeroCost|InvalidCost`, array de `IncomeStatementCostOfGoodsSoldItem`; em `SalesDiscount`, o mesmo item com `ValueDiscountTotal`; em `CostOfGoodsSoldCheck=WithoutStockOut`, array de `IncomeStatementCostOfGoodsSoldOrder`; em `PurchaseInCost`, títulos (`IncomeStatementDetailItem`).", "originalRequest": { "url": { "path": [ "accounts", "income-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "Summary" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "DateType", "value": "Competence" }, { "key": "IDCompanyInvoice", "value": "1209" }, { "key": "IDTypeCompanyIntegration", "value": "6198,5677" }, { "key": "IDCompanyIntegration", "value": "6198,5677" }, { "key": "IDOrderType", "value": "6198,5677" }, { "key": "IncludeSalesDiscount", "value": "1" }, { "key": "IDTypeCategoryAccountPayble", "value": "1209" }, { "key": "IDTypeAccountPayble", "value": "1209" }, { "key": "Unclassified", "value": "1" }, { "key": "WithoutAccount", "value": "1" }, { "key": "WithoutCompetence", "value": "1" }, { "key": "CostOfGoodsSoldCheck", "value": "ZeroCost" }, { "key": "CostOfGoodsSold", "value": "1" }, { "key": "CostOfGoodsSoldGroup", "value": "Goods" }, { "key": "Packaging", "value": "1" }, { "key": "SalesDiscount", "value": "1" }, { "key": "PurchaseInCost", "value": "1" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DateFrom\": \"1956-08-10\",\n \"DateTo\": \"2022-09-05\",\n \"DateType\": \"DateDue\",\n \"Months\": [\n \"2026-01\",\n \"2026-02\",\n \"2026-03\"\n ],\n \"Lines\": [\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Category\",\n \"IDTypeCategoryAccountPayble\": 2518,\n \"Description\": \"string\",\n \"Sign\": \"±\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4632.417178917878,\n \"Qty\": 4500,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 7651,\n \"IDTypeAccountPaybleFather\": 2451,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 677.9651078381654,\n \"Qty\": 7984\n },\n {\n \"IDTypeAccountPayble\": 3188,\n \"IDTypeAccountPaybleFather\": 2457,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1148.6746277976124,\n \"Qty\": 3067\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5184.626397394987,\n \"Qty\": 1444\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8356.622477949717,\n \"Qty\": 2248\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 6000,\n \"Description\": \"string\",\n \"Sign\": \"-\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5840.806492567841,\n \"Qty\": 2230,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 9330,\n \"IDTypeAccountPaybleFather\": 2710,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4871.610922810858,\n \"Qty\": 9868\n },\n {\n \"IDTypeAccountPayble\": 749,\n \"IDTypeAccountPaybleFather\": 5593,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6226.533293653107,\n \"Qty\": 3648\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5901.844103037839,\n \"Qty\": 7961\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5350.799698464648,\n \"Qty\": 1797\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 5593,\n \"Description\": \"string\",\n \"Sign\": \"-\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4193.740112398634,\n \"Qty\": 1118,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 3982,\n \"IDTypeAccountPaybleFather\": 4676,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 46.55735430447727,\n \"Qty\": 467\n },\n {\n \"IDTypeAccountPayble\": 4023,\n \"IDTypeAccountPaybleFather\": 4064,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6071.190280551659,\n \"Qty\": 2407\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1186.2319945052313,\n \"Qty\": 7042\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4837.898767625741,\n \"Qty\": 9686\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Category\",\n \"IDTypeCategoryAccountPayble\": 9903,\n \"Description\": \"string\",\n \"Sign\": \"±\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6951.992505024813,\n \"Qty\": 8062,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 1739,\n \"IDTypeAccountPaybleFather\": 5528,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7291.826756368542,\n \"Qty\": 2743\n },\n {\n \"IDTypeAccountPayble\": 4178,\n \"IDTypeAccountPaybleFather\": 9115,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5484.819254317361,\n \"Qty\": 3273\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9724.491038056367,\n \"Qty\": 7342\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 2374.106685948307,\n \"Qty\": 3123\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 2188,\n \"Description\": \"string\",\n \"Sign\": \"±\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 431.37271679713376,\n \"Qty\": 4261,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 8294,\n \"IDTypeAccountPaybleFather\": 279,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"Stock\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 300.70758598675695,\n \"Qty\": 7534\n },\n {\n \"IDTypeAccountPayble\": 8965,\n \"IDTypeAccountPaybleFather\": 305,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1759.7484689501064,\n \"Qty\": 7372\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9400.37841175731,\n \"Qty\": 1536\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8190.1672525256845,\n \"Qty\": 5176\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Category\",\n \"IDTypeCategoryAccountPayble\": 2215,\n \"Description\": \"string\",\n \"Sign\": \"\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 3163.5723033586883,\n \"Qty\": 3048,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 9302,\n \"IDTypeAccountPaybleFather\": 7205,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7776.302261708641,\n \"Qty\": 6716\n },\n {\n \"IDTypeAccountPayble\": 6083,\n \"IDTypeAccountPaybleFather\": 353,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 2866.477512386849,\n \"Qty\": 6750\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5613.119565791393,\n \"Qty\": 5752\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 46.9253250137136,\n \"Qty\": 8124\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 4484,\n \"Description\": \"string\",\n \"Sign\": \"+\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 260.9682812386138,\n \"Qty\": 9099,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 2216,\n \"IDTypeAccountPaybleFather\": 4353,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 2873.8707882992862,\n \"Qty\": 3038\n },\n {\n \"IDTypeAccountPayble\": 7201,\n \"IDTypeAccountPaybleFather\": 4127,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6550.411780157397,\n \"Qty\": 7810\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7108.083000289389,\n \"Qty\": 4133\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9895.918375858699,\n \"Qty\": 9490\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Subtotal\",\n \"IDTypeCategoryAccountPayble\": 6841,\n \"Description\": \"string\",\n \"Sign\": \"+\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5248.831371429703,\n \"Qty\": 317,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 1790,\n \"IDTypeAccountPaybleFather\": 6800,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4070.697210287131,\n \"Qty\": 7644\n },\n {\n \"IDTypeAccountPayble\": 8463,\n \"IDTypeAccountPaybleFather\": 2680,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8357.544864090167,\n \"Qty\": 2739\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5766.728462429726,\n \"Qty\": 3241\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 796.4785040267298,\n \"Qty\": 888\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Subtotal\",\n \"IDTypeCategoryAccountPayble\": 7080,\n \"Description\": \"string\",\n \"Sign\": \"+\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8459.744685952477,\n \"Qty\": 8072,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 5187,\n \"IDTypeAccountPaybleFather\": 945,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4769.809273680101,\n \"Qty\": 1946\n },\n {\n \"IDTypeAccountPayble\": 723,\n \"IDTypeAccountPaybleFather\": 852,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5533.029511543408,\n \"Qty\": 7731\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7430.109488600354,\n \"Qty\": 7896\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4204.297145262012,\n \"Qty\": 1829\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Category\",\n \"IDTypeCategoryAccountPayble\": 8840,\n \"Description\": \"string\",\n \"Sign\": \"+\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 906.3649011480845,\n \"Qty\": 3926,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 4852,\n \"IDTypeAccountPaybleFather\": 980,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6743.088765859246,\n \"Qty\": 5988\n },\n {\n \"IDTypeAccountPayble\": 4501,\n \"IDTypeAccountPaybleFather\": 4956,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 0,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7091.547728191991,\n \"Qty\": 5785\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8094.527330931563,\n \"Qty\": 1564\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8494.932057694747,\n \"Qty\": 8939\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Category\",\n \"IDTypeCategoryAccountPayble\": 3945,\n \"Description\": \"string\",\n \"Sign\": \"±\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 2803.650411903138,\n \"Qty\": 9155,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 128,\n \"IDTypeAccountPaybleFather\": 3383,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1421.0502796670487,\n \"Qty\": 9639\n },\n {\n \"IDTypeAccountPayble\": 5667,\n \"IDTypeAccountPaybleFather\": 9566,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1896.8594329558596,\n \"Qty\": 6287\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1524.0924474586736,\n \"Qty\": 8575\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1583.266426411525,\n \"Qty\": 7913\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Subtotal\",\n \"IDTypeCategoryAccountPayble\": 4543,\n \"Description\": \"string\",\n \"Sign\": \"-\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6037.689898743337,\n \"Qty\": 1,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 5563,\n \"IDTypeAccountPaybleFather\": 7120,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 0,\n \"IsCategoryInherited\": 0,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5990.915664135458,\n \"Qty\": 5869\n },\n {\n \"IDTypeAccountPayble\": 4469,\n \"IDTypeAccountPaybleFather\": 905,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1986.131150502015,\n \"Qty\": 9595\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9830.584079247037,\n \"Qty\": 5399\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8410.187781532597,\n \"Qty\": 8747\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 5109,\n \"Description\": \"string\",\n \"Sign\": \"\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 2019.3964888529893,\n \"Qty\": 3561,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 9941,\n \"IDTypeAccountPaybleFather\": 611,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9252.813204464077,\n \"Qty\": 2461\n },\n {\n \"IDTypeAccountPayble\": 792,\n \"IDTypeAccountPaybleFather\": 2887,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 57.58810977070539,\n \"Qty\": 1072\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7665.091847394512,\n \"Qty\": 8985\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 3774.8898801793794,\n \"Qty\": 2018\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 4891,\n \"Description\": \"string\",\n \"Sign\": \"-\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4625.740499003293,\n \"Qty\": 340,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 9463,\n \"IDTypeAccountPaybleFather\": 5028,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1210.5506509728104,\n \"Qty\": 5542\n },\n {\n \"IDTypeAccountPayble\": 441,\n \"IDTypeAccountPaybleFather\": 2052,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7156.396053442791,\n \"Qty\": 3181\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1639.9679127563927,\n \"Qty\": 7988\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9078.649875205514,\n \"Qty\": 1328\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Subtotal\",\n \"IDTypeCategoryAccountPayble\": 3336,\n \"Description\": \"string\",\n \"Sign\": \"-\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5987.786760654443,\n \"Qty\": 7295,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 8159,\n \"IDTypeAccountPaybleFather\": 4943,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6077.304701457285,\n \"Qty\": 6439\n },\n {\n \"IDTypeAccountPayble\": 7860,\n \"IDTypeAccountPaybleFather\": 728,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6202.274056626668,\n \"Qty\": 7556\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 446.04837833549516,\n \"Qty\": 8484\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7612.072029948152,\n \"Qty\": 4550\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Category\",\n \"IDTypeCategoryAccountPayble\": 2105,\n \"Description\": \"string\",\n \"Sign\": \"=\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1382.5317400862768,\n \"Qty\": 2067,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 4188,\n \"IDTypeAccountPaybleFather\": 9215,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6938.834961854958,\n \"Qty\": 5684\n },\n {\n \"IDTypeAccountPayble\": 7969,\n \"IDTypeAccountPaybleFather\": 4275,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7454.495149127738,\n \"Qty\": 631\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 2721.2587400225343,\n \"Qty\": 4072\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1063.5025832524868,\n \"Qty\": 3712\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 3582,\n \"Description\": \"string\",\n \"Sign\": \"+\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1448.4601099668514,\n \"Qty\": 7138,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 7880,\n \"IDTypeAccountPaybleFather\": 229,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 1454.5063863895357,\n \"Qty\": 9215\n },\n {\n \"IDTypeAccountPayble\": 3274,\n \"IDTypeAccountPaybleFather\": 5048,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"Packaging\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9740.380176027407,\n \"Qty\": 9407\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8531.311188809674,\n \"Qty\": 1725\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 3484.4177411793708,\n \"Qty\": 9917\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 5087,\n \"Description\": \"string\",\n \"Sign\": \"\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7759.774408657971,\n \"Qty\": 1266,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 3906,\n \"IDTypeAccountPaybleFather\": 4445,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 0,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 4002.4071550324193,\n \"Qty\": 2541\n },\n {\n \"IDTypeAccountPayble\": 2956,\n \"IDTypeAccountPaybleFather\": 3611,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 260.0562317698185,\n \"Qty\": 98\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 3433.470580778957,\n \"Qty\": 6445\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 2201.8690031219835,\n \"Qty\": 9318\n }\n ]\n }\n ],\n \"OutsideResult\": [\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"CostOfGoodsSold\",\n \"IDTypeCategoryAccountPayble\": 1823,\n \"Description\": \"string\",\n \"Sign\": \"-\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 3468.1818971141665,\n \"Qty\": 3260,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 2028,\n \"IDTypeAccountPaybleFather\": 7873,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 0,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5185.570616407717,\n \"Qty\": 2391\n },\n {\n \"IDTypeAccountPayble\": 3257,\n \"IDTypeAccountPaybleFather\": 477,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6118.270435129656,\n \"Qty\": 8579\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Goods\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 7382.812851588496,\n \"Qty\": 7043\n },\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8903.419042515558,\n \"Qty\": 9717\n }\n ]\n },\n {\n \"Key\": \"ProductRevenue\",\n \"Kind\": \"Subtotal\",\n \"IDTypeCategoryAccountPayble\": 3906,\n \"Description\": \"string\",\n \"Sign\": \"=\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6765.850884971221,\n \"Qty\": 2770,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 4798,\n \"IDTypeAccountPaybleFather\": 5895,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8314.293495829921,\n \"Qty\": 4062\n },\n {\n \"IDTypeAccountPayble\": 6196,\n \"IDTypeAccountPaybleFather\": 9770,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 1,\n \"Source\": \"Stock\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6342.452319093645,\n \"Qty\": 6094\n }\n ],\n \"Groups\": [\n {\n \"Key\": \"Gratification\",\n \"Description\": \"Mercadorias\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 6124.7787688583185,\n \"Qty\": 8243\n },\n {\n \"Key\": \"Goods\",\n \"Description\": \"Bonificações\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 9966.241422592424,\n \"Qty\": 2249\n }\n ]\n }\n ],\n \"Unclassified\": {\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 5312.561255268426,\n \"Qty\": 7504,\n \"Accounts\": [\n {\n \"IDTypeAccountPayble\": 8227,\n \"IDTypeAccountPaybleFather\": 5011,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 0,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 8007.405653798294,\n \"Qty\": 4940\n },\n {\n \"IDTypeAccountPayble\": 326,\n \"IDTypeAccountPaybleFather\": 8746,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": \"string\",\n \"AccountName\": \"string\",\n \"IDTypeAccount\": 1,\n \"Status\": 1,\n \"IsCategoryInherited\": 0,\n \"Source\": \"OrderItems\",\n \"StockGroup\": \"SalesDiscount\",\n \"Values\": {\n \"2026-01\": 15230.4,\n \"2026-02\": -820.15,\n \"2026-03\": 0\n },\n \"Total\": 3498.0137742837082,\n \"Qty\": 1413\n }\n ]\n },\n \"WithoutCompetence\": {\n \"Qty\": 1078,\n \"Receivable\": 9885.72909367827,\n \"Payable\": 9133.30792638831\n },\n \"CostOfGoodsSoldCheck\": {\n \"ZeroCost\": {\n \"Qty\": 9701,\n \"Revenue\": 72.82402882033966\n },\n \"InvalidCost\": {\n \"Qty\": 8471\n },\n \"WithoutStockOut\": {\n \"Qty\": 2421,\n \"QtyReturn\": 8884\n },\n \"PurchaseInCost\": {\n \"Qty\": 7435,\n \"Total\": 3591.3683182172363\n }\n },\n \"SalesDiscount\": {\n \"Qty\": 7093,\n \"Total\": 1681.8995609786436\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72659ec2-c035-415e-a470-aa147ddede84", "name": "Erro de validação. Mensagens possíveis:\n- `[BadRequest] - Type inválido. Use Summary ou Detail` — `Type` fora do enum.\n- `[BadRequest] - Erro na configuração da empresa` — o token não traz empresa para o subdomínio.\n- `[BadRequest] - Informe o período da DRE (DateFrom e DateTo)` — `DateFrom` ou `DateTo` ausente, fora do formato `YYYY-MM-DD` ou data que não existe (ex.: `2026-02-30`).\n- `[BadRequest] - A data final precisa ser igual ou posterior à data inicial`\n- `[BadRequest] - Data base inválida. Use Competence, DateDue, DatePayment` — `DateType` fora do enum.\n- `[BadRequest] - O período da DRE pode ter no máximo 24 meses`\n- `[BadRequest] - Empresa inválida` — `IDCompanyInvoice` não é inteiro positivo.\n- `[BadRequest] - Canal de vendas inválido` — `IDTypeCompanyIntegration` com item que não é inteiro positivo (ex.: `abc`, `0`, `12,`) ou com mais de 200 ids.\n- `[BadRequest] - Integração inválida` — o mesmo, em `IDCompanyIntegration`.\n- `[BadRequest] - Tipo de pedido inválido` — o mesmo, em `IDOrderType`.\n- `[BadRequest] - Informe a classificação, o plano de contas ou os títulos sem classificação` — `Type=Detail` sem nenhum recorte.\n- `[BadRequest] - O recorte WithoutCompetence só vale com a data base Competence` — `Type=Detail` com `WithoutCompetence=1` e `DateType` diferente de `Competence`.\n- `[BadRequest] - O recorte do CMV só vale com a data base Competence` — `Type=Detail` com `CostOfGoodsSoldCheck`, `CostOfGoodsSold=1` ou `PurchaseInCost=1` e `DateType` diferente de `Competence`.\n- `[BadRequest] - Verificação do CMV inválida. Use ZeroCost, InvalidCost ou WithoutStockOut` — `Type=Detail` com `CostOfGoodsSoldCheck` fora do enum.\n- `[BadRequest] - Grupo do CMV inválido. Use Goods ou Gratification` — `Type=Detail` com `CostOfGoodsSold=1` e `CostOfGoodsSoldGroup` fora do enum (inclusive `Packaging`, que virou o recorte `Packaging=1`).\n- `[BadRequest] - O recorte de estoque só vale com a data base Competence` — `Type=Detail` com `Packaging=1` ou `SalesDiscount=1` e `DateType` diferente de `Competence`.\n- `[BadRequest] - Classificação não existe` — `Type=Detail` com `IDTypeCategoryAccountPayble` fora do catálogo (ou que não é inteiro positivo).\n- `[BadRequest] - Plano de contas inválido` — `Type=Detail` com `IDTypeAccountPayble` que não é inteiro positivo (no recorte de plano ou junto com `SalesDiscount=1`).", "originalRequest": { "url": { "path": [ "accounts", "income-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "Summary" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "DateType", "value": "Competence" }, { "key": "IDCompanyInvoice", "value": "1209" }, { "key": "IDTypeCompanyIntegration", "value": "6198,5677" }, { "key": "IDCompanyIntegration", "value": "6198,5677" }, { "key": "IDOrderType", "value": "6198,5677" }, { "key": "IncludeSalesDiscount", "value": "1" }, { "key": "IDTypeCategoryAccountPayble", "value": "1209" }, { "key": "IDTypeAccountPayble", "value": "1209" }, { "key": "Unclassified", "value": "1" }, { "key": "WithoutAccount", "value": "1" }, { "key": "WithoutCompetence", "value": "1" }, { "key": "CostOfGoodsSoldCheck", "value": "ZeroCost" }, { "key": "CostOfGoodsSold", "value": "1" }, { "key": "CostOfGoodsSoldGroup", "value": "Goods" }, { "key": "Packaging", "value": "1" }, { "key": "SalesDiscount", "value": "1" }, { "key": "PurchaseInCost", "value": "1" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a620d7e-cd34-4e39-b9de-aa1da1813b2d", "name": "Erro interno (prefixo `Error:`), com o erro do banco entre parênteses quando houver. Mensagens possíveis:\n- `Error: falha ao consultar o plano de contas ()`\n- `Error: falha ao consultar as classificações do plano de contas ()`\n- `Error: falha ao somar os títulos da DRE ()` — Resumo.\n- `Error: falha ao somar os títulos sem data de competência ()` — Resumo, só no `DateType=Competence`.\n- `Error: falha ao somar o CMV ()` — Resumo, só no `DateType=Competence`.\n- `Error: falha ao somar os descontos de venda ()` — Resumo, só com `IncludeSalesDiscount=1` no `DateType=Competence`.\n- `Error: falha ao listar os títulos da DRE ()` — Detalhe (recortes de título, inclusive `PurchaseInCost`).\n- `Error: falha ao listar os itens do CMV ()` — Detalhe, recortes `CostOfGoodsSold` e `CostOfGoodsSoldCheck=ZeroCost|InvalidCost`.\n- `Error: falha ao listar as embalagens do estoque ()` — Detalhe, recorte `Packaging`.\n- `Error: falha ao listar os descontos de venda ()` — Detalhe, recorte `SalesDiscount`.\n- `Error: falha ao listar os pedidos sem baixa de estoque ()` — Detalhe, recorte `CostOfGoodsSoldCheck=WithoutStockOut`.\n- `Error: falha ao montar a DRE` (Resumo) e `Error: falha ao listar os títulos da DRE` (Detalhe) — falha inesperada.", "originalRequest": { "url": { "path": [ "accounts", "income-statement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "Summary" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "DateType", "value": "Competence" }, { "key": "IDCompanyInvoice", "value": "1209" }, { "key": "IDTypeCompanyIntegration", "value": "6198,5677" }, { "key": "IDCompanyIntegration", "value": "6198,5677" }, { "key": "IDOrderType", "value": "6198,5677" }, { "key": "IncludeSalesDiscount", "value": "1" }, { "key": "IDTypeCategoryAccountPayble", "value": "1209" }, { "key": "IDTypeAccountPayble", "value": "1209" }, { "key": "Unclassified", "value": "1" }, { "key": "WithoutAccount", "value": "1" }, { "key": "WithoutCompetence", "value": "1" }, { "key": "CostOfGoodsSoldCheck", "value": "ZeroCost" }, { "key": "CostOfGoodsSold", "value": "1" }, { "key": "CostOfGoodsSoldGroup", "value": "Goods" }, { "key": "Packaging", "value": "1" }, { "key": "SalesDiscount", "value": "1" }, { "key": "PurchaseInCost", "value": "1" }, { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7865491e-841e-4a4a-96f8-6f46c0bd257e", "name": "Dashboards", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d09e9137-d691-47f1-a39a-6f3e7e1c1a2a", "name": "Retorna indicadores do painel inicial por categoria", "request": { "name": "Retorna indicadores do painel inicial por categoria", "description": { "content": "Devolve os blocos de KPIs do painel inicial conforme a categoria solicitada. As categorias `8` e `9` têm comportamento próprio: financeiro consolida vencimentos do mês corrente; rastreio agrega entregas no prazo e atrasadas. As demais categorias retornam a lista de cartões configurados para a empresa.\n\nQuando `IDTypeCompanyDashboardCategory=8`, os filtros adicionais por data de vencimento, fornecedor, faturador e conta bancária da previsão se aplicam. Quando `IDTypeCompanyDashboardCategory=9`, vale a janela de embarque `ShippingDate*` e de criação do pedido `RecordTimestamp` via `DateFrom`/`DateTo` — sem datas, considera os últimos 7 dias.", "type": "text/plain" }, "url": { "path": [ "company", "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyDashboardCategory", "value": "2232", "description": "Categoria do painel a ser retornado. Valores especiais: `8` = financeiro (vencimentos); `9` = rastreio (entregas)." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial de criação do pedido (apenas categoria rastreio)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final de criação do pedido (apenas categoria rastreio). O sistema concatena `23:59:59` ao filtrar." }, { "disabled": false, "key": "ShippingDateFrom", "value": "1980-02-08", "description": "Data inicial do embarque (apenas categoria rastreio)." }, { "disabled": false, "key": "ShippingDateTo", "value": "1980-02-08", "description": "Data final do embarque (apenas categoria rastreio)." }, { "disabled": false, "key": "DateDueFrom", "value": "1980-02-08", "description": "Data inicial de vencimento (apenas categoria financeiro). Default: `1900-01-01`." }, { "disabled": false, "key": "DateDueTo", "value": "1980-02-08", "description": "Data final de vencimento (apenas categoria financeiro). Default: `4000-01-01`." }, { "disabled": false, "key": "IDTypeAccount", "value": "1", "description": "Tipo da conta: `0` = entrada (receber); `1` = saída (pagar)." }, { "disabled": false, "key": "IDTypeAccountPayableReceivable", "value": "2232", "description": "Tipo do título financeiro." }, { "disabled": false, "key": "IDStatusAccountPayableReceivable", "value": "6", "description": "Status do título financeiro." }, { "disabled": false, "key": "IDSupplier", "value": "2232", "description": "Identificador do fornecedor." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Identificador do faturador." }, { "disabled": false, "key": "IDBankAccountForecast", "value": "2232", "description": "Identificador da conta bancária de previsão." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "00668d8a-9440-46b6-a409-bd3c4a59b40e", "name": "Indicadores retornados.", "originalRequest": { "url": { "path": [ "company", "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyDashboardCategory", "value": "2232" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "ShippingDateFrom", "value": "1980-02-08" }, { "key": "ShippingDateTo", "value": "1980-02-08" }, { "key": "DateDueFrom", "value": "1980-02-08" }, { "key": "DateDueTo", "value": "1980-02-08" }, { "key": "IDTypeAccount", "value": "1" }, { "key": "IDTypeAccountPayableReceivable", "value": "2232" }, { "key": "IDStatusAccountPayableReceivable", "value": "6" }, { "key": "IDSupplier", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "IDBankAccountForecast", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeCompanyDashboardCategory\": 5859,\n \"Privilege\": \"string\",\n \"TypeCompanyDashboardCategory\": \"string\",\n \"TypeCompanyDashboard\": [\n {\n \"IDTypeCompanyDashboard\": 7058,\n \"TypeCompanyDashboard\": \"string\",\n \"Value\": \"string\",\n \"URLSearchParams\": \"string\",\n \"component\": \"string\",\n \"UpdatedAt\": \"1974-01-26T21:49:09.707Z\",\n \"Difference\": 9153.519692036685,\n \"ValueTotal\": 6561.557478106243,\n \"UserPrivilege\": \"string\",\n \"ItemsTotal\": 9250\n },\n {\n \"IDTypeCompanyDashboard\": 1046,\n \"TypeCompanyDashboard\": \"string\",\n \"Value\": \"string\",\n \"URLSearchParams\": \"string\",\n \"component\": \"string\",\n \"UpdatedAt\": \"1989-10-18T03:22:48.690Z\",\n \"Difference\": 5516.898412179212,\n \"ValueTotal\": 3506.9534169315643,\n \"UserPrivilege\": \"string\",\n \"ItemsTotal\": 5986\n }\n ]\n },\n {\n \"IDTypeCompanyDashboardCategory\": 1757,\n \"Privilege\": \"string\",\n \"TypeCompanyDashboardCategory\": \"string\",\n \"TypeCompanyDashboard\": [\n {\n \"IDTypeCompanyDashboard\": 181,\n \"TypeCompanyDashboard\": \"string\",\n \"Value\": \"string\",\n \"URLSearchParams\": \"string\",\n \"component\": \"string\",\n \"UpdatedAt\": \"2019-09-21T23:07:19.352Z\",\n \"Difference\": 5616.395279506954,\n \"ValueTotal\": 4309.677154764562,\n \"UserPrivilege\": \"string\",\n \"ItemsTotal\": 2998\n },\n {\n \"IDTypeCompanyDashboard\": 8683,\n \"TypeCompanyDashboard\": \"string\",\n \"Value\": \"string\",\n \"URLSearchParams\": \"string\",\n \"component\": \"string\",\n \"UpdatedAt\": \"1970-11-14T15:01:15.786Z\",\n \"Difference\": 3711.823168082835,\n \"ValueTotal\": 9584.285246295858,\n \"UserPrivilege\": \"string\",\n \"ItemsTotal\": 5045\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0ec14bc-6634-4763-a4b7-3dd07f83c7fd", "name": "Contagem de pedidos por status para o painel", "request": { "name": "Contagem de pedidos por status para o painel", "description": { "content": "Retorna o total de pedidos agrupado por status para o painel inicial, respeitando os centros de distribuição liberados ao usuário. Quando `Budget=1`, contabiliza apenas os status do fluxo de orçamento (`50` a `56`); caso contrário, contabiliza os status operacionais `0`, `1`, `2`, `3`, `4`, `5`, `6`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `17`, `19`, `20`, `21`, `22`, `23`, `24`, `30`, `89`, `93` e `95` — o status `7` Enviado e os demais status finais não entram na contagem. Só aparecem status configurados para a empresa; status sem pedido no período vêm com `Qty` igual a `0`.", "type": "text/plain" }, "url": { "path": [ "company", "dashboard", "order", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Budget", "value": "1", "description": "Quando `1`, contabiliza apenas status do fluxo de orçamento." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "19580f4e-c614-47e5-8156-e21d6c66a081", "name": "Contagem por status.", "originalRequest": { "url": { "path": [ "company", "dashboard", "order", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Budget", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStatusOrder\": \"24\",\n \"StatusOrder\": \"string\",\n \"Order\": \"string\",\n \"StatusOrderDescription\": \"string\",\n \"Qty\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDStatusOrder\": \"89\",\n \"StatusOrder\": \"string\",\n \"Order\": \"string\",\n \"StatusOrderDescription\": \"string\",\n \"Qty\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "26fc769c-a832-441a-aa4b-4629467d6d10", "name": "Departamentos Tributários", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "aa684b64-1183-4e54-90ba-3d3783456c00", "name": "Lista os departamentos fiscais ativos", "request": { "name": "Lista os departamentos fiscais ativos", "description": { "content": "Retorna os departamentos fiscais (cadastro hierárquico que agrupa as regras tributárias dos SKUs) com filtros opcionais por identificador, nome e empresa. Limite máximo de 2000 registros por chamada.\n\nQuando o contexto autenticado indica `accountname=all`, a lista cobre todas as empresas relacionadas; caso contrário, restringe à empresa do subdomínio.", "type": "text/plain" }, "url": { "path": [ "tax" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTaxDepartment", "value": "2232", "description": "Filtra por identificador do departamento fiscal." }, { "disabled": false, "key": "TaxDepartmentDescription", "value": "string", "description": "Filtra por nome exato do departamento fiscal." }, { "disabled": false, "key": "Status", "value": "1", "description": "Filtra por situação. `1` (default) retorna apenas departamentos ativos." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "99948ced-ee4a-4088-bfac-2449a6d9c2a4", "name": "Lista de departamentos fiscais.", "originalRequest": { "url": { "path": [ "tax" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTaxDepartment", "value": "2232" }, { "key": "TaxDepartmentDescription", "value": "string" }, { "key": "Status", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTaxDepartment\": 471,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\"\n },\n {\n \"IDTaxDepartment\": 6985,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "527ae19c-9688-46c1-896a-d25500fc9b81", "name": "Cria um departamento fiscal", "request": { "name": "Cria um departamento fiscal", "description": { "content": "Cria um novo departamento fiscal associado à empresa autenticada e retorna o registro completo já com o array de regras `Cfop` (vazio neste momento), usando a mesma estrutura do detalhe.\n\nO nome `TaxDepartmentDescription` deve ser único entre os departamentos ativos da empresa.", "type": "text/plain" }, "url": { "path": [ "tax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"TaxDepartmentDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "20ff0499-2be7-43bd-8a84-237855150723", "name": "Departamento fiscal criado. Retorna o detalhe completo, no mesmo shape de `GET /tax/{idtaxdepartment}`.", "originalRequest": { "url": { "path": [ "tax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TaxDepartmentDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTaxDepartment\": 6890,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 34,\n \"IDTaxDepartment\": 3185,\n \"IDCompany\": 7233,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 0,\n \"Gratification\": 1,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 6103.372534844009,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 8323.892548287122,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 9537.360139849705,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 6176.513931776144,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 5276.733598414514,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 3490.8901108018877,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 6880,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 1400,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 5352,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 6348,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 7030,\n \"IDTaxDepartment\": 1840,\n \"IDCompany\": 6467,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 0,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 1147.4918800797896,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 9196.340638615395,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 1805.2478107003856,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7794.872380119551,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 378.6081846119882,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 70.97801593312747,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 4665,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 1334,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 6493,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 9299,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n },\n {\n \"IDTaxDepartment\": 9518,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 1335,\n \"IDTaxDepartment\": 6117,\n \"IDCompany\": 671,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 9575.562840152825,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 1445.3818563438058,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 2016.3214362018844,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 5190.000030743927,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 4901.282444887723,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 1006.6073527531971,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 3474,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 3599,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 157,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 8236,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 8553,\n \"IDTaxDepartment\": 3347,\n \"IDCompany\": 2065,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 419.3504037603901,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 356.0686177954153,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 2709.4208944457932,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 804.4117997133138,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 7983.697340783305,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 2240.450651157866,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 1935,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 9752,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 6721,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 7984,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f0de743-b8a9-419c-acb3-559ecbb22c33", "name": "Validação ou conflito. Mensagens (prefixo `[BadRequest]`): `Empresa não existe`; `Já existe um departamento fiscal com este nome`.", "originalRequest": { "url": { "path": [ "tax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TaxDepartmentDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5336dad-79f3-4b43-b7db-203a8118c6c8", "name": "Retorna o detalhe de um departamento fiscal", "request": { "name": "Retorna o detalhe de um departamento fiscal", "description": { "content": "Retorna o departamento fiscal junto do array `Cfop[]` com todas as regras fiscais federais já configuradas (PIS/COFINS, IPI saída e entrada, IBS/CBS, CFOPs por direção e estado, switches da regra). As regras ICMS por estado de cada CFOP devem ser obtidas via `GET /tax/{idtaxdepartment}/cfop/{idtax}`.\n\nFiltro opcional `IDCompany` restringe os CFOPs aos da filial informada (cenário multi-CNPJ).", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompany", "value": "2232", "description": "Restringe os CFOPs retornados aos cadastrados na filial informada." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1b722618-8178-4175-a1fe-32104f420975", "name": "Detalhe do departamento fiscal. Retorna um array com o departamento encontrado (item único, com `Cfop[]` preenchido ou vazio quando não há regras cadastradas); array vazio quando nenhum departamento corresponde aos filtros informados (`idtaxdepartment`/`IDCompany`/conta).", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompany", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTaxDepartment\": 4005,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 0,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 4285,\n \"IDTaxDepartment\": 4828,\n \"IDCompany\": 6992,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 6426.880391303504,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 6281.064085039905,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 9374.279370993732,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7637.696402603787,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 7329.707897047688,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8794.547587618397,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 9411,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 4739,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 5534,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 431,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 3748,\n \"IDTaxDepartment\": 3654,\n \"IDCompany\": 1524,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 6354.813923359097,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 7313.86784420428,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 311.856252353151,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7569.015699898274,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 3928.981119171957,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8233.644823978751,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 2888,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 2769,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 5429,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 7882,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n },\n {\n \"IDTaxDepartment\": 9657,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 5084,\n \"IDTaxDepartment\": 6552,\n \"IDCompany\": 6874,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 0,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 841.3972403978787,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 1077.4023351739736,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 3733.622070234455,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 2041.5873691521158,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 4681.596551602085,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 47.91466507543474,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 2961,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 6408,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 2486,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 3221,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 9988,\n \"IDTaxDepartment\": 46,\n \"IDCompany\": 4936,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 7134.884775519808,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 7820.647044477689,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 8169.0266861676955,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 4423.066618530484,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 8690.848589219053,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8231.152011173053,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 8182,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 8005,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 2093,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 4024,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c437913e-c4d5-43bd-97a0-90c3153edb35", "name": "Atualiza o nome de um departamento fiscal", "request": { "name": "Atualiza o nome de um departamento fiscal", "description": { "content": "Altera o nome do departamento fiscal. Mantém a unicidade do nome entre os departamentos ativos da empresa. Após a atualização, retorna a lista completa de departamentos ativos (mesmo shape de `GET /tax`).", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"TaxDepartmentDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "39ec3ecf-b557-4dc3-8d15-700af71ad435", "name": "Departamento atualizado. Retorna a lista de departamentos da empresa.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TaxDepartmentDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTaxDepartment\": 471,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\"\n },\n {\n \"IDTaxDepartment\": 6985,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b77954ed-f85c-4834-a5f9-70e183af197b", "name": "Validação ou conflito. Mensagens (prefixo `[BadRequest]`): `Departamento fiscal não existe`; `Já existe um departamento fiscal com este nome`.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TaxDepartmentDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1e421dd-1df7-49be-a284-13e44a13af4d", "name": "Inativa um departamento fiscal", "request": { "name": "Inativa um departamento fiscal", "description": { "content": "Inativa o departamento fiscal (soft delete via `Status=0`). A exclusão é bloqueada quando o departamento está em uso: vinculado a algum SKU ou referenciado pela regra fiscal de um Tipo de Pedido.\n\nRetorna a lista atualizada de departamentos ativos da empresa.", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "b12d1da3-7edc-4911-be40-480a2ef3ea04", "name": "Departamento inativado. Retorna a lista de departamentos ativos.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTaxDepartment\": 471,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\"\n },\n {\n \"IDTaxDepartment\": 6985,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ca38cf3-8ee6-451b-bc16-f47be8a8b40a", "name": "Bloqueado por uso ou departamento inexistente. Mensagens (prefixo `[BadRequest]`): `Departamento fiscal não existe`; `Departamento fiscal esta em alguns SKUs, remover o departamento do SKU antes de deletar`; `Depatarmento fiscal esta na regra fiscal do tipo de pedido: \"\" ()`.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01afa95d-f335-4fee-beb4-c9f127906ece", "name": "Cria uma regra fiscal (CFOP) dentro de um departamento", "request": { "name": "Cria uma regra fiscal (CFOP) dentro de um departamento", "description": { "content": "Cria uma regra fiscal federal dentro do departamento. A regra agrupa PIS/COFINS de saída e entrada, IPI (saída/entrada), classificação IBS/CBS, os quatro CFOPs por direção e estado (dentro/fora do estado) e diversos switches que reconfiguram o cálculo (consumidor final `NfeindFinal`, contribuinte `NfeTaxPayer`, bonificação `Gratification`, cálculo reverso `ReverseTaxCalculation`, exportação `NfeExport`, emissão de NFCe `IssueNFCe`).\n\nValidações principais: alíquotas de PIS e COFINS limitadas a 50%; os CSTs de PIS e COFINS são obrigatórios; cada CFOP é validado contra o cadastro de CFOP e quanto ao primeiro dígito (saída no estado começa com 5 ou 7; saída fora do estado com 6; entrada no estado com 1 ou 3; entrada fora do estado com 2); o enquadramento `IpiCEnq` é exigido em faixas específicas para os CSTs de IPI `02`/`52` (300–399), `04`/`54` (0–99) e `05`/`55` (100–199); quando `IDNfCstIbsCbs` é informado, a classificação IBS/CBS precisa existir.\n\nRetorna o detalhe da regra recém-criada (mesmo shape de `GET /tax/{idtaxdepartment}/cfop/{idtax}`), com o array `Icms[]` ainda vazio.", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment", "cfop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyBranch\": 6244,\n \"TypeTaxName\": \"string\",\n \"PisCst\": \"st\",\n \"CofinsCst\": \"st\",\n \"Standard\": 1,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 0,\n \"Gratification\": 0,\n \"NfeExport\": 0,\n \"ReverseTaxCalculation\": 1,\n \"IssueNFCe\": 0,\n \"PisAliquot\": 4866.832761621687,\n \"CofinsAliquot\": 6073.369525996899,\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 5465.006505093393,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7491.268487545617,\n \"IpiCst\": \"02\",\n \"IpiAliquot\": 7637.977952260584,\n \"IpiCEnq\": \"str\",\n \"IpiCstInbound\": \"52\",\n \"IpiAliquotInbound\": 6709.465454161367,\n \"IDNfCstIbsCbs\": 2092,\n \"CfopOutboundInState\": 6895,\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 6746,\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 3025,\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 7195,\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"IIAliquot\": 1196.3285089556641,\n \"TaxSkuCest\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5c0268b6-0643-416a-b0f5-d8f87228da80", "name": "Regra fiscal criada. Retorna o detalhe completo.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyBranch\": 6244,\n \"TypeTaxName\": \"string\",\n \"PisCst\": \"st\",\n \"CofinsCst\": \"st\",\n \"Standard\": 1,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 0,\n \"Gratification\": 0,\n \"NfeExport\": 0,\n \"ReverseTaxCalculation\": 1,\n \"IssueNFCe\": 0,\n \"PisAliquot\": 4866.832761621687,\n \"CofinsAliquot\": 6073.369525996899,\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 5465.006505093393,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7491.268487545617,\n \"IpiCst\": \"02\",\n \"IpiAliquot\": 7637.977952260584,\n \"IpiCEnq\": \"str\",\n \"IpiCstInbound\": \"52\",\n \"IpiAliquotInbound\": 6709.465454161367,\n \"IDNfCstIbsCbs\": 2092,\n \"CfopOutboundInState\": 6895,\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 6746,\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 3025,\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 7195,\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"IIAliquot\": 1196.3285089556641,\n \"TaxSkuCest\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 5391,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyAddressStateInvoice\": \"st\",\n \"IDTax\": 5389,\n \"IDTaxDepartment\": 1636,\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 0,\n \"ReverseTaxCalculation\": 0,\n \"IssueNFCe\": 1,\n \"IIAliquot\": 2537.1315193441515,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 4582.3273228083435,\n \"NfCstPisDescription\": \"string\",\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 1812.7995352863668,\n \"NfCstCofinsDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 5106.35270109149,\n \"NfCstPisInboundDescription\": \"string\",\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 2173.2641088872606,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 5438.162488736302,\n \"NfCstIpiDescription\": \"string\",\n \"IpiCEnq\": \"str\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 2989.9614153680363,\n \"NfCstIpiInboundDescription\": \"string\",\n \"IDNfCstIbsCbs\": 5855,\n \"NfCstIbsCbsDescription\": \"string\",\n \"CfopOutboundInState\": 2636,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 9232,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 2853,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 2375,\n \"CfopInboundOutStateDescription\": \"string\",\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"Icms\": [\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 6500,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"90\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 1,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 4360.333556814173,\n \"IcmsPRedBC\": 5083.141727633826,\n \"IcmsDifalPRedBC\": 8449.097563810752,\n \"FecpAliquot\": 1952.054328842483,\n \"IcmsModBCST\": 1,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 2536.2678029066333,\n \"IcmsPMVASTSimples\": 2614.1972636414266,\n \"IcmsPMVASTMadeOutBrazil\": 2753.958747410299,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 8586.27911669915,\n \"IcmsPRedBCST\": 326.07522950742316,\n \"IcmsSTAliquot\": 6102.745174007251,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 3830.2842604067177,\n \"FecpPDif\": 1791.7342553851202,\n \"CfopOutbound\": 6429,\n \"CfopInbound\": 383,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 4727,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"60\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 0,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 6763.895866112479,\n \"IcmsPRedBC\": 7940.8960260524445,\n \"IcmsDifalPRedBC\": 9577.374672455739,\n \"FecpAliquot\": 9703.986138386697,\n \"IcmsModBCST\": 4,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 1859.6328768980475,\n \"IcmsPMVASTSimples\": 6888.771213481391,\n \"IcmsPMVASTMadeOutBrazil\": 1321.6595487724337,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 9045.959022557574,\n \"IcmsPRedBCST\": 5119.102046198929,\n \"IcmsSTAliquot\": 7062.549316913575,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 2,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 4558.271645039677,\n \"FecpPDif\": 9694.602073930775,\n \"CfopOutbound\": 6135,\n \"CfopInbound\": 2710,\n \"ItemCommentsInvoice\": \"string\"\n }\n ]\n },\n {\n \"IDCompany\": 2850,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyAddressStateInvoice\": \"st\",\n \"IDTax\": 5240,\n \"IDTaxDepartment\": 9840,\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"ReverseTaxCalculation\": 0,\n \"IssueNFCe\": 1,\n \"IIAliquot\": 343.83485192833075,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 7066.858420122028,\n \"NfCstPisDescription\": \"string\",\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 960.9669833053891,\n \"NfCstCofinsDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 6057.789553490083,\n \"NfCstPisInboundDescription\": \"string\",\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 6613.5980426731385,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 4108.769558809941,\n \"NfCstIpiDescription\": \"string\",\n \"IpiCEnq\": \"str\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 9868.282135841271,\n \"NfCstIpiInboundDescription\": \"string\",\n \"IDNfCstIbsCbs\": 821,\n \"NfCstIbsCbsDescription\": \"string\",\n \"CfopOutboundInState\": 381,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 4200,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 2279,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 6413,\n \"CfopInboundOutStateDescription\": \"string\",\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"Icms\": [\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 5972,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"900\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 1,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 7537.57744990724,\n \"IcmsPRedBC\": 4554.408747725473,\n \"IcmsDifalPRedBC\": 2190.687975095724,\n \"FecpAliquot\": 5532.108020191149,\n \"IcmsModBCST\": 3,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 9223.385156665017,\n \"IcmsPMVASTSimples\": 9058.036893752615,\n \"IcmsPMVASTMadeOutBrazil\": 6741.606259327795,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 9809.852269938247,\n \"IcmsPRedBCST\": 5973.207567731522,\n \"IcmsSTAliquot\": 8515.275147011242,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 6640.089046579758,\n \"FecpPDif\": 1556.090333502882,\n \"CfopOutbound\": 5332,\n \"CfopInbound\": 1086,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 4775,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"30\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 3,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 1118.5997743385335,\n \"IcmsPRedBC\": 1834.866903087653,\n \"IcmsDifalPRedBC\": 9605.243639135057,\n \"FecpAliquot\": 8719.341949497833,\n \"IcmsModBCST\": 4,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 58.802260999331054,\n \"IcmsPMVASTSimples\": 7780.167345695368,\n \"IcmsPMVASTMadeOutBrazil\": 6091.700412285539,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 1275.897786528406,\n \"IcmsPRedBCST\": 1115.0547557634782,\n \"IcmsSTAliquot\": 7031.017556906627,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 3,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 4416.897838094713,\n \"FecpPDif\": 7627.998863245193,\n \"CfopOutbound\": 1255,\n \"CfopInbound\": 8124,\n \"ItemCommentsInvoice\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c6234b-3bb1-4f0b-99d5-8afda5ccebf0", "name": "Validação ou conflito. Mensagens (prefixo `[BadRequest]`): `Alíquota de PIS não pode ser maior que 50%`; `Alíquota de COFINS não pode ser maior que 50%`; `Precisa informa o CST PIS`; `Precisa informa o CST COFINS`; `CFOP de saída dentro do estado não inicia com 5`; `CFOP de saída fora do estado não inicia com 6`; `CFOP de entrada dentro do estado não inicia com 1`; `CFOP de entrada fora do estado não inicia com 2`; `CFOP de não existe`; `IPI CST 02 e 52 deve ter o enquadramento entre 300 e 399`; `IPI CST 04 e 54 deve ter o enquadramento entre 0 e 99`; `IPI CST 05 e 55 deve ter o enquadramento entre 100 e 199`; `Classificação IBS/CBS não encontrada`; `Departamento fiscal não existe`.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyBranch\": 6244,\n \"TypeTaxName\": \"string\",\n \"PisCst\": \"st\",\n \"CofinsCst\": \"st\",\n \"Standard\": 1,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 0,\n \"Gratification\": 0,\n \"NfeExport\": 0,\n \"ReverseTaxCalculation\": 1,\n \"IssueNFCe\": 0,\n \"PisAliquot\": 4866.832761621687,\n \"CofinsAliquot\": 6073.369525996899,\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 5465.006505093393,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7491.268487545617,\n \"IpiCst\": \"02\",\n \"IpiAliquot\": 7637.977952260584,\n \"IpiCEnq\": \"str\",\n \"IpiCstInbound\": \"52\",\n \"IpiAliquotInbound\": 6709.465454161367,\n \"IDNfCstIbsCbs\": 2092,\n \"CfopOutboundInState\": 6895,\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 6746,\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 3025,\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 7195,\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"IIAliquot\": 1196.3285089556641,\n \"TaxSkuCest\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3225dfb2-eb20-4d9b-9eac-6d03d2e46351", "name": "Retorna o detalhe de uma regra fiscal (CFOP) com suas regras ICMS por estado", "request": { "name": "Retorna o detalhe de uma regra fiscal (CFOP) com suas regras ICMS por estado", "description": { "content": "Retorna a regra fiscal completa: campos federais (PIS/COFINS saída e entrada, IPI saída e entrada, IBS/CBS), os quatro CFOPs por direção/estado com descrição resolvida e o array `Icms[]` com todas as regras ICMS por estado destino já configuradas para essa regra (cada item traz CST ICMS, alíquota, base de cálculo, ICMS ST, FCP, DIFAL e os campos de override por estado).", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "94df59ff-d095-4072-b0b4-e8a4974ceddf", "name": "Detalhe da regra fiscal. Array vazio quando a regra não existe no departamento informado, não pertence a ele ou é de outra conta — não há `404`.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 8638,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyAddressStateInvoice\": \"st\",\n \"IDTax\": 5161,\n \"IDTaxDepartment\": 282,\n \"TypeTaxName\": \"string\",\n \"Standard\": 0,\n \"Gratification\": 0,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 0,\n \"ReverseTaxCalculation\": 0,\n \"IssueNFCe\": 1,\n \"IIAliquot\": 1017.6051298025191,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 4835.739069777683,\n \"NfCstPisDescription\": \"string\",\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 408.9869616985298,\n \"NfCstCofinsDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 3781.0561536992427,\n \"NfCstPisInboundDescription\": \"string\",\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 8824.37638318489,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 9679.201522825138,\n \"NfCstIpiDescription\": \"string\",\n \"IpiCEnq\": \"str\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 3583.023253005844,\n \"NfCstIpiInboundDescription\": \"string\",\n \"IDNfCstIbsCbs\": 1561,\n \"NfCstIbsCbsDescription\": \"string\",\n \"CfopOutboundInState\": 1460,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 5076,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 7810,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 2170,\n \"CfopInboundOutStateDescription\": \"string\",\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"Icms\": [\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 3872,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"300\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 2,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 5578.646322020375,\n \"IcmsPRedBC\": 6548.003844743149,\n \"IcmsDifalPRedBC\": 6729.228319357921,\n \"FecpAliquot\": 1267.0153908213267,\n \"IcmsModBCST\": 4,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 3057.3854029188064,\n \"IcmsPMVASTSimples\": 9827.409430182357,\n \"IcmsPMVASTMadeOutBrazil\": 7828.6145473123715,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 7832.300857092165,\n \"IcmsPRedBCST\": 2793.5245606787485,\n \"IcmsSTAliquot\": 7160.882724488011,\n \"IcmsStBaseCalMethod\": 2,\n \"IcmsStDifalBaseCalMethod\": 3,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 3077.4328037453547,\n \"FecpPDif\": 48.857055506432715,\n \"CfopOutbound\": 9419,\n \"CfopInbound\": 9661,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 1183,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"41\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 0,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 8140.482813876512,\n \"IcmsPRedBC\": 8635.8998998843,\n \"IcmsDifalPRedBC\": 3131.0101784689937,\n \"FecpAliquot\": 4931.55808957106,\n \"IcmsModBCST\": 5,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 9034.837901246436,\n \"IcmsPMVASTSimples\": 6652.119175907917,\n \"IcmsPMVASTMadeOutBrazil\": 7313.900342645145,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 9734.97582120075,\n \"IcmsPRedBCST\": 3498.50377953274,\n \"IcmsSTAliquot\": 4032.3675342626484,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 726.6667197224685,\n \"FecpPDif\": 5321.8833063125985,\n \"CfopOutbound\": 2456,\n \"CfopInbound\": 7906,\n \"ItemCommentsInvoice\": \"string\"\n }\n ]\n },\n {\n \"IDCompany\": 5375,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyAddressStateInvoice\": \"st\",\n \"IDTax\": 4993,\n \"IDTaxDepartment\": 8430,\n \"TypeTaxName\": \"string\",\n \"Standard\": 0,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 1,\n \"ReverseTaxCalculation\": 1,\n \"IssueNFCe\": 1,\n \"IIAliquot\": 7734.864565132125,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 7928.231766409861,\n \"NfCstPisDescription\": \"string\",\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 3233.309744431161,\n \"NfCstCofinsDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 7510.292218228016,\n \"NfCstPisInboundDescription\": \"string\",\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 3459.2486062411053,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 211.37324617733987,\n \"NfCstIpiDescription\": \"string\",\n \"IpiCEnq\": \"str\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 5753.832130605494,\n \"NfCstIpiInboundDescription\": \"string\",\n \"IDNfCstIbsCbs\": 1090,\n \"NfCstIbsCbsDescription\": \"string\",\n \"CfopOutboundInState\": 9195,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 3367,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 8520,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 8214,\n \"CfopInboundOutStateDescription\": \"string\",\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"Icms\": [\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 6905,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"51\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 3,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 4019.091316053789,\n \"IcmsPRedBC\": 4159.3069828485295,\n \"IcmsDifalPRedBC\": 5153.598069496603,\n \"FecpAliquot\": 7602.424453815839,\n \"IcmsModBCST\": 1,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 812.7086834612785,\n \"IcmsPMVASTSimples\": 445.5573441183525,\n \"IcmsPMVASTMadeOutBrazil\": 1942.1965685384769,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 773.2075087829804,\n \"IcmsPRedBCST\": 3699.862724086491,\n \"IcmsSTAliquot\": 6681.17459653357,\n \"IcmsStBaseCalMethod\": 2,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 3468.809742820558,\n \"FecpPDif\": 1843.6620351912713,\n \"CfopOutbound\": 4389,\n \"CfopInbound\": 8217,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 9758,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"00\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 0,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 7994.4875105284145,\n \"IcmsPRedBC\": 7386.93599365537,\n \"IcmsDifalPRedBC\": 7573.4391671719695,\n \"FecpAliquot\": 401.84073569218714,\n \"IcmsModBCST\": 5,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 6628.904981820893,\n \"IcmsPMVASTSimples\": 6764.436131872709,\n \"IcmsPMVASTMadeOutBrazil\": 7449.334771447309,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 2627.7737669754474,\n \"IcmsPRedBCST\": 4936.1045189025135,\n \"IcmsSTAliquot\": 9716.73164350109,\n \"IcmsStBaseCalMethod\": 2,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 1,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 3700.3851077708027,\n \"FecpPDif\": 17.465660661519777,\n \"CfopOutbound\": 3901,\n \"CfopInbound\": 5527,\n \"ItemCommentsInvoice\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d0debec-ecc2-4e0c-acc9-96e6d3d65e25", "name": "Falha ao consultar a regra fiscal. Mensagem (prefixo `[BadRequest]`): `erro genérico`.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "822f6449-000b-4e1e-99ab-a5075b370a7b", "name": "Atualiza uma regra fiscal (CFOP)", "request": { "name": "Atualiza uma regra fiscal (CFOP)", "description": { "content": "Atualiza os campos federais da regra fiscal. A atualização é parcial para a maioria dos campos — os não enviados ficam inalterados — com seis exceções que são sempre regravadas: os quatro CFOPs por direção e `TaxSkuCest` são limpos quando omitidos ou enviados vazios, e `IpiCEnq` omitido ou vazio é gravado como `999`. Strings vazias em `PisCstInbound` / `CofinsCstInbound` removem o CST de entrada.\n\n`PisCst` e `CofinsCst` continuam obrigatórios: a chamada é recusada quando qualquer um deles vem vazio.\n\nAplica as mesmas validações do `POST` (limite de 50% em PIS/COFINS, primeiro dígito e existência do CFOP no cadastro, faixas do enquadramento de IPI, classificação IBS/CBS existente).\n\nQuando `Standard=1` e a chamada informa consumidor final `NfeindFinal` e contribuinte `NfeTaxPayer`, o sistema procura outra regra padrão do mesmo departamento com a mesma combinação de filial emissora `IDCompanyBranch`, `NfeindFinal`, `NfeTaxPayer`, emissão de NFCe `IssueNFCe` e bonificação `Gratification`. Se essa outra regra cobrir algum estado destino também configurado nas regras ICMS desta regra fiscal, a alteração é bloqueada — é o que impede duplicidade de regra principal por estado.\n\nRetorna o detalhe atualizado (mesmo shape do `GET`).", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PisCst\": \"st\",\n \"CofinsCst\": \"st\",\n \"IDCompanyBranch\": 9150,\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 1,\n \"Gratification\": 1,\n \"NfeExport\": 1,\n \"ReverseTaxCalculation\": 0,\n \"IssueNFCe\": 0,\n \"PisAliquot\": 8659.55851917184,\n \"CofinsAliquot\": 1588.5871030927756,\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 2210.496309567522,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 6286.202666486402,\n \"IpiCst\": \"02\",\n \"IpiAliquot\": 1143.717550406751,\n \"IpiCEnq\": \"str\",\n \"IpiCstInbound\": \"01\",\n \"IpiAliquotInbound\": 9337.286558614129,\n \"IDNfCstIbsCbs\": 3940,\n \"CfopOutboundInState\": 5532,\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 604,\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 4311,\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 1946,\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"IIAliquot\": 5802.550490704104,\n \"TaxSkuCest\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1aeabdb1-b4cb-4b4a-af94-3a93d9c4f17f", "name": "Regra fiscal atualizada. Retorna o detalhe completo.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"PisCst\": \"st\",\n \"CofinsCst\": \"st\",\n \"IDCompanyBranch\": 9150,\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 1,\n \"Gratification\": 1,\n \"NfeExport\": 1,\n \"ReverseTaxCalculation\": 0,\n \"IssueNFCe\": 0,\n \"PisAliquot\": 8659.55851917184,\n \"CofinsAliquot\": 1588.5871030927756,\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 2210.496309567522,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 6286.202666486402,\n \"IpiCst\": \"02\",\n \"IpiAliquot\": 1143.717550406751,\n \"IpiCEnq\": \"str\",\n \"IpiCstInbound\": \"01\",\n \"IpiAliquotInbound\": 9337.286558614129,\n \"IDNfCstIbsCbs\": 3940,\n \"CfopOutboundInState\": 5532,\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 604,\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 4311,\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 1946,\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"IIAliquot\": 5802.550490704104,\n \"TaxSkuCest\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 8638,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyAddressStateInvoice\": \"st\",\n \"IDTax\": 5161,\n \"IDTaxDepartment\": 282,\n \"TypeTaxName\": \"string\",\n \"Standard\": 0,\n \"Gratification\": 0,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 0,\n \"ReverseTaxCalculation\": 0,\n \"IssueNFCe\": 1,\n \"IIAliquot\": 1017.6051298025191,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 4835.739069777683,\n \"NfCstPisDescription\": \"string\",\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 408.9869616985298,\n \"NfCstCofinsDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 3781.0561536992427,\n \"NfCstPisInboundDescription\": \"string\",\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 8824.37638318489,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 9679.201522825138,\n \"NfCstIpiDescription\": \"string\",\n \"IpiCEnq\": \"str\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 3583.023253005844,\n \"NfCstIpiInboundDescription\": \"string\",\n \"IDNfCstIbsCbs\": 1561,\n \"NfCstIbsCbsDescription\": \"string\",\n \"CfopOutboundInState\": 1460,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 5076,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 7810,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 2170,\n \"CfopInboundOutStateDescription\": \"string\",\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"Icms\": [\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 3872,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"300\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 2,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 5578.646322020375,\n \"IcmsPRedBC\": 6548.003844743149,\n \"IcmsDifalPRedBC\": 6729.228319357921,\n \"FecpAliquot\": 1267.0153908213267,\n \"IcmsModBCST\": 4,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 3057.3854029188064,\n \"IcmsPMVASTSimples\": 9827.409430182357,\n \"IcmsPMVASTMadeOutBrazil\": 7828.6145473123715,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 7832.300857092165,\n \"IcmsPRedBCST\": 2793.5245606787485,\n \"IcmsSTAliquot\": 7160.882724488011,\n \"IcmsStBaseCalMethod\": 2,\n \"IcmsStDifalBaseCalMethod\": 3,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 3077.4328037453547,\n \"FecpPDif\": 48.857055506432715,\n \"CfopOutbound\": 9419,\n \"CfopInbound\": 9661,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 1183,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"41\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 0,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 8140.482813876512,\n \"IcmsPRedBC\": 8635.8998998843,\n \"IcmsDifalPRedBC\": 3131.0101784689937,\n \"FecpAliquot\": 4931.55808957106,\n \"IcmsModBCST\": 5,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 9034.837901246436,\n \"IcmsPMVASTSimples\": 6652.119175907917,\n \"IcmsPMVASTMadeOutBrazil\": 7313.900342645145,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 9734.97582120075,\n \"IcmsPRedBCST\": 3498.50377953274,\n \"IcmsSTAliquot\": 4032.3675342626484,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 726.6667197224685,\n \"FecpPDif\": 5321.8833063125985,\n \"CfopOutbound\": 2456,\n \"CfopInbound\": 7906,\n \"ItemCommentsInvoice\": \"string\"\n }\n ]\n },\n {\n \"IDCompany\": 5375,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyAddressStateInvoice\": \"st\",\n \"IDTax\": 4993,\n \"IDTaxDepartment\": 8430,\n \"TypeTaxName\": \"string\",\n \"Standard\": 0,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 1,\n \"ReverseTaxCalculation\": 1,\n \"IssueNFCe\": 1,\n \"IIAliquot\": 7734.864565132125,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 7928.231766409861,\n \"NfCstPisDescription\": \"string\",\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 3233.309744431161,\n \"NfCstCofinsDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 7510.292218228016,\n \"NfCstPisInboundDescription\": \"string\",\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 3459.2486062411053,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 211.37324617733987,\n \"NfCstIpiDescription\": \"string\",\n \"IpiCEnq\": \"str\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 5753.832130605494,\n \"NfCstIpiInboundDescription\": \"string\",\n \"IDNfCstIbsCbs\": 1090,\n \"NfCstIbsCbsDescription\": \"string\",\n \"CfopOutboundInState\": 9195,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 3367,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 8520,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 8214,\n \"CfopInboundOutStateDescription\": \"string\",\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"Icms\": [\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 6905,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"51\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 3,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 4019.091316053789,\n \"IcmsPRedBC\": 4159.3069828485295,\n \"IcmsDifalPRedBC\": 5153.598069496603,\n \"FecpAliquot\": 7602.424453815839,\n \"IcmsModBCST\": 1,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 812.7086834612785,\n \"IcmsPMVASTSimples\": 445.5573441183525,\n \"IcmsPMVASTMadeOutBrazil\": 1942.1965685384769,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 773.2075087829804,\n \"IcmsPRedBCST\": 3699.862724086491,\n \"IcmsSTAliquot\": 6681.17459653357,\n \"IcmsStBaseCalMethod\": 2,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 0,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 3468.809742820558,\n \"FecpPDif\": 1843.6620351912713,\n \"CfopOutbound\": 4389,\n \"CfopInbound\": 8217,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 9758,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"00\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 0,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 7994.4875105284145,\n \"IcmsPRedBC\": 7386.93599365537,\n \"IcmsDifalPRedBC\": 7573.4391671719695,\n \"FecpAliquot\": 401.84073569218714,\n \"IcmsModBCST\": 5,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 6628.904981820893,\n \"IcmsPMVASTSimples\": 6764.436131872709,\n \"IcmsPMVASTMadeOutBrazil\": 7449.334771447309,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 2627.7737669754474,\n \"IcmsPRedBCST\": 4936.1045189025135,\n \"IcmsSTAliquot\": 9716.73164350109,\n \"IcmsStBaseCalMethod\": 2,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 1,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 3700.3851077708027,\n \"FecpPDif\": 17.465660661519777,\n \"CfopOutbound\": 3901,\n \"CfopInbound\": 5527,\n \"ItemCommentsInvoice\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0b60163-1d7f-487d-8e3a-81d7ee40fa25", "name": "Validação ou conflito. Mensagens (prefixo `[BadRequest]`): `Alíquota de PIS não pode ser maior que 50%`; `Alíquota de COFINS não pode ser maior que 50%`; `Precisa informa o CST PIS` e `Precisa informa o CST COFINS` — emitidas também na atualização, quando `PisCst` ou `CofinsCst` vem vazio; `CFOP de saída dentro do estado não inicia com 5`; `CFOP de saída fora do estado não inicia com 6`; `CFOP de entrada dentro do estado não inicia com 1`; `CFOP de entrada fora do estado não inicia com 2`; `CFOP de não existe`; `IPI CST 02 e 52 deve ter o enquadramento entre 300 e 399`; `IPI CST 04 e 54 deve ter o enquadramento entre 0 e 99`; `IPI CST 05 e 55 deve ter o enquadramento entre 100 e 199`; `Classificação IBS/CBS não encontrada`; `Departamento fiscal não existe`; `O estado já tem regra configurada em outro departamento PRINCIPAL: e não pode duplicar.`", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"PisCst\": \"st\",\n \"CofinsCst\": \"st\",\n \"IDCompanyBranch\": 9150,\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"NfeindFinal\": 1,\n \"NfeTaxPayer\": 1,\n \"Gratification\": 1,\n \"NfeExport\": 1,\n \"ReverseTaxCalculation\": 0,\n \"IssueNFCe\": 0,\n \"PisAliquot\": 8659.55851917184,\n \"CofinsAliquot\": 1588.5871030927756,\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 2210.496309567522,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 6286.202666486402,\n \"IpiCst\": \"02\",\n \"IpiAliquot\": 1143.717550406751,\n \"IpiCEnq\": \"str\",\n \"IpiCstInbound\": \"01\",\n \"IpiAliquotInbound\": 9337.286558614129,\n \"IDNfCstIbsCbs\": 3940,\n \"CfopOutboundInState\": 5532,\n \"CfopOutboundInStateNfeNatureOperation\": \"string\",\n \"CfopOutboundOutState\": 604,\n \"CfopOutboundOutStateNfeNatureOperation\": \"string\",\n \"CfopInboundInState\": 4311,\n \"CfopInboundInStateNfeNatureOperation\": \"string\",\n \"CfopInboundOutState\": 1946,\n \"CfopInboundOutStateNfeNatureOperation\": \"string\",\n \"IIAliquot\": 5802.550490704104,\n \"TaxSkuCest\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f5cf7ca-7d3f-4ac7-a4fa-23d5231fa313", "name": "Remove uma regra fiscal (CFOP)", "request": { "name": "Remove uma regra fiscal (CFOP)", "description": { "content": "Remove a regra fiscal do departamento. A exclusão é bloqueada quando a regra está atrelada à regra fiscal de algum Tipo de Pedido.\n\nRetorna o detalhe do departamento pai após a exclusão (mesmo shape de `GET /tax/{idtaxdepartment}`).", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "84b13c2e-e4a9-4c4d-8604-78f762e16180", "name": "Regra fiscal removida. Retorna o detalhe atualizado do departamento.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTaxDepartment\": 4005,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 0,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 4285,\n \"IDTaxDepartment\": 4828,\n \"IDCompany\": 6992,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 6426.880391303504,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 6281.064085039905,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 9374.279370993732,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7637.696402603787,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 7329.707897047688,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8794.547587618397,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 9411,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 4739,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 5534,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 431,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 3748,\n \"IDTaxDepartment\": 3654,\n \"IDCompany\": 1524,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 6354.813923359097,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 7313.86784420428,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 311.856252353151,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7569.015699898274,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 3928.981119171957,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8233.644823978751,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 2888,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 2769,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 5429,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 7882,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n },\n {\n \"IDTaxDepartment\": 9657,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 5084,\n \"IDTaxDepartment\": 6552,\n \"IDCompany\": 6874,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 0,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 841.3972403978787,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 1077.4023351739736,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 3733.622070234455,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 2041.5873691521158,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 4681.596551602085,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 47.91466507543474,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 2961,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 6408,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 2486,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 3221,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 9988,\n \"IDTaxDepartment\": 46,\n \"IDCompany\": 4936,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 7134.884775519808,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 7820.647044477689,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 8169.0266861676955,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 4423.066618530484,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 8690.848589219053,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8231.152011173053,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 8182,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 8005,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 2093,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 4024,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45193a9a-abd3-48bc-869b-acdfd8de5891", "name": "Bloqueado por uso ou registro inexistente. Mensagens (prefixo `[BadRequest]`): `Tipo imposto não existe`; `Regra fiscal esta atrelada ao tipo de pedido e não pode ser excluída`.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP) dentro do departamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24989750-a949-4a20-b426-15c310ed51f7", "name": "Cria uma regra ICMS por estado destino", "request": { "name": "Cria uma regra ICMS por estado destino", "description": { "content": "Cria uma regra ICMS para um estado destino dentro de uma regra fiscal (CFOP). A regra define ICMS próprio, ICMS ST, FCP (Fundo de Combate à Pobreza), DIFAL e os overrides de CFOP e de comentário do item para o estado em questão.\n\nO CST ICMS controla quais campos são obrigatórios e quais são zerados:\n- `00` (Tributada integralmente): exige `IcmsModBC`, `IcmsAliquot` e `FecpAliquot`; limpa os campos de ST e de diferimento.\n- `10` (Tributada com ST): exige também `IcmsModBCST`; `IcmsSTAliquot` vazio assume o valor de `IcmsAliquot`.\n- `20` (Redução de base): exige `IcmsPRedBC` maior que zero; limpa ST e diferimento.\n- `30` (Isenta com ST): exige `IcmsModBCST` e `FecpAliquot`; limpa redução e modalidade de base.\n- `40`, `41`, `50`, `60` (isenções e ICMS recolhido por ST): zeram os demais campos de ICMS, redução, ST e DIFAL.\n- `51` (Diferimento): exige `IcmsModBC`, `IcmsAliquot` e `FecpAliquot`; limpa os campos de ST.\n- `70` (Redução com ST): exige `IcmsPRedBC` maior que zero, `IcmsModBC` e `IcmsModBCST` válidos.\n\nValidações comuns: `IcmsAliquot`, `FecpAliquot` e `IcmsDifalPRedBC` precisam ficar entre 0 e 100% (`0`–`1` em decimal). O CST informado precisa existir para o regime tributário da empresa emissora. Não pode haver outra regra para o mesmo `StateTo` dentro da mesma regra fiscal. Quando a regra fiscal é `Standard=1`, o estado destino não pode coincidir com um estado já configurado em outra regra padrão do mesmo departamento.\n\nRetorna o registro criado com as descrições resolvidas (modalidades de base de cálculo, CST e nome do estado). A resposta é mais enxuta que a do `GET`: não traz o método de cálculo do DIFAL `MethodOutsideDifal` nem a descrição `MethodOutsideDifalDescription`, e `MethodOutside` volta como texto (`Por Fora` / `Por Dentro`), não como inteiro. Para ler o registro no formato completo, consulte `GET /tax/{idtaxdepartment}/cfop/{idtax}`.", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StateTo\": \"PA\",\n \"IcmsCst\": \"203\",\n \"IcmsModBC\": 3,\n \"IcmsAliquot\": 8826.451029948716,\n \"IcmsPRedBC\": 8204.282364871595,\n \"IcmsDifalPRedBC\": 0,\n \"FecpAliquot\": 4698.269111244151,\n \"IcmsModBCST\": 1,\n \"IcmsPMVAST\": 4962.495249520333,\n \"IcmsPMVASTSimples\": 5487.951491781187,\n \"IcmsPMVASTMadeOutBrazil\": 3773.7944597974106,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 7178.437967671616,\n \"IcmsPRedBCST\": 4177.183250808152,\n \"IcmsSTAliquot\": 5287.242644950212,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDifal\": 1,\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 4608.982578693223,\n \"FecpPDif\": 4747.153501728816,\n \"CfopOutbound\": 7503,\n \"CfopInbound\": 7365,\n \"ItemCommentsInvoice\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d013171-376c-41aa-9bb6-18dac93ec05d", "name": "Regra ICMS criada. A resposta tem formato próprio, diferente do `GET` e do `PUT`: **não** traz `MethodOutsideDifal` nem `MethodOutsideDifalDescription` (esses dois só existem na resposta do `GET`); traz `ItemCommentsInvoice`, `IcmsPMVASTMadeOutBrazil`, `IcmsPMVASTSimplesMadeOutBrazil` e `MethodOutsideDescription`, que não existem na resposta do `PUT`; as descrições de modalidade vêm como `IcmsModBCDescription` e `IcmsModBCSTDescription` (no `PUT` vêm como `NfModBcDescription` e `NfModBcSTDescription`); e `MethodOutside` volta como texto (`Por Fora` / `Por Dentro`), não como inteiro.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StateTo\": \"PA\",\n \"IcmsCst\": \"203\",\n \"IcmsModBC\": 3,\n \"IcmsAliquot\": 8826.451029948716,\n \"IcmsPRedBC\": 8204.282364871595,\n \"IcmsDifalPRedBC\": 0,\n \"FecpAliquot\": 4698.269111244151,\n \"IcmsModBCST\": 1,\n \"IcmsPMVAST\": 4962.495249520333,\n \"IcmsPMVASTSimples\": 5487.951491781187,\n \"IcmsPMVASTMadeOutBrazil\": 3773.7944597974106,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 7178.437967671616,\n \"IcmsPRedBCST\": 4177.183250808152,\n \"IcmsSTAliquot\": 5287.242644950212,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDifal\": 1,\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 4608.982578693223,\n \"FecpPDif\": 4747.153501728816,\n \"CfopOutbound\": 7503,\n \"CfopInbound\": 7365,\n \"ItemCommentsInvoice\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 7534,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"51\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 1,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 7353.070985220506,\n \"IcmsPRedBC\": 6341.774263835978,\n \"IcmsDifalPRedBC\": 2792.994556423136,\n \"FecpAliquot\": 1176.581280500657,\n \"IcmsModBCST\": 2,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 2245.8427349090202,\n \"IcmsPMVASTSimples\": 3264.0628064818534,\n \"IcmsPMVASTMadeOutBrazil\": 4874.696906926388,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 9658.027536407191,\n \"IcmsPRedBCST\": 9712.646359319973,\n \"IcmsSTAliquot\": 5760.076401708198,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 2,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 1,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 7174.686936771177,\n \"FecpPDif\": 8126.472037053521,\n \"CfopOutbound\": 3868,\n \"CfopInbound\": 6327,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 7847,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"10\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 3,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 7572.212195867008,\n \"IcmsPRedBC\": 8591.749618431648,\n \"IcmsDifalPRedBC\": 4385.203433277773,\n \"FecpAliquot\": 971.739220441028,\n \"IcmsModBCST\": 5,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 3052.6280798467487,\n \"IcmsPMVASTSimples\": 6649.1483449886955,\n \"IcmsPMVASTMadeOutBrazil\": 7925.24365599468,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 4763.152017297279,\n \"IcmsPRedBCST\": 8543.512665388478,\n \"IcmsSTAliquot\": 7105.7843653369755,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 3,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 1,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 8319.269626786274,\n \"FecpPDif\": 2116.766299362838,\n \"CfopOutbound\": 9444,\n \"CfopInbound\": 9964,\n \"ItemCommentsInvoice\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b56dba2-f6de-4548-8332-e92c5a89ebff", "name": "Validação. Mensagens (prefixo `[BadRequest]`): `Precisa selecionar o Mod Base Cal ICMS válido`; `Precisa informar alíquota ICMS`; `Alíquota ICMS precisa ser entre 0 e 100%`; `Precisa informar alíquota ICMS Fundo Pobreza`; `Alíquota ICMS Fundo Pobreza precisa ser entre 0 e 100%`; `Redução BC ICMS DIFAL precisa ser entre 0 e 100%`; `Redução BC ICMS precisa ser entre 0 e 100%`; `Precisa selecionar o Mod Base Cal ICMS ST válido (0,1,2,3,4,5,6)`; `Precisa selecionar o Mod Base Cal ICMS ST válido`; `ICMS CST é inválido. Verificar regime tributário da empresa`; `Configuração já preenchida para estado: `; `Departamento fiscal não existe`; `O estado já tem regra configurada em outro departamento PRINCIPAL: e não pode duplicar.`", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StateTo\": \"PA\",\n \"IcmsCst\": \"203\",\n \"IcmsModBC\": 3,\n \"IcmsAliquot\": 8826.451029948716,\n \"IcmsPRedBC\": 8204.282364871595,\n \"IcmsDifalPRedBC\": 0,\n \"FecpAliquot\": 4698.269111244151,\n \"IcmsModBCST\": 1,\n \"IcmsPMVAST\": 4962.495249520333,\n \"IcmsPMVASTSimples\": 5487.951491781187,\n \"IcmsPMVASTMadeOutBrazil\": 3773.7944597974106,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 7178.437967671616,\n \"IcmsPRedBCST\": 4177.183250808152,\n \"IcmsSTAliquot\": 5287.242644950212,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDifal\": 1,\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 4608.982578693223,\n \"FecpPDif\": 4747.153501728816,\n \"CfopOutbound\": 7503,\n \"CfopInbound\": 7365,\n \"ItemCommentsInvoice\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "effa2f8b-86cc-4150-b898-1f09b92422ca", "name": "Atualiza uma regra ICMS por estado destino", "request": { "name": "Atualiza uma regra ICMS por estado destino", "description": { "content": "Substitui a regra ICMS do estado destino. Diferente de uma atualização parcial, todos os campos da regra são regravados a cada chamada: os omitidos voltam ao valor padrão (`IcmsModBC` `3`; `IcmsDifalPRedBC` `0`; `MethodOutside`, `MethodOutsideDifal`, `IcmsStBaseCalMethod` e `IcmsStDifalBaseCalMethod` `1`; os demais ficam vazios). As únicas exceções são `ItemCommentsInvoice`, `IcmsPMVASTMadeOutBrazil` e `IcmsPMVASTSimplesMadeOutBrazil`, que preservam o valor atual quando omitidos.\n\nValem as mesmas regras por CST, alíquotas e limites do `POST`, e o CST precisa existir para o regime tributário da empresa emissora — por isso `IcmsCst` tem que ser enviado em toda chamada. Há uma diferença em relação ao `POST`: como as MVAs de produto importado `IcmsPMVASTMadeOutBrazil` e `IcmsPMVASTSimplesMadeOutBrazil` são recuperadas do registro atual, elas não são zeradas pelos CSTs que zeram os demais campos de substituição tributária.\n\nAo trocar o `StateTo`, o sistema verifica novamente se não há duplicidade contra as outras regras da mesma regra fiscal e, quando a regra fiscal é `Standard=1`, contra as regras padrão dos demais CFOPs do departamento.\n\nRetorna o registro atualizado com as descrições resolvidas (modalidades de base de cálculo, CST e nome do estado).", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate", ":idtaxinterstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtaxinterstate", "description": "(Required) Identificador da regra ICMS por estado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StateTo\": \"DF\",\n \"IcmsCst\": \"400\",\n \"IcmsModBC\": 3,\n \"IcmsAliquot\": 2313.328776458576,\n \"IcmsPRedBC\": 8662.38312241536,\n \"IcmsDifalPRedBC\": 0,\n \"FecpAliquot\": 4926.980487423735,\n \"IcmsModBCST\": 2,\n \"IcmsPMVAST\": 9412.310099650978,\n \"IcmsPMVASTSimples\": 9261.349692030562,\n \"IcmsPMVASTMadeOutBrazil\": 3925.9708425524154,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 1170.5720354233606,\n \"IcmsPRedBCST\": 956.6530972484255,\n \"IcmsSTAliquot\": 8524.209106701606,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDifal\": 1,\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 512.3990323547645,\n \"FecpPDif\": 9339.219311468276,\n \"CfopOutbound\": 4861,\n \"CfopInbound\": 5315,\n \"ItemCommentsInvoice\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1a90cf6d-3d28-42a5-b426-b076e2284bb2", "name": "Regra ICMS atualizada. A resposta tem formato próprio, diferente do `GET` e do `POST`: **não** traz `ItemCommentsInvoice`, `IcmsPMVASTMadeOutBrazil`, `IcmsPMVASTSimplesMadeOutBrazil`, `MethodOutsideDescription`, `MethodOutsideDifal` nem `MethodOutsideDifalDescription`; as descrições de modalidade vêm como `NfModBcDescription` e `NfModBcSTDescription`; e `MethodOutside` volta como texto (`Por Fora` / `Por Dentro`), não como inteiro.\n- A resposta do `POST` da mesma sub-rota também difere da do `GET`, porém de outra forma: as três representações da regra ICMS não são intercambiáveis.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate", ":idtaxinterstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtaxinterstate", "description": "(Required) Identificador da regra ICMS por estado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StateTo\": \"DF\",\n \"IcmsCst\": \"400\",\n \"IcmsModBC\": 3,\n \"IcmsAliquot\": 2313.328776458576,\n \"IcmsPRedBC\": 8662.38312241536,\n \"IcmsDifalPRedBC\": 0,\n \"FecpAliquot\": 4926.980487423735,\n \"IcmsModBCST\": 2,\n \"IcmsPMVAST\": 9412.310099650978,\n \"IcmsPMVASTSimples\": 9261.349692030562,\n \"IcmsPMVASTMadeOutBrazil\": 3925.9708425524154,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 1170.5720354233606,\n \"IcmsPRedBCST\": 956.6530972484255,\n \"IcmsSTAliquot\": 8524.209106701606,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDifal\": 1,\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 512.3990323547645,\n \"FecpPDif\": 9339.219311468276,\n \"CfopOutbound\": 4861,\n \"CfopInbound\": 5315,\n \"ItemCommentsInvoice\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 7534,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"51\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 1,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 7353.070985220506,\n \"IcmsPRedBC\": 6341.774263835978,\n \"IcmsDifalPRedBC\": 2792.994556423136,\n \"FecpAliquot\": 1176.581280500657,\n \"IcmsModBCST\": 2,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 2245.8427349090202,\n \"IcmsPMVASTSimples\": 3264.0628064818534,\n \"IcmsPMVASTMadeOutBrazil\": 4874.696906926388,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 9658.027536407191,\n \"IcmsPRedBCST\": 9712.646359319973,\n \"IcmsSTAliquot\": 5760.076401708198,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 2,\n \"MethodOutside\": 0,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 1,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 7174.686936771177,\n \"FecpPDif\": 8126.472037053521,\n \"CfopOutbound\": 3868,\n \"CfopInbound\": 6327,\n \"ItemCommentsInvoice\": \"string\"\n },\n {\n \"IDStockKeepingUnitIcmsTaxInterstate\": 7847,\n \"StateTo\": \"st\",\n \"StateName\": \"string\",\n \"IcmsCst\": \"10\",\n \"CstDescription\": \"string\",\n \"IcmsModBC\": 3,\n \"IcmsModBCDescription\": \"string\",\n \"IcmsAliquot\": 7572.212195867008,\n \"IcmsPRedBC\": 8591.749618431648,\n \"IcmsDifalPRedBC\": 4385.203433277773,\n \"FecpAliquot\": 971.739220441028,\n \"IcmsModBCST\": 5,\n \"IcmsModBCSTDescription\": \"string\",\n \"IcmsPMVAST\": 3052.6280798467487,\n \"IcmsPMVASTSimples\": 6649.1483449886955,\n \"IcmsPMVASTMadeOutBrazil\": 7925.24365599468,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 4763.152017297279,\n \"IcmsPRedBCST\": 8543.512665388478,\n \"IcmsSTAliquot\": 7105.7843653369755,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 3,\n \"MethodOutside\": 1,\n \"MethodOutsideDescription\": \"string\",\n \"MethodOutsideDifal\": 1,\n \"MethodOutsideDifalDescription\": \"string\",\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 8319.269626786274,\n \"FecpPDif\": 2116.766299362838,\n \"CfopOutbound\": 9444,\n \"CfopInbound\": 9964,\n \"ItemCommentsInvoice\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e16cb5ab-3a1d-4021-92aa-6be605a0fe6a", "name": "Validação. Mensagens (prefixo `[BadRequest]`): `Precisa selecionar o Mod Base Cal ICMS válido`; `Precisa informar alíquota ICMS`; `Alíquota ICMS precisa ser entre 0 e 100%`; `Precisa informar alíquota ICMS Fundo Pobreza`; `Alíquota ICMS Fundo Pobreza precisa ser entre 0 e 100%`; `Redução BC ICMS DIFAL precisa ser entre 0 e 100%`; `Redução BC ICMS precisa ser entre 0 e 100%`; `Precisa selecionar o Mod Base Cal ICMS ST válido (0,1,2,3,4,5,6)`; `Precisa selecionar o Mod Base Cal ICMS ST válido`; `ICMS CST é inválido. Verificar regime tributário da empresa`; `Configuração já preenchida para estado: `; `Departamento fiscal não existe`; `O estado já tem regra configurada em outro departamento PRINCIPAL: e não pode duplicar.`", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate", ":idtaxinterstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtaxinterstate", "description": "(Required) Identificador da regra ICMS por estado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StateTo\": \"DF\",\n \"IcmsCst\": \"400\",\n \"IcmsModBC\": 3,\n \"IcmsAliquot\": 2313.328776458576,\n \"IcmsPRedBC\": 8662.38312241536,\n \"IcmsDifalPRedBC\": 0,\n \"FecpAliquot\": 4926.980487423735,\n \"IcmsModBCST\": 2,\n \"IcmsPMVAST\": 9412.310099650978,\n \"IcmsPMVASTSimples\": 9261.349692030562,\n \"IcmsPMVASTMadeOutBrazil\": 3925.9708425524154,\n \"IcmsPMVASTSimplesMadeOutBrazil\": 1170.5720354233606,\n \"IcmsPRedBCST\": 956.6530972484255,\n \"IcmsSTAliquot\": 8524.209106701606,\n \"IcmsStBaseCalMethod\": 1,\n \"IcmsStDifalBaseCalMethod\": 1,\n \"MethodOutside\": 1,\n \"MethodOutsideDifal\": 1,\n \"IcmscBenef\": \"string\",\n \"IcmsPDif\": 512.3990323547645,\n \"FecpPDif\": 9339.219311468276,\n \"CfopOutbound\": 4861,\n \"CfopInbound\": 5315,\n \"ItemCommentsInvoice\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf1b64d9-03a3-45e3-b26f-f1aaf39c2716", "name": "Remove uma regra ICMS por estado destino", "request": { "name": "Remove uma regra ICMS por estado destino", "description": { "content": "Remove a regra ICMS de um estado destino dentro de uma regra fiscal (CFOP). Retorna o detalhe do departamento pai (mesmo shape de `GET /tax/{idtaxdepartment}`).", "type": "text/plain" }, "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate", ":idtaxinterstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtaxinterstate", "description": "(Required) Identificador da regra ICMS por estado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "45558e60-bb11-4a09-840d-3197c1db87ba", "name": "Regra ICMS removida. Retorna o detalhe atualizado do departamento.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate", ":idtaxinterstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtaxinterstate", "description": "(Required) Identificador da regra ICMS por estado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTaxDepartment\": 4005,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 0,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 4285,\n \"IDTaxDepartment\": 4828,\n \"IDCompany\": 6992,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 6426.880391303504,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 6281.064085039905,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 9374.279370993732,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7637.696402603787,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 7329.707897047688,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8794.547587618397,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 9411,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 4739,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 5534,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 431,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 3748,\n \"IDTaxDepartment\": 3654,\n \"IDCompany\": 1524,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 6354.813923359097,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 7313.86784420428,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 311.856252353151,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 7569.015699898274,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 3928.981119171957,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8233.644823978751,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 2888,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 2769,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 5429,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 7882,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n },\n {\n \"IDTaxDepartment\": 9657,\n \"TaxDepartmentDescription\": \"string\",\n \"Status\": 1,\n \"AccountName\": \"string\",\n \"Cfop\": [\n {\n \"IDTax\": 5084,\n \"IDTaxDepartment\": 6552,\n \"IDCompany\": 6874,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 1,\n \"NfeindFinal\": 1,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 1,\n \"NfeExport\": 0,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 841.3972403978787,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 1077.4023351739736,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 3733.622070234455,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 2041.5873691521158,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 4681.596551602085,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 47.91466507543474,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 2961,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 6408,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 2486,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 3221,\n \"CfopInboundOutStateDescription\": \"string\"\n },\n {\n \"IDTax\": 9988,\n \"IDTaxDepartment\": 46,\n \"IDCompany\": 4936,\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"TypeTaxName\": \"string\",\n \"Standard\": 1,\n \"Gratification\": 0,\n \"NfeindFinal\": 0,\n \"NfeindFinalDescription\": \"string\",\n \"NfeTaxPayer\": 0,\n \"NfeExport\": 1,\n \"TaxSkuCest\": \"string\",\n \"PisCst\": \"st\",\n \"PisAliquot\": 7134.884775519808,\n \"CofinsCst\": \"st\",\n \"CofinsAliquot\": 7820.647044477689,\n \"NfCstCofinsDescription\": \"string\",\n \"NfCstPisDescription\": \"string\",\n \"PisCstInbound\": \"st\",\n \"PisAliquotInbound\": 8169.0266861676955,\n \"CofinsCstInbound\": \"st\",\n \"CofinsAliquotInbound\": 4423.066618530484,\n \"NfCstCofinsInboundDescription\": \"string\",\n \"NfCstPisInboundDescription\": \"string\",\n \"IpiCst\": \"st\",\n \"IpiAliquot\": 8690.848589219053,\n \"IpiCEnq\": \"str\",\n \"NfCstIpiDescription\": \"string\",\n \"NfIpiCEnqDescription\": \"string\",\n \"IpiCstInbound\": \"st\",\n \"IpiAliquotInbound\": 8231.152011173053,\n \"NfCstIpiInboundDescription\": \"string\",\n \"CfopOutboundInState\": 8182,\n \"CfopOutboundInStateDescription\": \"string\",\n \"CfopOutboundOutState\": 8005,\n \"CfopOutboundOutStateDescription\": \"string\",\n \"CfopInboundInState\": 2093,\n \"CfopInboundInStateDescription\": \"string\",\n \"CfopInboundOutState\": 4024,\n \"CfopInboundOutStateDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ae18c05-c300-4fce-b16c-ef49944adb01", "name": "Registro não localizado. Mensagem (prefixo `[BadRequest]`): `IDTaxDepartment não existe`.", "originalRequest": { "url": { "path": [ "tax", ":idtaxdepartment", "cfop", ":idtax", "interstate", ":idtaxinterstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idtaxdepartment", "description": "(Required) Identificador do departamento fiscal." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtax", "description": "(Required) Identificador da regra fiscal (CFOP)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idtaxinterstate", "description": "(Required) Identificador da regra ICMS por estado." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c65a0afb-6989-4e31-a181-441aba0b7b2b", "name": "Endereços de Estoque", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c9617c5f-b618-417b-9d04-585ee9587e66", "name": "Lista grupos de endereços", "request": { "name": "Lista grupos de endereços", "description": { "content": "Lista grupos de endereços (`StockKeepingUnitLocationGroup`) da empresa, ordenados pelo nome.", "type": "text/plain" }, "url": { "path": [ "sku", "location", "group" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitLocationGroup", "value": "2232", "description": "Filtra pelo identificador do grupo de localização do SKU." }, { "disabled": false, "key": "StockKeepingUnitLocationGroupName", "value": "string", "description": "Nome exato do grupo." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ff67287b-da20-4577-a73d-72d961459dde", "name": "Lista de grupos.", "originalRequest": { "url": { "path": [ "sku", "location", "group" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitLocationGroup", "value": "2232" }, { "key": "StockKeepingUnitLocationGroupName", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitLocationGroup\": 681,\n \"RecordTimestamp\": \"1962-10-29T16:58:48.290Z\",\n \"IDCompany\": 735,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 9454,\n \"RecordTimestamp\": \"2013-05-16T05:55:52.038Z\",\n \"IDCompany\": 6705,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3788e3f-54df-465c-b682-c207e916f20c", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "group" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitLocationGroup", "value": "2232" }, { "key": "StockKeepingUnitLocationGroupName", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef535efc-9b8c-422d-9c34-5d0a2d2d5ffb", "name": "Cria um grupo de endereços", "request": { "name": "Cria um grupo de endereços", "description": { "content": "Cria um grupo de endereços para a empresa autenticada. Nome precisa ser **único** dentro da empresa.", "type": "text/plain" }, "url": { "path": [ "sku", "location", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d7db178-7406-4cb0-9363-67257556cc28", "name": "Grupo criado (retorna o detalhe via list).", "originalRequest": { "url": { "path": [ "sku", "location", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitLocationGroup\": 2620,\n \"RecordTimestamp\": \"2003-02-08T18:25:36.902Z\",\n \"IDCompany\": 5186,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e925b35-3861-40ed-9e1b-fff8be758c71", "name": "`[BadRequest] - Empresa não existe`; `[BadRequest] - Grupo já existente`; `[BadRequest] - Erro ao inserir a grupo`.", "originalRequest": { "url": { "path": [ "sku", "location", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2521e39f-9c71-4f59-963d-892b0b863efc", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3be574f1-a29c-44ef-8558-5de444f26a56", "name": "Atualiza um grupo de endereços", "request": { "name": "Atualiza um grupo de endereços", "description": { "content": "Atualiza o nome do grupo. Valida unicidade do nome dentro da empresa (excluindo o próprio registro).", "type": "text/plain" }, "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e131d2b1-b47e-4031-bcfb-a70da21a96fe", "name": "Grupo atualizado.", "originalRequest": { "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitLocationGroup\": 2620,\n \"RecordTimestamp\": \"2003-02-08T18:25:36.902Z\",\n \"IDCompany\": 5186,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6a9be40-f1ec-4f0c-a5d7-8ecf79dc147f", "name": "`[BadRequest] - Preencha corretamente o nome do grupo`; `[BadRequest] - Grupo não encontrada`; `[BadRequest] - Grupo já existente`; `[BadRequest] - Grupo não atualizado`.", "originalRequest": { "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70d07f00-2fda-4821-aafe-5416c60fa1e2", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7185715-8be9-4a1d-9d4b-0a5d85ba5138", "name": "Exclui um grupo de endereços", "request": { "name": "Exclui um grupo de endereços", "description": { "content": "**Exclusão física** do grupo de endereços. Bloqueada quando existe pelo menos um endereço (`StockKeepingUnitLocation`) vinculado ao grupo — neste caso devolve `200` com mensagem texto `Grupo esta vinculado a endereço. Editar endereço antes de excluir o grupo` (sem prefixo `[BadRequest]`).", "type": "text/plain" }, "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "1fc99d8f-5e29-4660-aeb4-f65128807d4c", "name": "Grupo excluído (string literal `\"sucesso\"`) ou mensagem de bloqueio.", "originalRequest": { "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d910f12-23a8-4b60-84f9-6a603677b394", "name": "`[BadRequest] - Grupo não existe`.", "originalRequest": { "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff2f96e-3006-4497-ad51-d17e1cd6572e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "group", ":idstockkeepingunitlocationgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationgroup", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c7e74a7-2d76-4572-a07b-c6cb061d5633", "name": "Lista categorias de endereço", "request": { "name": "Lista categorias de endereço", "description": { "content": "Lista categorias **Ativas** (`IsActive=1`) da empresa, ordenadas pelo nome.", "type": "text/plain" }, "url": { "path": [ "sku", "location", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitLocationCategory", "value": "2232", "description": "Filtra pelo identificador da categoria de localização do SKU." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "932d158a-b40e-49b4-8820-6d8945f8d21e", "name": "Lista de categorias.", "originalRequest": { "url": { "path": [ "sku", "location", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitLocationCategory", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 1287,\n \"IDCompany\": 9787,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IsActive\": 0,\n \"RecordTimestamp\": \"1974-10-04T00:02:47.196Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 678,\n \"IDCompany\": 400,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IsActive\": 0,\n \"RecordTimestamp\": \"1979-11-04T20:47:31.050Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1292633a-2dce-4daa-92e0-d66e26e51b28", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitLocationCategory", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f830f1ed-0c01-41b5-9eb4-7ba48c5972fb", "name": "Cria categoria de endereço", "request": { "name": "Cria categoria de endereço", "description": { "content": "Cria uma categoria. Nome único por empresa.", "type": "text/plain" }, "url": { "path": [ "sku", "location", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7b8550db-a315-4be0-b3ce-20c871fabfce", "name": "Categoria criada.", "originalRequest": { "url": { "path": [ "sku", "location", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 6122,\n \"IDCompany\": 9926,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IsActive\": 0,\n \"RecordTimestamp\": \"1984-11-01T04:51:48.461Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ab2deb6-d64b-40c4-8d45-d8b35387d320", "name": "`[BadRequest] - Categoria já existente`; `[BadRequest] - Empresa não existe`; `[BadRequest] - Erro ao inserir a categoria`.", "originalRequest": { "url": { "path": [ "sku", "location", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22238e20-da92-44ae-b81c-6dfa98df5624", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3966e231-3319-4bbb-b7e1-b9f855aabad9", "name": "Atualiza categoria de endereço", "request": { "name": "Atualiza categoria de endereço", "description": { "content": "Atualização parcial. Valida unicidade do nome.", "type": "text/plain" }, "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationcategory", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "57f86217-ff4a-4003-95e4-9b5acde3fe66", "name": "Categoria atualizada.", "originalRequest": { "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationcategory", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 6122,\n \"IDCompany\": 9926,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IsActive\": 0,\n \"RecordTimestamp\": \"1984-11-01T04:51:48.461Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c28e281b-f1b7-49a4-9e04-f6f48a336a8a", "name": "`[BadRequest] - Categoria não existe`; `[BadRequest] - Categoria já existente`.", "originalRequest": { "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationcategory", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8089dd-a0c1-4e7d-896a-19deb098a49d", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocationcategory", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb9e515b-ea86-43b3-84c2-f97204461459", "name": "Inativa categoria de endereço", "request": { "name": "Inativa categoria de endereço", "description": { "content": "Inativa a categoria de endereço de estoque. O registro não é apagado: ele sai da lista e o nome fica liberado para ser reutilizado em uma nova categoria. Bloqueada enquanto houver endereço de estoque ou SKU vinculado à categoria — reaponte esses cadastros antes.", "type": "text/plain" }, "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idstockkeepingunitlocationcategory", "description": "(Required) Identificador da categoria de endereço de estoque a inativar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "9157d778-6385-40f1-82eb-0358faa389f7", "name": "Categoria inativada (string `sucesso`).", "originalRequest": { "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idstockkeepingunitlocationcategory", "description": "(Required) Identificador da categoria de endereço de estoque a inativar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91a3b26e-6399-46a9-9a62-0b78db413acd", "name": "`[BadRequest] - Categoria não existe`; `[BadRequest] - Categoria está vinculado a endereço. Editar endereço antes de excluir a categoria`; `[BadRequest] - Categoria está vinculado a SKU. Editar SKU antes de excluir a categoria`; `[BadRequest] - Erro ao apagar a categoria`.", "originalRequest": { "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idstockkeepingunitlocationcategory", "description": "(Required) Identificador da categoria de endereço de estoque a inativar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95f91f44-b29d-4e35-a14b-116acbe657fd", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", "category", ":idstockkeepingunitlocationcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idstockkeepingunitlocationcategory", "description": "(Required) Identificador da categoria de endereço de estoque a inativar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "389be0ca-a723-4fff-89b4-a35a248a9334", "name": "Lista endereços do armazém", "request": { "name": "Lista endereços do armazém", "description": { "content": "Lista endereços (`StockKeepingUnitLocation`) da empresa. **Dois modos de listagem** controlados pelo query param `OnlyLocation`:\n\n- `OnlyLocation=1` (modo padrão da tela): traz **somente** o cadastro do endereço (sem expandir lotes/SKUs). Inclui dimensões, tipo, categoria, grupo, armazém e centro de distribuição. Filtra por `Status` do endereço (quando informado) e respeita restrição de Centros de Distribuição do usuário (`UserCompanyDistributionCenter::`).\n- `OnlyLocation` ausente (modo legado): devolve uma linha por **lote** vinculado ao endereço, com saldo em estoque (`QtyAddress`). Útil para visualizar o que tem em cada endereço. Sempre considera apenas endereços com `Status = 1`.\n\nSuporta filtro `Empty` (`QtyAddress = 0` ou `<> 0`) só no modo legado. Paginação por `Page * 5000`.\n\nQuando a empresa tem parametrização `ShareSkuLocationWithRelatedCompanies = 1` em uma integração tipo `16`, a listagem inclui também os endereços da empresa-mãe (`IDCompanyMain`).", "type": "text/plain" }, "url": { "path": [ "sku", "location" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "OnlyLocation", "value": "1", "description": "`1` = só cadastro de endereço; ausente = endereço × lote (com saldo)." }, { "disabled": false, "key": "IDStockKeepingUnitLocation", "value": "2232", "description": "Filtra pelo identificador da localização do SKU." }, { "disabled": false, "key": "IDStockKeepingUnitWarehouse", "value": "2232", "description": "Filtra pelo identificador do depósito do SKU." }, { "disabled": false, "key": "IDStockKeepingUnitDistributionCenter", "value": "string", "description": "Lista CSV de centros de distribuição. Sistema valida contra a lista permitida ao usuário." }, { "disabled": false, "key": "IDStockKeepingUnitLocationGroup", "value": "2232", "description": "Filtra pelo identificador do grupo de localização do SKU." }, { "disabled": false, "key": "IDStockKeepingUnitLocationCategory", "value": "2232", "description": "Filtra pelo identificador da categoria de localização do SKU." }, { "disabled": false, "key": "IDTypeAddress", "value": "3", "description": "1=Picking, 2=Pulmão, 3=Blocado." }, { "disabled": false, "key": "Address", "value": "string", "description": "Busca parcial (`LIKE`) pelo nome do endereço." }, { "disabled": false, "key": "Floor", "value": "string", "description": "Filtra pelo andar do endereço." }, { "disabled": false, "key": "Street", "value": "string", "description": "Filtra pelo nome da rua do endereço (busca parcial)." }, { "disabled": false, "key": "Module", "value": "string", "description": "Nome do módulo do sistema (semântica específica do endpoint)." }, { "disabled": false, "key": "Column", "value": "string", "description": "Nome da coluna usada na operação (semântica específica do endpoint)." }, { "disabled": false, "key": "Level", "value": "string", "description": "Filtra pelo nível." }, { "disabled": false, "key": "IDSku", "value": "2232", "description": "Filtro só no modo legado (com lote)." }, { "disabled": false, "key": "IDSkuCompany", "value": "string", "description": "Busca parcial pelo código de referência do SKU (modo legado)." }, { "disabled": false, "key": "SkuName", "value": "string", "description": "Filtra pelo nome do produto (busca parcial)." }, { "disabled": false, "key": "BarCode", "value": "string", "description": "Filtra pelo código de barras do produto." }, { "disabled": false, "key": "Status", "value": "1", "description": "Aplicado só com `OnlyLocation=1`." }, { "disabled": false, "key": "Empty", "value": "1", "description": "Modo legado: `0`=só endereços vazios, `1`=só endereços com saldo." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Número da página da listagem (1-based). Padrão `1`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "baeb9129-2398-4f1a-a00f-d728fe5a49d7", "name": "Lista (até 5000). Modo `OnlyLocation=1` devolve `SkuLocationListItem`; modo legado devolve `SkuLocationBatchItem`.", "originalRequest": { "url": { "path": [ "sku", "location" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OnlyLocation", "value": "1" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" }, { "key": "IDStockKeepingUnitLocationGroup", "value": "2232" }, { "key": "IDStockKeepingUnitLocationCategory", "value": "2232" }, { "key": "IDTypeAddress", "value": "3" }, { "key": "Address", "value": "string" }, { "key": "Floor", "value": "string" }, { "key": "Street", "value": "string" }, { "key": "Module", "value": "string" }, { "key": "Column", "value": "string" }, { "key": "Level", "value": "string" }, { "key": "IDSku", "value": "2232" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "Status", "value": "1" }, { "key": "Empty", "value": "1" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocation\": 3126,\n \"Address\": \"string\",\n \"Status\": 1,\n \"IDStockKeepingUnitWarehouse\": 317,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 7372,\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"AddressPriority\": 7202,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 9211.693270696684,\n \"Width\": 7172.297167751019,\n \"Length\": 9746.444043259846,\n \"MaxWeight\": 1390.3480350199038,\n \"IDTypeAddress\": 2,\n \"TypeAddress\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 8162,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 2298,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"StockKeepingUnitLocationIndex\": 6985\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocation\": 2630,\n \"Address\": \"string\",\n \"Status\": 1,\n \"IDStockKeepingUnitWarehouse\": 3185,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 8322,\n \"DistributionCenterName\": \"string\",\n \"Default\": 0,\n \"AddressPriority\": 3128,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 3134.9889699464507,\n \"Width\": 7788.102535153409,\n \"Length\": 6274.910918110903,\n \"MaxWeight\": 4717.236726966327,\n \"IDTypeAddress\": 1,\n \"TypeAddress\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 1529,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 3318,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"LocationSide\": 1,\n \"AllowRessuply\": 1,\n \"StockKeepingUnitLocationIndex\": 7592\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aebe1ed-9c64-4e5b-ac6d-b8cd0bded2d9", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "OnlyLocation", "value": "1" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" }, { "key": "IDStockKeepingUnitLocationGroup", "value": "2232" }, { "key": "IDStockKeepingUnitLocationCategory", "value": "2232" }, { "key": "IDTypeAddress", "value": "3" }, { "key": "Address", "value": "string" }, { "key": "Floor", "value": "string" }, { "key": "Street", "value": "string" }, { "key": "Module", "value": "string" }, { "key": "Column", "value": "string" }, { "key": "Level", "value": "string" }, { "key": "IDSku", "value": "2232" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "Status", "value": "1" }, { "key": "Empty", "value": "1" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13b008de-ce38-4771-8432-1e4f255ca446", "name": "Cria um ou mais endereços", "request": { "name": "Cria um ou mais endereços", "description": { "content": "Cadastra um ou mais endereços de estoque. O comportamento depende da parametrização de endereçamento da empresa (`NewAddressParameter`).\n\n**Modo WMS** (`NewAddressParameter = 1`) — exige armazém, tipo de endereço, categoria de armazenamento e as quatro dimensões (`Height`, `Width`, `Length`, `MaxWeight`, todas maiores que zero). No cadastro individual, o endereço é montado juntando `Floor`, `Street`, `Module`, `Column` e `Level` com o separador de `Concatenator` (padrão `-`); módulo e nível precisam ser numéricos e a coluna pode ser alfanumérica (letras viram maiúsculas), e o endereço é sempre gravado como não padrão, qualquer que seja o valor enviado em `Default`. Com `BulkLocation = 1` o cadastro é em massa: o sistema gera todas as combinações das faixas `StartModule`/`EndModule`, `StartColumn`/`EndColumn` e `StartLevel`/`EndLevel` — nesse modo `Module`, `Column` e `Level` são ignorados, e o valor enviado em `Default` é aplicado a todos os endereços gerados, sem desmarcar o padrão anterior do armazém. Em ambos os casos a chamada falha se algum endereço gerado já existir e estiver ativo no mesmo centro de distribuição.\n\n**Modo legado** (`NewAddressParameter = 0`) — exige apenas `Address`, um texto livre. Só `Address`, `IDStockKeepingUnitWarehouse`, `AddressPriority` e `Default` são gravados; os demais campos do corpo são ignorados. O armazém é opcional; quando informado, precisa estar ativo e pertencer à empresa e a duplicidade é conferida entre os endereços do centro de distribuição dele — sem armazém, a conferência é feita entre os endereços ativos da empresa. Com `Default = 1` e armazém informado, os demais endereços daquele armazém deixam de ser padrão.", "type": "text/plain" }, "url": { "path": [ "sku", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 3732,\n \"Default\": 0,\n \"AddressPriority\": 3317,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 8943.989779985379,\n \"Width\": 5054.003850523123,\n \"Length\": 7123.574484385144,\n \"MaxWeight\": 5378.025107464837,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6005,\n \"IDStockKeepingUnitLocationGroup\": 2958,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 0,\n \"BulkLocation\": 1,\n \"StartModule\": \"string\",\n \"EndModule\": \"string\",\n \"StartColumn\": \"string\",\n \"EndColumn\": \"string\",\n \"StartLevel\": \"string\",\n \"EndLevel\": \"string\",\n \"Concatenator\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b3ed07ca-0042-4485-b497-c2a7821dd796", "name": "Endereço criado (array com 1 item no modo individual) ou string de sucesso (modo em massa).", "originalRequest": { "url": { "path": [ "sku", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 3732,\n \"Default\": 0,\n \"AddressPriority\": 3317,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 8943.989779985379,\n \"Width\": 5054.003850523123,\n \"Length\": 7123.574484385144,\n \"MaxWeight\": 5378.025107464837,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6005,\n \"IDStockKeepingUnitLocationGroup\": 2958,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 0,\n \"BulkLocation\": 1,\n \"StartModule\": \"string\",\n \"EndModule\": \"string\",\n \"StartColumn\": \"string\",\n \"EndColumn\": \"string\",\n \"StartLevel\": \"string\",\n \"EndLevel\": \"string\",\n \"Concatenator\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocation\": 5633,\n \"Address\": \"string\",\n \"Status\": 0,\n \"IDStockKeepingUnitWarehouse\": 9801,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 3560,\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"AddressPriority\": 5127,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 1780.267359637917,\n \"Width\": 4962.479016217869,\n \"Length\": 4106.680511647669,\n \"MaxWeight\": 7007.480992466166,\n \"IDTypeAddress\": 1,\n \"TypeAddress\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 7178,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 3294,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"LocationSide\": 2,\n \"AllowRessuply\": 0,\n \"StockKeepingUnitLocationIndex\": 5782\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9305b6a-8e95-4ec1-9adc-c29136e6c796", "name": "Validações WMS: `[BadRequest] - As dimensões do endereço não podem ser negativas ou vazias`; `[BadRequest] - As faixas de módulo, coluna e nível iniciais não podem ser nulas, maiores que as finais e módulo e nível possuir letras`; `[BadRequest] - Preencha corretamente o armazém, tipo e categoria de armazenamento`; `[BadRequest] - Armazém não foi encontrado`; `[BadRequest] - Categoria de armazenamento não encontrada`; `[BadRequest] - Grupo endereço não encontrado`; `[BadRequest] - Tipo de endereço não encontrado`; `[BadRequest] - Preencha todos os campos do endereço (Andar, Rua, Modulo, Coluna e Nivel)`; `[BadRequest] - Preencha módulo e nível com números`; `[BadRequest] - Já existe este endereço para o mesmo centro de distribuição`; `[BadRequest] - Endereços repetidos, consulte seus endereços`; `[BadRequest] - Erro ao gerar endereços em massa`; `[BadRequest] - Erro ao inserir endereços`. Validações legado: `[BadRequest] - Endereço precisa ser informado`; `[BadRequest] - Armazém não localizado`; `[BadRequest] - Já existe este endereço para o centro de distribuição`. Gerais: `[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "sku", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 3732,\n \"Default\": 0,\n \"AddressPriority\": 3317,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 8943.989779985379,\n \"Width\": 5054.003850523123,\n \"Length\": 7123.574484385144,\n \"MaxWeight\": 5378.025107464837,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6005,\n \"IDStockKeepingUnitLocationGroup\": 2958,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 0,\n \"BulkLocation\": 1,\n \"StartModule\": \"string\",\n \"EndModule\": \"string\",\n \"StartColumn\": \"string\",\n \"EndColumn\": \"string\",\n \"StartLevel\": \"string\",\n \"EndLevel\": \"string\",\n \"Concatenator\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efec0fea-1916-4135-902e-d337c2291277", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 3732,\n \"Default\": 0,\n \"AddressPriority\": 3317,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 8943.989779985379,\n \"Width\": 5054.003850523123,\n \"Length\": 7123.574484385144,\n \"MaxWeight\": 5378.025107464837,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6005,\n \"IDStockKeepingUnitLocationGroup\": 2958,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 0,\n \"BulkLocation\": 1,\n \"StartModule\": \"string\",\n \"EndModule\": \"string\",\n \"StartColumn\": \"string\",\n \"EndColumn\": \"string\",\n \"StartLevel\": \"string\",\n \"EndLevel\": \"string\",\n \"Concatenator\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b459cf6e-0687-40f5-9e0b-7ea9c2960341", "name": "Atualiza um endereço", "request": { "name": "Atualiza um endereço", "description": { "content": "Atualização parcial. Quando `NewAddressParameter = 1`, aceita todos os campos WMS (dimensões precisam ser positivas; módulo e nível precisam ser numéricos quando alterados). Quando o endereço já tem **movimento** (`StockKeepingUnitMovement` via lote vinculado), **não pode mudar o armazém** — bloqueio para preservar histórico.\n\nNo modo WMS, se o nome do endereço (`Address`) não vier no body, é recalculado automaticamente como `Floor-Street-Module-Column-Level` usando o separador detectado no `Address` original (`-`, `.` ou `|`).\n\nAo marcar `Default = 1`, zera o `Default` dos demais endereços do mesmo armazém antes de aplicar a alteração.", "type": "text/plain" }, "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 9311,\n \"Default\": 0,\n \"AddressPriority\": 7961,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 7706.532521907537,\n \"Width\": 7473.584064616958,\n \"Length\": 2697.239610217039,\n \"MaxWeight\": 8434.943471041928,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6127,\n \"IDStockKeepingUnitLocationGroup\": 6216,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "adb04082-31e5-4824-9bcb-a161fa0e880a", "name": "Endereço atualizado.", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 9311,\n \"Default\": 0,\n \"AddressPriority\": 7961,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 7706.532521907537,\n \"Width\": 7473.584064616958,\n \"Length\": 2697.239610217039,\n \"MaxWeight\": 8434.943471041928,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6127,\n \"IDStockKeepingUnitLocationGroup\": 6216,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitLocation\": 5633,\n \"Address\": \"string\",\n \"Status\": 0,\n \"IDStockKeepingUnitWarehouse\": 9801,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 3560,\n \"DistributionCenterName\": \"string\",\n \"Default\": 1,\n \"AddressPriority\": 5127,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 1780.267359637917,\n \"Width\": 4962.479016217869,\n \"Length\": 4106.680511647669,\n \"MaxWeight\": 7007.480992466166,\n \"IDTypeAddress\": 1,\n \"TypeAddress\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 7178,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 3294,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"LocationSide\": 2,\n \"AllowRessuply\": 0,\n \"StockKeepingUnitLocationIndex\": 5782\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "052add54-236b-43c4-b5d9-33b737295b39", "name": "`[BadRequest] - Localização não existe`; `[BadRequest] - As dimensões do endereço não podem ser negativas`; `[BadRequest] - Preencha módulo e nível com números`; `[BadRequest] - Endereço não pode ter armazém alterado, pois já possui venda`; `[BadRequest] - Armazém não localizado`; `[BadRequest] - Preencha corretamente a categoria de armazenamento`; `[BadRequest] - Preencha corretamente o tipo de endereço`; `[BadRequest] - Grupo endereço não encontrado`; `[BadRequest] - Já existe este endereço para o centro de distribuição`.", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 9311,\n \"Default\": 0,\n \"AddressPriority\": 7961,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 7706.532521907537,\n \"Width\": 7473.584064616958,\n \"Length\": 2697.239610217039,\n \"MaxWeight\": 8434.943471041928,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6127,\n \"IDStockKeepingUnitLocationGroup\": 6216,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d8231b1-1a1e-42c4-9016-40e89b7e0f6d", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 9311,\n \"Default\": 0,\n \"AddressPriority\": 7961,\n \"Floor\": \"string\",\n \"Street\": \"string\",\n \"Module\": \"string\",\n \"Column\": \"string\",\n \"Level\": \"string\",\n \"Height\": 7706.532521907537,\n \"Width\": 7473.584064616958,\n \"Length\": 2697.239610217039,\n \"MaxWeight\": 8434.943471041928,\n \"IDTypeAddress\": 1,\n \"IDStockKeepingUnitLocationCategory\": 6127,\n \"IDStockKeepingUnitLocationGroup\": 6216,\n \"LocationSide\": 1,\n \"AllowRessuply\": 0,\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfe26b5e-9686-423f-8c97-7406b7aa9510", "name": "Exclui um endereço", "request": { "name": "Exclui um endereço", "description": { "content": "**Exclusão física**. Bloqueada quando existe pelo menos um lote (`StockKeepingUnitBatch`) vinculado ao endereço — neste caso devolve `Endereço possui lote/sku vinculado e não pode ser removido`. Para excluir, primeiro transfira o estoque para outro endereço.\n\nQuando o endereço não tem lote vinculado, remove o registro definitivamente e devolve a string `sucesso`.", "type": "text/plain" }, "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "a9a40d2a-472a-4479-b4b3-b4061341b0f5", "name": "Endereço excluído (string `sucesso`).", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa29d24a-9341-4ee2-a0d6-4d1f9334a4d9", "name": "`[BadRequest] - Endereço não existe`; `[BadRequest] - Endereço possui lote/sku vinculado e não pode ser removido`.", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b87dde-65a5-481f-8a01-eb85f0ddf37d", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c71c0ef-9f4a-45bc-b829-d6f699c323aa", "name": "Gera a etiqueta ZPL do endereço", "request": { "name": "Gera a etiqueta ZPL do endereço", "description": { "content": "Devolve o conteúdo ZPL pronto para impressão da etiqueta do endereço. Reaproveita o sistema `purchaseLabelGet` — o conteúdo é definido pelo template de etiqueta de endereço configurado para a empresa.", "type": "text/plain" }, "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "57d92e8d-cb8f-47fe-9eee-9e3ea36820ae", "name": "Etiqueta ZPL como string.", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af5b4b40-c512-4e90-827f-fa040ab387a7", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "location", ":idstockkeepingunitlocation", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitlocation", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "66eecc78-e9bd-4e49-bd10-5ca440b74f65", "name": "Especificações de SKU", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "46aed889-bbba-45b9-b36b-c639371a5811", "name": "Lista as especificações técnicas aplicáveis ao SKU", "request": { "name": "Lista as especificações técnicas aplicáveis ao SKU", "description": { "content": "Retorna os campos de especificação configurados para a categoria do SKU (incluindo categorias-pai por herança), com o valor atual de cada um quando preenchido. Para campos de seleção, `FieldValue` traz a lista de valores escolhidos.", "type": "text/plain" }, "url": { "path": [ "sku", "specification", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5bc10196-6aab-4b49-80ce-d925e5375a04", "name": "Lista de campos de especificação.", "originalRequest": { "url": { "path": [ "sku", "specification", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 9515,\n \"IDStockKeepingUnitSpecifications\": 9811,\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 2523,\n \"FieldType\": \"string\",\n \"IDFieldExternal\": \"string\",\n \"IDCategory\": 1277,\n \"CategoryName\": \"string\",\n \"FieldValue\": {}\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 2329,\n \"IDStockKeepingUnitSpecifications\": 976,\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 7239,\n \"FieldType\": \"string\",\n \"IDFieldExternal\": \"string\",\n \"IDCategory\": 8588,\n \"CategoryName\": \"string\",\n \"FieldValue\": {}\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f761a62-98ac-4811-b435-b8b5f26d79cc", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "specification", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e42c7b7-4cfa-43ad-89a5-70f9615f8685", "name": "Define as especificações técnicas do SKU", "request": { "name": "Define as especificações técnicas do SKU", "description": { "content": "Substitui completamente o conjunto de valores de especificação do SKU. Cada item do array referencia um campo cadastrado (`IDStockKeepingUnitSpecificationsFieldId`); o valor é literal para texto/número/data e um array de objetos com `IDStockKeepingUnitSpecificationsFieldValues` para campos de seleção.", "type": "text/plain" }, "url": { "path": [ "sku", "specification", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 2259,\n \"FieldValue\": {}\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 8772,\n \"FieldValue\": {}\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "602b121b-e3bb-48ad-adb7-6823a5e5dba5", "name": "Especificações gravadas. Retorna `skuSpecificationGet`.", "originalRequest": { "url": { "path": [ "sku", "specification", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 9415,\n \"FieldValue\": {}\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 1097,\n \"FieldValue\": {}\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 9515,\n \"IDStockKeepingUnitSpecifications\": 9811,\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 2523,\n \"FieldType\": \"string\",\n \"IDFieldExternal\": \"string\",\n \"IDCategory\": 1277,\n \"CategoryName\": \"string\",\n \"FieldValue\": {}\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 2329,\n \"IDStockKeepingUnitSpecifications\": 976,\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 7239,\n \"FieldType\": \"string\",\n \"IDFieldExternal\": \"string\",\n \"IDCategory\": 8588,\n \"CategoryName\": \"string\",\n \"FieldValue\": {}\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fccb657b-e058-43a8-84a4-fb71ab297831", "name": "Prefixo `[NotFound]`. Mensagens: `Sku não encontrado`, `Especificação ID não encontrada`, `Valor especificação ID não encontrada`.", "originalRequest": { "url": { "path": [ "sku", "specification", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 9415,\n \"FieldValue\": {}\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 1097,\n \"FieldValue\": {}\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8034e6ba-7144-4906-bbea-93b301170620", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "specification", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 9415,\n \"FieldValue\": {}\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 1097,\n \"FieldValue\": {}\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "267a4f7e-d352-44a8-a021-59910f5d93df", "name": "Especificações por Categoria", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9912e420-5ba9-4f91-9c1e-adcae6a9d708", "name": "Lista especificações da categoria", "request": { "name": "Lista especificações da categoria", "description": { "content": "Lista as especificações (campos) ativas da categoria, **incluindo as herdadas das categorias ancestrais** (a herança sobe a árvore). Cada campo traz seus valores em `FieldValue`.", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f56060b4-aa2b-41a8-b09f-80b7f8915aed", "name": "Especificações da categoria e ancestrais.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 5629,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 6669,\n \"IDCategory\": 5956,\n \"CategoryName\": \"string\",\n \"IDFieldExternal\": \"string\",\n \"IsRequired\": 7454,\n \"IsActive\": 8890,\n \"IsFilter\": 8516,\n \"IsOnProductDetails\": 9277,\n \"IsTopMenuLinkActive\": 7200,\n \"IsSideMenuLinkActive\": 5056,\n \"FieldPosition\": 9319,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 5923,\n \"IDFieldValueExternal\": \"string\",\n \"IDField\": 4711,\n \"Position\": 4555\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1300,\n \"IDFieldValueExternal\": \"string\",\n \"IDField\": 6192,\n \"Position\": 3556\n }\n ]\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 5705,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 207,\n \"IDCategory\": 9040,\n \"CategoryName\": \"string\",\n \"IDFieldExternal\": \"string\",\n \"IsRequired\": 9983,\n \"IsActive\": 3904,\n \"IsFilter\": 8776,\n \"IsOnProductDetails\": 5025,\n \"IsTopMenuLinkActive\": 8377,\n \"IsSideMenuLinkActive\": 3088,\n \"FieldPosition\": 5766,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1747,\n \"IDFieldValueExternal\": \"string\",\n \"IDField\": 8519,\n \"Position\": 9957\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1507,\n \"IDFieldValueExternal\": \"string\",\n \"IDField\": 6568,\n \"Position\": 8057\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2c95657-2ddf-4421-9aee-37ee165ed8e6", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f150e4b-6707-4afb-bb0d-912467796fa4", "name": "Cria especificação na categoria", "request": { "name": "Cria especificação na categoria", "description": { "content": "Cria uma especificação (campo) na categoria. Após inserir, reinvoca `skuSpecificationFieldIdGet` e devolve o campo criado (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 5231,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 203,\n \"IsOnProductDetails\": 6700,\n \"IsTopMenuLinkActive\": 7756,\n \"IsSideMenuLinkActive\": 1965,\n \"IsActive\": 5207,\n \"IsRequired\": 2253,\n \"FieldPosition\": 9685\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e008625f-cdb4-4cf1-90ac-bb2a09678eb7", "name": "Especificação criada (em formato de lista).", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 5231,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 203,\n \"IsOnProductDetails\": 6700,\n \"IsTopMenuLinkActive\": 7756,\n \"IsSideMenuLinkActive\": 1965,\n \"IsActive\": 5207,\n \"IsRequired\": 2253,\n \"FieldPosition\": 9685\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 5683,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 3768,\n \"IDCategory\": 2026,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 8106,\n \"IsFilter\": 5459,\n \"IsOnProductDetails\": 118,\n \"IsRequired\": 3354,\n \"IsTopMenuLinkActive\": 302,\n \"IsSideMenuLinkActive\": 6716,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 2823,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 8879,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 3020,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 9154,\n \"IDCategory\": 836,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 3173,\n \"IsFilter\": 31,\n \"IsOnProductDetails\": 2992,\n \"IsRequired\": 1077,\n \"IsTopMenuLinkActive\": 9549,\n \"IsSideMenuLinkActive\": 5512,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1926,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 730,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81f544f4-6cd0-4573-8252-3f7a4b59101f", "name": "`[BadRequest] - Já existe outra especificação com mesmo código externo`; `[BadRequest] - Categoria não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 5231,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 203,\n \"IsOnProductDetails\": 6700,\n \"IsTopMenuLinkActive\": 7756,\n \"IsSideMenuLinkActive\": 1965,\n \"IsActive\": 5207,\n \"IsRequired\": 2253,\n \"FieldPosition\": 9685\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "994ece72-01ae-4d28-bfe0-4fa66c15351e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 5231,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 203,\n \"IsOnProductDetails\": 6700,\n \"IsTopMenuLinkActive\": 7756,\n \"IsSideMenuLinkActive\": 1965,\n \"IsActive\": 5207,\n \"IsRequired\": 2253,\n \"FieldPosition\": 9685\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "086c2c0a-b334-4c9f-8dbe-e8c56fe025d2", "name": "Detalha especificação", "request": { "name": "Detalha especificação", "description": { "content": "Retorna uma especificação ativa da categoria com seus valores em `FieldValue`. Devolve uma lista vazia quando não existe.", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cbc76fff-0d96-44ee-b6eb-434f80762157", "name": "Dados da especificação (em formato de lista; vazia se não existir).", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6578,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 859,\n \"IDCategory\": 9968,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 1051,\n \"IsFilter\": 4354,\n \"IsOnProductDetails\": 5495,\n \"IsRequired\": 8868,\n \"IsTopMenuLinkActive\": 4861,\n \"IsSideMenuLinkActive\": 3345,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1807,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 2099,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6291,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 6739,\n \"IDCategory\": 1380,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 6078,\n \"IsFilter\": 1784,\n \"IsOnProductDetails\": 1238,\n \"IsRequired\": 5307,\n \"IsTopMenuLinkActive\": 7288,\n \"IsSideMenuLinkActive\": 6586,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 7939,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 5687,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cec50db-bd47-4af3-905c-6e9bde9f60ab", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "046c97c1-e887-41c2-a1ac-0d3019d02c57", "name": "Atualiza especificação", "request": { "name": "Atualiza especificação", "description": { "content": "Atualização parcial da especificação: apenas os campos enviados são alterados. Após atualizar, reinvoca `skuSpecificationFieldIdGet` e devolve o campo (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 9659,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 1047,\n \"IsOnProductDetails\": 2402,\n \"IsTopMenuLinkActive\": 4227,\n \"IsSideMenuLinkActive\": 9156,\n \"IsActive\": 83,\n \"IsRequired\": 5862,\n \"FieldPosition\": 4044\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c371e249-7dce-4b06-abee-fbd78101d12e", "name": "Especificação atualizada (em formato de lista).", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 9659,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 1047,\n \"IsOnProductDetails\": 2402,\n \"IsTopMenuLinkActive\": 4227,\n \"IsSideMenuLinkActive\": 9156,\n \"IsActive\": 83,\n \"IsRequired\": 5862,\n \"FieldPosition\": 4044\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6578,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 859,\n \"IDCategory\": 9968,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 1051,\n \"IsFilter\": 4354,\n \"IsOnProductDetails\": 5495,\n \"IsRequired\": 8868,\n \"IsTopMenuLinkActive\": 4861,\n \"IsSideMenuLinkActive\": 3345,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1807,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 2099,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6291,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 6739,\n \"IDCategory\": 1380,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 6078,\n \"IsFilter\": 1784,\n \"IsOnProductDetails\": 1238,\n \"IsRequired\": 5307,\n \"IsTopMenuLinkActive\": 7288,\n \"IsSideMenuLinkActive\": 6586,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 7939,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 5687,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd353c9f-22c5-4f6a-9ea3-9f4900d48977", "name": "`[BadRequest] - ID Externo já existe para o campo: `; `[BadRequest] - Sku Specification não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 9659,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 1047,\n \"IsOnProductDetails\": 2402,\n \"IsTopMenuLinkActive\": 4227,\n \"IsSideMenuLinkActive\": 9156,\n \"IsActive\": 83,\n \"IsRequired\": 5862,\n \"FieldPosition\": 4044\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1071fd8b-b8f5-4296-bca4-d42b0305f403", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"FieldName\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 9659,\n \"IDFieldExternal\": \"string\",\n \"IsFilter\": 1047,\n \"IsOnProductDetails\": 2402,\n \"IsTopMenuLinkActive\": 4227,\n \"IsSideMenuLinkActive\": 9156,\n \"IsActive\": 83,\n \"IsRequired\": 5862,\n \"FieldPosition\": 4044\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58e5ba88-7067-4c81-933a-125116426798", "name": "Adiciona valor à especificação", "request": { "name": "Adiciona valor à especificação", "description": { "content": "Adiciona um valor a uma especificação do tipo lista. Após inserir, reinvoca `skuSpecificationFieldIdGet` e devolve o campo com seus valores (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 2835\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "75667692-5569-4f28-aba9-ce3ddbb177e5", "name": "Valor adicionado; especificação retornada (em formato de lista).", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 2835\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6578,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 859,\n \"IDCategory\": 9968,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 1051,\n \"IsFilter\": 4354,\n \"IsOnProductDetails\": 5495,\n \"IsRequired\": 8868,\n \"IsTopMenuLinkActive\": 4861,\n \"IsSideMenuLinkActive\": 3345,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1807,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 2099,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6291,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 6739,\n \"IDCategory\": 1380,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 6078,\n \"IsFilter\": 1784,\n \"IsOnProductDetails\": 1238,\n \"IsRequired\": 5307,\n \"IsTopMenuLinkActive\": 7288,\n \"IsSideMenuLinkActive\": 6586,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 7939,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 5687,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d914441-5444-4732-8916-f5536bf94042", "name": "`[BadRequest] - Sku Specification não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 2835\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2939692-f3ce-4184-b40b-e69f2a775261", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 2835\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "429e61db-0a6d-425e-bebd-6999e9a24e68", "name": "Exclui especificação", "request": { "name": "Exclui especificação", "description": { "content": "Exclusão lógica (`Status = 0`) de uma especificação da categoria.", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "a44c3dde-db42-435c-a2ca-c054e6b68fd6", "name": "Especificação excluída.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Message\": \"Sucesso\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b443f9f-5fe8-4976-9547-2aedb069f534", "name": "`[BadRequest] - Sku Specification Field não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d8f2ff8-9220-4cd5-964b-4422e18adc0d", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0439d72b-b87c-473a-9f0c-054051ce1752", "name": "Atualiza valor da especificação", "request": { "name": "Atualiza valor da especificação", "description": { "content": "Atualiza um valor de uma especificação. Após atualizar, reinvoca `skuSpecificationFieldIdGet` e devolve o campo (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 9236\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "951531c9-2491-4604-ae40-9e35ea4d23f8", "name": "Valor atualizado; especificação retornada (em formato de lista).", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 9236\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6578,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 859,\n \"IDCategory\": 9968,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 1051,\n \"IsFilter\": 4354,\n \"IsOnProductDetails\": 5495,\n \"IsRequired\": 8868,\n \"IsTopMenuLinkActive\": 4861,\n \"IsSideMenuLinkActive\": 3345,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1807,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 2099,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6291,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 6739,\n \"IDCategory\": 1380,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 6078,\n \"IsFilter\": 1784,\n \"IsOnProductDetails\": 1238,\n \"IsRequired\": 5307,\n \"IsTopMenuLinkActive\": 7288,\n \"IsSideMenuLinkActive\": 6586,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 7939,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 5687,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ab0a9a-b74d-4c00-9609-f27396146c5f", "name": "`[BadRequest] - Sku Specification Value não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 9236\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7836cf14-af58-4ea1-89bf-8248a51513c1", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Value\": \"string\",\n \"IDFieldValueExternal\": \"string\",\n \"Position\": 9236\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "966b2a4b-e5c1-4a82-8e56-c3fcb6f13bd7", "name": "Exclui valor da especificação", "request": { "name": "Exclui valor da especificação", "description": { "content": "Exclui (físico) um valor de uma especificação. Após excluir, reinvoca `skuSpecificationFieldIdGet` e devolve o campo (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "9cb365c9-d143-4db6-bf63-61974b04cf40", "name": "Valor excluído; especificação retornada (em formato de lista).", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6578,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 859,\n \"IDCategory\": 9968,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 1051,\n \"IsFilter\": 4354,\n \"IsOnProductDetails\": 5495,\n \"IsRequired\": 8868,\n \"IsTopMenuLinkActive\": 4861,\n \"IsSideMenuLinkActive\": 3345,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 1807,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 2099,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": 6291,\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldTypes\": 6739,\n \"IDCategory\": 1380,\n \"IDFieldExternal\": \"string\",\n \"IsActive\": 6078,\n \"IsFilter\": 1784,\n \"IsOnProductDetails\": 1238,\n \"IsRequired\": 5307,\n \"IsTopMenuLinkActive\": 7288,\n \"IsSideMenuLinkActive\": 6586,\n \"FieldValue\": [\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 7939,\n \"IDFieldValueExternal\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"IDStockKeepingUnitSpecificationsFieldValues\": 5687,\n \"IDFieldValueExternal\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c4c6323-074a-4233-8683-2d22ab1e24f9", "name": "`[BadRequest] - Sku Specification Value não existe`.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b71b25af-f7b6-4bdd-be16-9bc73c12ed82", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "category", ":idcategory", "sku-specification", ":idstockkeepingunitspecificationsfieldid", ":idstockkeepingunitspecificationsfieldvalues" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcategory", "description": "(Required) Id da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldid", "description": "(Required) Id da especificação (campo) da categoria." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitspecificationsfieldvalues", "description": "(Required) Id do valor da especificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "cea5b022-1972-447c-be0d-cf995948a0e5", "name": "Etiquetas (Empresa)", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "75ac6d49-e841-4a37-9c7a-233fee0b90dd", "name": "Lista modelos de etiqueta", "request": { "name": "Lista modelos de etiqueta", "description": { "content": "Retorna os modelos de etiqueta cadastrados pela empresa, ordenados pelo nome (`LabelName`), limitados a **3000 itens** por chamada. Aceita filtros por categoria (`IDTypeLabelCategory`) e por identificador único (`IDCompanyLabel`). Cada item traz as dimensões, o código ZPL bruto (quando o modelo foi escrito em modo ZPL) e o nome da categoria já resolvido.", "type": "text/plain" }, "url": { "path": [ "company", "label" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeLabelCategory", "value": "2232", "description": "Filtra por categoria da etiqueta (`TypeLabelCategory`). Valores conhecidos: 1=Embarque (adicional transportadora), 2=Itens (recebimento), 3=Endereços, 4=Itens (cadastro), 5=Transportadora (embarque), 6=Cesto Picking, 7=Transportadora (cadastro), 8=Ressuprimento pendente, 9=Inconformidade picking/packing." }, { "disabled": false, "key": "IDCompanyLabel", "value": "2232", "description": "Filtra por identificador único da etiqueta." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Reservado (lido do query mas sem efeito no caminho atual — todos os itens já vêm na mesma chamada, até 3000)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9f9c5889-81ae-4225-9ed8-5f7bf662e922", "name": "Lista de modelos de etiqueta.", "originalRequest": { "url": { "path": [ "company", "label" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeLabelCategory", "value": "2232" }, { "key": "IDCompanyLabel", "value": "2232" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyLabel\": 8114,\n \"IDCompany\": 2711,\n \"AccountName\": \"string\",\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 5147,\n \"TypeLabelCategory\": \"string\",\n \"HeightCm\": 2336.03318245968,\n \"WidthCm\": 320.1773651506734,\n \"Columns\": 8914,\n \"BetweenColumnsCm\": 6545.7950328151555,\n \"EditorMode\": 2,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 4506.503168243363,\n \"LogoHeight\": 7136.881437816683,\n \"WordCountLimit\": 2341\n },\n {\n \"IDCompanyLabel\": 4328,\n \"IDCompany\": 2892,\n \"AccountName\": \"string\",\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 8826,\n \"TypeLabelCategory\": \"string\",\n \"HeightCm\": 545.5780424783541,\n \"WidthCm\": 3406.051581729852,\n \"Columns\": 2264,\n \"BetweenColumnsCm\": 8558.973591373962,\n \"EditorMode\": 2,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 5037.950609667329,\n \"LogoHeight\": 3924.1843685131726,\n \"WordCountLimit\": 4623\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "684598c4-2d04-4508-817b-8480f4b34020", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "label" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeLabelCategory", "value": "2232" }, { "key": "IDCompanyLabel", "value": "2232" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb0a91c9-a849-428e-832b-9a810013f5dd", "name": "Cadastra um modelo de etiqueta", "request": { "name": "Cadastra um modelo de etiqueta", "description": { "content": "Cria um modelo de etiqueta na empresa autenticada. `IDTypeLabelCategory` precisa existir na tabela de categorias do sistema. `EditorMode` controla a forma como o modelo é desenhado: `1` (default) é o modo **Canvas** — interface visual com variáveis e elementos drag-and-drop; `2` é o modo **ZPL** — código bruto colado no editor. A resposta é a lista de etiquetas filtrada pelo id recém-criado (mesmo formato de `GET /company/label?IDCompanyLabel=`).", "type": "text/plain" }, "url": { "path": [ "company", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 8060,\n \"HeightCm\": 8140.643115161121,\n \"WidthCm\": 9465.647005865976,\n \"Columns\": 2111,\n \"BetweenColumnsCm\": 11.913953903404106,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 8142.366953845075,\n \"LogoHeight\": 9331.412944091,\n \"WordCountLimit\": 8303\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ae834c55-54fd-4063-b3ca-409a500193c7", "name": "Modelo criado. Retorna a etiqueta recém-cadastrada (array com 1 item, mesmo formato da listagem).", "originalRequest": { "url": { "path": [ "company", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 8060,\n \"HeightCm\": 8140.643115161121,\n \"WidthCm\": 9465.647005865976,\n \"Columns\": 2111,\n \"BetweenColumnsCm\": 11.913953903404106,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 8142.366953845075,\n \"LogoHeight\": 9331.412944091,\n \"WordCountLimit\": 8303\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyLabel\": 5594,\n \"IDCompany\": 8271,\n \"AccountName\": \"string\",\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 5906,\n \"TypeLabelCategory\": \"string\",\n \"HeightCm\": 5946.94629355413,\n \"WidthCm\": 3288.4241168350804,\n \"Columns\": 2884,\n \"BetweenColumnsCm\": 6452.906774234537,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 9726.51764765826,\n \"LogoHeight\": 2135.7348598599215,\n \"WordCountLimit\": 3289\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd7ac1a3-e5bb-48cf-b499-d5f6b4e3634e", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Empresa não existe`\n- `Tipo etiqueta não existe`", "originalRequest": { "url": { "path": [ "company", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 8060,\n \"HeightCm\": 8140.643115161121,\n \"WidthCm\": 9465.647005865976,\n \"Columns\": 2111,\n \"BetweenColumnsCm\": 11.913953903404106,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 8142.366953845075,\n \"LogoHeight\": 9331.412944091,\n \"WordCountLimit\": 8303\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b21282c-5425-41df-a5c6-2d3b52fff2cf", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 8060,\n \"HeightCm\": 8140.643115161121,\n \"WidthCm\": 9465.647005865976,\n \"Columns\": 2111,\n \"BetweenColumnsCm\": 11.913953903404106,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 8142.366953845075,\n \"LogoHeight\": 9331.412944091,\n \"WordCountLimit\": 8303\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63ff4ddd-5131-4cbc-87ad-c64b262f43f8", "name": "Atualiza um modelo de etiqueta", "request": { "name": "Atualiza um modelo de etiqueta", "description": { "content": "Atualiza parcialmente o modelo — apenas os campos enviados são alterados. Quando `IDTypeLabelCategory` for informado, precisa existir na tabela de categorias. A resposta é a etiqueta atualizada no mesmo formato da listagem.", "type": "text/plain" }, "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 1022,\n \"HeightCm\": 8264.34677174214,\n \"WidthCm\": 2128.201020135405,\n \"Columns\": 9039,\n \"BetweenColumnsCm\": 866.0013871221661,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 3057.8412814888757,\n \"LogoHeight\": 4406.40490010446,\n \"WordCountLimit\": 9094\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "996b0b8e-5a38-4c96-9fd8-e2798efed752", "name": "Modelo atualizado.", "originalRequest": { "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 1022,\n \"HeightCm\": 8264.34677174214,\n \"WidthCm\": 2128.201020135405,\n \"Columns\": 9039,\n \"BetweenColumnsCm\": 866.0013871221661,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 3057.8412814888757,\n \"LogoHeight\": 4406.40490010446,\n \"WordCountLimit\": 9094\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyLabel\": 5594,\n \"IDCompany\": 8271,\n \"AccountName\": \"string\",\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 5906,\n \"TypeLabelCategory\": \"string\",\n \"HeightCm\": 5946.94629355413,\n \"WidthCm\": 3288.4241168350804,\n \"Columns\": 2884,\n \"BetweenColumnsCm\": 6452.906774234537,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 9726.51764765826,\n \"LogoHeight\": 2135.7348598599215,\n \"WordCountLimit\": 3289\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c156b1c-ce5c-4ebf-ade4-6d19460ce446", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Etiqueta não existe`\n- `Tipo etiqueta não existe`", "originalRequest": { "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 1022,\n \"HeightCm\": 8264.34677174214,\n \"WidthCm\": 2128.201020135405,\n \"Columns\": 9039,\n \"BetweenColumnsCm\": 866.0013871221661,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 3057.8412814888757,\n \"LogoHeight\": 4406.40490010446,\n \"WordCountLimit\": 9094\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33166c99-0895-4be2-8dc0-6717b0d33f3d", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"LabelName\": \"string\",\n \"IDTypeLabelCategory\": 1022,\n \"HeightCm\": 8264.34677174214,\n \"WidthCm\": 2128.201020135405,\n \"Columns\": 9039,\n \"BetweenColumnsCm\": 866.0013871221661,\n \"EditorMode\": 1,\n \"LabelZpl\": \"string\",\n \"LogoWidth\": 3057.8412814888757,\n \"LogoHeight\": 4406.40490010446,\n \"WordCountLimit\": 9094\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77f28dde-4105-4f13-9928-73ac9b9a1754", "name": "Exclui um modelo de etiqueta", "request": { "name": "Exclui um modelo de etiqueta", "description": { "content": "**Exclusão física** — diferente de outros cadastros do idworks, o modelo é apagado definitivamente do banco. Transportadoras e fornecedores que apontavam para essa etiqueta via `IDCompanyLabel` passam a ter o vínculo quebrado (o id deixa de existir). A resposta é a string `\"Sucesso\"` (com S maiúsculo).", "type": "text/plain" }, "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f2a3af64-3aaa-46a1-bf75-08fbf7a43c72", "name": "Modelo excluído. Retorna a string `\"Sucesso\"`.", "originalRequest": { "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bcc1b49-7985-4bf2-b4eb-008d2730b2ce", "name": "Erros (prefixo `[BadRequest]`):\n- `Etiqueta não existe`\n- `Erro ao deletar etiqueta`", "originalRequest": { "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d23c054-de4c-455b-8403-ec786e1d78fa", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "label", ":idcompanylabel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanylabel", "description": "(Required) Identificador do modelo de etiqueta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d2540ffa-5400-4de8-8210-9fa38f9d0e49", "name": "Faixa de Etiquetas Correios", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "12efd701-b9a5-466f-8d2b-fc25d1ed816b", "name": "Gera uma faixa de etiquetas Correios para a transportadora", "request": { "name": "Gera uma faixa de etiquetas Correios para a transportadora", "description": { "content": "Dispara a rotina que solicita uma nova faixa de códigos de rastreio (etiquetas) aos Correios para a transportadora informada. A transportadora precisa pertencer à empresa autenticada e ter tipo Correios.", "type": "text/plain" }, "url": { "path": [ "correios", "generaterange" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCarrier", "value": "2232", "description": "Identificador da transportadora Correios. Enviado como query string." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "ffcf99c3-3f14-434d-bcb5-88e6035f863d", "name": "Geração disparada. Retorna o literal `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "correios", "generaterange" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCarrier", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e76bf825-f3ab-45ef-a5a7-70a7e97653a2", "name": "Transportadora inexistente para a empresa ou não é do tipo Correios. Prefixo `[BadRequest]`.", "originalRequest": { "url": { "path": [ "correios", "generaterange" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCarrier", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f81bfd13-5349-479d-b50f-31b3dc1b2319", "name": "Erro retornado pelo processo. Mensagem propagada do serviço externo.", "originalRequest": { "url": { "path": [ "correios", "generaterange" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCarrier", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "61bae08d-d228-4651-bda0-a291f19dbb4d", "name": "Feed de NF-e", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4500fa1b-9a4d-405a-886b-a91c31af5de3", "name": "Lista o feed de NF-e recebidas", "request": { "name": "Lista o feed de NF-e recebidas", "description": { "content": "Lista as NF-e emitidas contra o CNPJ da empresa, baixadas automaticamente da SEFAZ. Cada linha vem com dados da nota (número, série, chave de acesso, fornecedor, valor, datas), descrição do tipo (Entrada/Saída via `NfTpNf`), descrição do último evento (`NfTpEvent`), situação SEFAZ (`NfCSit`), tags internas, eventual recebimento criado (`IDPurchase`), eventual conta a pagar associada (`IDAccountPayableReceivable`, resolvida por fornecedor + número de documento) e URLs assinadas para o **XML** e a **DANFE** (servidor `/invoice/danfe?Folder=Inbound&Type=XML|PDF&Origin=Feed&token=...&File=`).\n\nPaginação: **500 por página** (`Page=N` → offset `N*500`). Ordenação: `ORDER BY IDNfEvents DESC`.", "type": "text/plain" }, "url": { "path": [ "purchase", "feed" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Página 0-indexada. Offset = `Page * 500`." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "1603", "description": "Empresa faturadora (`IDCompanyInvoice` → `IDCompany`). Usado em ambientes multi-empresa." }, { "disabled": false, "key": "SupplierNameCorporateName", "value": "string", "description": "Nome/razão social do fornecedor (LIKE em `SupplierNameCorporateName`)." }, { "disabled": false, "key": "NfeNumber", "value": "string", "description": "Número da NF-e (`NFeNumber`). Aceita com pontuação — apenas os dígitos são considerados." }, { "disabled": false, "key": "SupplierCpfCnpj", "value": "string", "description": "CPF/CNPJ do fornecedor (LIKE). Pontuação é removida pelo sistema antes da consulta." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "`NFeDate` ≥ data (data de emissão)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "`NFeDate` ≤ data + ` 23:59:59`." }, { "disabled": false, "key": "IDNfEvents", "value": "1603", "description": "Código interno da linha do feed. Útil para buscar uma linha específica." }, { "disabled": false, "key": "Tags", "value": "string", "description": "Filtra apenas linhas que têm a tag informada em `Tag`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3edfc6d1-53a0-4340-b30f-9be542cf7792", "name": "Lista de NF-e do feed. Quando nenhum registro casa com os filtros, retorna `[]`.", "originalRequest": { "url": { "path": [ "purchase", "feed" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "IDCompanyInvoice", "value": "1603" }, { "key": "SupplierNameCorporateName", "value": "string" }, { "key": "NfeNumber", "value": "string" }, { "key": "SupplierCpfCnpj", "value": "string" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDNfEvents", "value": "1603" }, { "key": "Tags", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDNfEvents\": 9808,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompany\": 6117,\n \"IDCompanyInvoice\": 164,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"IDSupplier\": 7430,\n \"NFeNumber\": 1331,\n \"NFeAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"NFeDate\": \"1985-05-30T15:50:23.001Z\",\n \"NFeValue\": 3942.881942136249,\n \"NFeTpNf\": 1,\n \"NfTpNfDescription\": \"Entrada\",\n \"NFeSit\": 9026,\n \"SitNfeDescription\": \"Uso autorizado\",\n \"NFeTpEvento\": 7610,\n \"NfTpEventDescription\": \"string\",\n \"IDPurchase\": 5603,\n \"IDAccountPayableReceivable\": 4280,\n \"XmlFile\": \"http://wIXalPfDH.estnqDRurbAxQ\",\n \"XmlDanfe\": \"https://OTLMrJAVpoWmQp.etBAGwRtmFrDOW4.MaDP7z7zFCh1qQsrKSaBaYLGBo9\",\n \"Tags\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDNfEvents\": 7836,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompany\": 4918,\n \"IDCompanyInvoice\": 4191,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"IDSupplier\": 5846,\n \"NFeNumber\": 4623,\n \"NFeAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"NFeDate\": \"1981-04-24T18:21:27.902Z\",\n \"NFeValue\": 3164.8941275180055,\n \"NFeTpNf\": 1,\n \"NfTpNfDescription\": \"Entrada\",\n \"NFeSit\": 2066,\n \"SitNfeDescription\": \"Uso denegado\",\n \"NFeTpEvento\": 1043,\n \"NfTpEventDescription\": \"string\",\n \"IDPurchase\": 8936,\n \"IDAccountPayableReceivable\": 2424,\n \"XmlFile\": \"http://xNYfEJvSJ.icyvm-iwWvwWU\",\n \"XmlDanfe\": \"https://g.arOmW5ik1Lft9xxIxLt54+QVDae-9VDG4Fy\",\n \"Tags\": [\n \"string\",\n \"string\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca48a93b-6832-4496-b49a-5716c7fc177f", "name": "Atualiza tags da NF do feed", "request": { "name": "Atualiza tags da NF do feed", "description": { "content": "Sincroniza as tags internas da linha (`NfEventsTag`) com o array `Tags` enviado no body. Fluxo:\n\n1. Localiza a nota por `IDNfEvents` + `AccountName = prefix`. Falha com `[BadRequest] - Nota fiscal não existe` se não encontrar.\n2. Compara as tags atuais com o array enviado.\n3. Tags presentes no array enviado que ainda não existem são adicionadas.\n4. Tags atuais que não estão no array enviado são removidas.\n5. Quando o array vier vazio, todas as tags da linha são removidas.\n6. Devolve a linha atualizada.\n\nO array `Tags` é livre — qualquer string de até 255 caracteres pode ser usada como tag. A tela usa o componente Select com modo `tags` para criar/reutilizar.", "type": "text/plain" }, "url": { "path": [ "purchase", "feed", ":idnfevents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idnfevents", "description": "(Required) Código interno da linha do feed." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d7aed973-e428-4bc2-a53f-3b4809324454", "name": "Linha do feed atualizada (array com 1 item, mesmo schema de `GET /purchase/feed`).", "originalRequest": { "url": { "path": [ "purchase", "feed", ":idnfevents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idnfevents", "description": "(Required) Código interno da linha do feed." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDNfEvents\": 995,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompany\": 6649,\n \"IDCompanyInvoice\": 1341,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"IDSupplier\": 8868,\n \"NFeNumber\": 2322,\n \"NFeAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"NFeDate\": \"1965-09-01T22:44:15.578Z\",\n \"NFeValue\": 9130.042696220718,\n \"NFeTpNf\": 0,\n \"NfTpNfDescription\": \"Saída\",\n \"NFeSit\": 8994,\n \"SitNfeDescription\": \"Uso autorizado\",\n \"NFeTpEvento\": 9394,\n \"NfTpEventDescription\": \"string\",\n \"IDPurchase\": 2478,\n \"IDAccountPayableReceivable\": 1749,\n \"XmlFile\": \"https://wCpgiGlj.rcV1uVKx2ZIxSIhuiGKZYy,O3KM\",\n \"XmlDanfe\": \"http://OsgFDGhkzYXboWtEAKLBDpG.syb19jIQdDFPfuTE2JbqqsxhIjK0dmL4LlSEms7P2iw+9RNJWEm,rpG3LRs.wZt\",\n \"Tags\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDNfEvents\": 1511,\n \"AccountName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDCompany\": 9075,\n \"IDCompanyInvoice\": 3744,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCpfCnpj\": \"string\",\n \"IDSupplier\": 8898,\n \"NFeNumber\": 7323,\n \"NFeAccessKey\": \"stringstringstringstringstringstringstringst\",\n \"NFeDate\": \"1968-11-16T17:34:05.373Z\",\n \"NFeValue\": 2595.06807237752,\n \"NFeTpNf\": 1,\n \"NfTpNfDescription\": \"Entrada\",\n \"NFeSit\": 8327,\n \"SitNfeDescription\": \"Uso denegado\",\n \"NFeTpEvento\": 7610,\n \"NfTpEventDescription\": \"string\",\n \"IDPurchase\": 9590,\n \"IDAccountPayableReceivable\": 301,\n \"XmlFile\": \"http://EvJKZmuPLGlUcEtE.nqeV6b9,vbPV.h+iwTxCQbv77GoFWR6b1yiohdw74dEL+3pQsMLLoJr+6,Tu2ni2O5WMKSZ,EVnbpoFVJz,VEFgYJH\",\n \"XmlDanfe\": \"https://UoJapKqumamEViQGEBVoAByLKYRyvmFmD.yhoxjLKOns\",\n \"Tags\": [\n \"string\",\n \"string\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65522a1a-59e8-4cf8-b81d-5df522b93ff2", "name": "Mensagens emitidas: `[BadRequest] - Nota fiscal não existe`.", "originalRequest": { "url": { "path": [ "purchase", "feed", ":idnfevents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idnfevents", "description": "(Required) Código interno da linha do feed." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Tags\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab0f1b02-690d-40af-b377-ce025b1269cc", "name": "Manifesta a NF perante a SEFAZ", "request": { "name": "Manifesta a NF perante a SEFAZ", "description": { "content": "Envia um evento de manifestação do destinatário à SEFAZ para a nota informada. O evento fica registrado no histórico oficial da nota e não pode ser desfeito. Eventos aceitos: `210200` Confirmação da Operação, `210210` Ciência da Emissão, `210220` Desconhecimento da Operação e `210240` Operação não Realizada — este último exige `Comments` com pelo menos 15 caracteres. O frontend usa o mesmo endpoint na ação em lote, iterando uma chamada por nota selecionada.", "type": "text/plain" }, "url": { "path": [ "purchase", "feed", ":idnfevents", "manifest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idnfevents", "description": "(Required) Código interno da linha do feed." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Event\": 210240,\n \"Comments\": \"stringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1bb18b19-875f-4fe5-9087-b0659ede5513", "name": "Manifestação aceita pela SEFAZ. O evento fica registrado no histórico da nota e passa a aparecer na coluna `Evento` do feed.", "originalRequest": { "url": { "path": [ "purchase", "feed", ":idnfevents", "manifest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idnfevents", "description": "(Required) Código interno da linha do feed." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Event\": 210240,\n \"Comments\": \"stringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23949ef2-b9ea-4a50-8729-7e8a06e7c3a4", "name": "Validação ou erro retornado pela SEFAZ. Mensagens possíveis: `Evento não permitido` (quando `Event` está fora dos valores aceitos), `Motivo do evento precisa ser maior que 15 caracteres` (`Event=210240` com `Comments` abaixo de 15 caracteres), `Nota não encontrada`, `Empresa não localizada`, `Certificado digital não encontrado`, além do motivo (`xMotivo`) devolvido pela própria SEFAZ quando a manifestação é rejeitada.", "originalRequest": { "url": { "path": [ "purchase", "feed", ":idnfevents", "manifest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idnfevents", "description": "(Required) Código interno da linha do feed." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Event\": 210240,\n \"Comments\": \"stringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c6d8189-936a-44dc-b6f0-0d10d48c27d3", "name": "Baixa XML de várias NFs em lote", "request": { "name": "Baixa XML de várias NFs em lote", "description": { "content": "Empacota em um único arquivo `.zip` os XMLs das notas informadas e devolve um link temporário de download, válido por 2 dias. Em paralelo, o mesmo link é enviado por e-mail ao usuário autenticado.\n\nO corpo é um array de strings no formato `.xml`, uma por nota. A tela de feed de NF-e envia apenas as notas que têm número de nota fiscal e cuja situação é `Uso autorizado`.\n\nSe o modelo do e-mail não puder ser carregado, o link ainda é devolvido na resposta — apenas o envio por e-mail é pulado.", "type": "text/plain" }, "url": { "path": [ "purchase", "feed", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n \"stringstringstringstringstringstringstringstring\"\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "494f796c-65bb-4a29-a09e-2dbc4eff07b8", "name": "URL pré-assinada para download do zip. Resposta é a URL pura (string). Em paralelo, um e-mail com o mesmo link é enviado ao usuário logado.", "originalRequest": { "url": { "path": [ "purchase", "feed", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n \"stringstringstringstringstringstringstringstring\"\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"https://idworks.s3.amazonaws.com/Temp/abc.zip?X-Amz-Algorithm=...\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26de21ae-2be5-4a6a-8181-4846ebe52d11", "name": "Mensagens `[BadRequest]`:\n- `Usuário não localizado`\n- `Falha ao montar o arquivo de NF de entrada: `\n- `Falha ao subir o arquivo de NF de entrada: `\n- `Falha ao gerar o link de download: `", "originalRequest": { "url": { "path": [ "purchase", "feed", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n \"stringstringstringstringstringstringstringstring\"\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ace71d97-26b1-459c-8fb1-fb7f9389d643", "name": "Erro interno. Mensagens começam com `catched error:`. Falha no envio do e-mail com o link também cai neste status.", "originalRequest": { "url": { "path": [ "purchase", "feed", "invoice-xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n \"stringstringstringstringstringstringstringstring\"\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0becc86-80d3-4866-b4f2-8c3653211457", "name": "Baixa DANFE de várias NFs em lote", "request": { "name": "Baixa DANFE de várias NFs em lote", "description": { "content": "Empacota em um único `.zip` os PDFs de DANFE das notas informadas e gera uma URL para download (mesmo fluxo do `invoice-xml`, mas para PDFs).\n\nO body é um **array de inteiros** com os `IDNfEvents` das notas a baixar.", "type": "text/plain" }, "url": { "path": [ "purchase", "feed", "invoice-danfe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n 7660,\n 8847\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eccb945d-eef5-4bf6-b3d3-a2c8d424c5a7", "name": "URL pré-assinada para download do zip de PDFs.", "originalRequest": { "url": { "path": [ "purchase", "feed", "invoice-danfe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n 9226,\n 2569\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"http://MGyvSv.nedf2CLEQ7bXzxrOZTOjfy+rfLOqdKqiUdsSY\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "936e8ebf-025f-4be3-bc80-5777679f059a", "name": "Lista tags do feed", "request": { "name": "Lista tags do feed", "description": { "content": "Lista todas as tags já cadastradas em notas do feed da empresa autenticada (`Tag` agrupado). Usado pelo seletor de Tags do modal **Adicionar Tag** e pelo filtro **Tags** do painel de filtros.", "type": "text/plain" }, "url": { "path": [ "purchase", "feed", "tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2a2c5927-e6ba-4db7-97a8-51006a0561a6", "name": "Array com as tags distintas.", "originalRequest": { "url": { "path": [ "purchase", "feed", "tag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Tag\": \"string\"\n },\n {\n \"Tag\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7a2856ee-a970-491f-ac4c-c3d106d7615e", "name": "Fluxo de Caixa", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "153c6378-4ead-4673-8658-23b9f6a14bd8", "name": "Lista o fluxo de caixa", "request": { "name": "Lista o fluxo de caixa", "description": { "content": "Retorna o fluxo de caixa da empresa em dois modos, controlados pelo parâmetro `Type`:\n\n- **Resumo** (default, sem `Type`): consolidado mês a mês (ou dia a dia, com `GroupBy=day`) do **previsto** `TotalValue` e do **realizado** `ValuePaid`, agrupado por plano de contas. Cada item inclui a árvore completa do plano de contas em `CategoryTree`. Considera o ano inteiro definido em `Year` (ou o ano corrente quando omitido) e ignora contas com status **Não lançado**.\n- **Detalhe** (`Type=Detail`): lista os títulos individuais (`AccountsPayableReceivable`) que compõem uma célula do resumo. Use `IDTypeAccountPayableReceivable` para restringir ao plano de contas selecionado e `Date` (primeiro dia do mês `YYYY-MM-DD`) combinado com `DateType` para restringir ao mês — `DateType=DateDue` filtra pelo vencimento (coluna **Previsto**); qualquer outro valor (a UI envia `DatePayment`) filtra pela data de pagamento lançado (coluna **Realizado**).\n\nValores são assinados pelo tipo de lançamento: contas a pagar (`IDTypeAccount=1`) entram negativas; contas a receber (`IDTypeAccount=0`) entram positivas.", "type": "text/plain" }, "url": { "path": [ "accounts", "cash-flow" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Year", "value": "2232", "description": "Ano de referência (default: ano corrente). O resumo cobre de 01/jan a 31/dez deste ano." }, { "disabled": false, "key": "GroupBy", "value": "month", "description": "Granularidade do agrupamento no modo Resumo: `month` consolida por mês, `day` consolida por dia. Ignorado no modo Detalhe." }, { "disabled": false, "key": "Type", "value": "Detail", "description": "Quando `Detail`, lista os títulos individuais (modo de detalhamento, usado pelo drill-through). Omitido: modo Resumo." }, { "disabled": false, "key": "Date", "value": "1980-02-08", "description": "**Modo Detalhe**. Início do período a detalhar (`YYYY-MM-DD`). Sem `DateTo`, o sistema deriva o último dia do mesmo mês como limite superior." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "**Modo Detalhe**. Fim do período a detalhar (`YYYY-MM-DD`, inclusive). Permite detalhar um dia, vários meses ou o ano a partir de `Date`. Omitido: vale o mês de `Date`." }, { "disabled": false, "key": "DateType", "value": "DateDue", "description": "**Modo Detalhe**. Define a coluna do `Date`: `DateDue` filtra pelo vencimento (lançamentos previstos do mês); `DatePayment` filtra pela data do pagamento lançado (lançamentos realizados do mês)." }, { "disabled": false, "key": "IDTypeAccountPayableReceivable", "value": "string", "description": "**Modo Detalhe**. Restringe a um ou mais planos de contas (lista separada por vírgula). O detalhe de um nó pai da árvore envia todas as categorias debaixo dele." }, { "disabled": false, "key": "IDBankAccountForecast", "value": "2232", "description": "Filtra pela conta bancária prevista do lançamento." }, { "disabled": false, "key": "IDBankAccount", "value": "2232", "description": "Filtra por lançamentos que tenham pelo menos um pagamento (entrada do extrato) na conta bancária informada." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra pela empresa faturadora (filial) do lançamento." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5d47801a-a0b0-41bf-b75f-b197cfba0257", "name": "Fluxo de caixa retornado. O formato depende de `Type`: array de itens consolidados (modo Resumo) ou array de títulos individuais (modo Detalhe). Quando não há registros no Resumo, retorna `[]`.", "originalRequest": { "url": { "path": [ "accounts", "cash-flow" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Year", "value": "2232" }, { "key": "GroupBy", "value": "month" }, { "key": "Type", "value": "Detail" }, { "key": "Date", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "DateType", "value": "DateDue" }, { "key": "IDTypeAccountPayableReceivable", "value": "string" }, { "key": "IDBankAccountForecast", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Month\": 6367,\n \"Year\": 1535,\n \"Date\": \"2006-02-11T00:03:10.617Z\",\n \"TotalValue\": 8603.52585782976,\n \"TotalQty\": 7032,\n \"ValuePaid\": 5828.278899344983,\n \"IDTypeAccount\": 0,\n \"IDTypeAccountPayableReceivable\": 4104,\n \"IDTypeAccountPaybleFather\": 9833,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": [\n \"string\",\n \"string\"\n ],\n \"IDCompanyInvoice\": 8260\n },\n {\n \"Month\": 8409,\n \"Year\": 539,\n \"Date\": \"1983-01-03T11:41:20.747Z\",\n \"TotalValue\": 3748.771525659147,\n \"TotalQty\": 1375,\n \"ValuePaid\": 8840.515319435019,\n \"IDTypeAccount\": 1,\n \"IDTypeAccountPayableReceivable\": 8627,\n \"IDTypeAccountPaybleFather\": 4332,\n \"TypeAccountPaybleDescription\": \"string\",\n \"CategoryTree\": [\n \"string\",\n \"string\"\n ],\n \"IDCompanyInvoice\": 7554\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6c9bd50-571e-49f2-9018-11c7ac6741a1", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "accounts", "cash-flow" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Year", "value": "2232" }, { "key": "GroupBy", "value": "month" }, { "key": "Type", "value": "Detail" }, { "key": "Date", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "DateType", "value": "DateDue" }, { "key": "IDTypeAccountPayableReceivable", "value": "string" }, { "key": "IDBankAccountForecast", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bb8c2c65-0738-419f-8875-56afd7186acd", "name": "Fornecedores ↔ SKUs", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ba3d2d73-82ec-47d9-9fee-b9269c8065c3", "name": "Lista vínculos SKU-fornecedor", "request": { "name": "Lista vínculos SKU-fornecedor", "description": { "content": "Lista a visão consolidada de produtos e seus fornecedores na conta autenticada, com os dados do produto somados aos do vínculo. Os filtros são combinados por `AND`; `Search` busca por código do produto, nome, código de barras e código de referência (combinados por `OR`). A resposta é paginada em blocos de 5000 registros via `Page`.", "type": "text/plain" }, "url": { "path": [ "sku", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "2232", "description": "Página da listagem (cada página traz até 5000 registros)." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca textual por código do produto, nome, código de barras e código de referência." }, { "disabled": false, "key": "IDSku", "value": "string", "description": "Filtra por identificador do produto." }, { "disabled": false, "key": "SkuName", "value": "string", "description": "Filtra por nome do produto." }, { "disabled": false, "key": "BarCode", "value": "string", "description": "Filtra por código de barras." }, { "disabled": false, "key": "IDSkuCompany", "value": "string", "description": "Filtra por código de referência (parcial)." }, { "disabled": false, "key": "IDBrand", "value": "string", "description": "Filtra por marca." }, { "disabled": false, "key": "IDCategory", "value": "string", "description": "Filtra por categoria." }, { "disabled": false, "key": "SupplierCode", "value": "string", "description": "Filtra por código do fornecedor (parcial)." }, { "disabled": false, "key": "IDSupplier", "value": "string", "description": "Filtra por fornecedor." }, { "disabled": false, "key": "Package", "value": "string", "description": "Filtra por indicador de embalagem." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "string", "description": "Filtra produtos anunciados em uma integração específica." }, { "disabled": false, "key": "IDCompanyIntegrationNot", "value": "string", "description": "Filtra produtos NÃO anunciados em uma integração específica." }, { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "string", "description": "Filtra produtos anunciados em um tipo de canal de vendas." }, { "disabled": false, "key": "IDTypeCompanyIntegrationNot", "value": "string", "description": "Filtra produtos NÃO anunciados em um tipo de canal de vendas." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "072db1cb-923d-4ff1-b72f-f7a61f9adf17", "name": "Lista de vínculos SKU-fornecedor.", "originalRequest": { "url": { "path": [ "sku", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "2232" }, { "key": "Search", "value": "string" }, { "key": "IDSku", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "IDBrand", "value": "string" }, { "key": "IDCategory", "value": "string" }, { "key": "SupplierCode", "value": "string" }, { "key": "IDSupplier", "value": "string" }, { "key": "Package", "value": "string" }, { "key": "IDCompanyIntegration", "value": "string" }, { "key": "IDCompanyIntegrationNot", "value": "string" }, { "key": "IDTypeCompanyIntegration", "value": "string" }, { "key": "IDTypeCompanyIntegrationNot", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSku\": 9279,\n \"IDStockKeepingUnitSuplierCode\": 9512,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Category\": \"string\",\n \"IDCategory\": 846,\n \"Brand\": \"string\",\n \"IDBrand\": 8461,\n \"AccountName\": \"string\",\n \"Package\": 8218,\n \"Batch\": 4449,\n \"OwnProduction\": 7671,\n \"SkuNCM\": \"string\",\n \"SkuCest\": \"string\",\n \"IDTaxDepartment\": 4547,\n \"CostAverage\": 7612.504948324064,\n \"CostLastPurchase\": 7872.961407158401,\n \"SupplierCode\": \"string\",\n \"IDSupplier\": 855,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierProductReliability\": 6548,\n \"SupplierProductLeadTimeDays\": 4230,\n \"QuantityMultiply\": 166.9587700393116,\n \"PackageSize\": 8635,\n \"LastValueCost\": 6006.939725974949,\n \"PisAliquotInbound\": 9060.278297671415,\n \"CofinsAliquotInbound\": 8289.90759731049,\n \"SkuHeight\": 8449.86565070857,\n \"SkuLength\": 4195.6195887074155,\n \"SkuWidth\": 4800.291029947363,\n \"SkuWeight\": 3051.5296935191195,\n \"AbcCurve\": \"string\",\n \"InfiniteInventory\": 2522,\n \"QtySafetyStock\": 6204.282738185405,\n \"QtyAvailable\": 2751.8205534173144,\n \"PriceSell\": 4068.7013057711383,\n \"PriceList\": 7919.423728329158,\n \"IDProduct\": 3722,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDSku\": 8673,\n \"IDStockKeepingUnitSuplierCode\": 3987,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Category\": \"string\",\n \"IDCategory\": 1707,\n \"Brand\": \"string\",\n \"IDBrand\": 9038,\n \"AccountName\": \"string\",\n \"Package\": 2980,\n \"Batch\": 9913,\n \"OwnProduction\": 4229,\n \"SkuNCM\": \"string\",\n \"SkuCest\": \"string\",\n \"IDTaxDepartment\": 7860,\n \"CostAverage\": 1639.4953138023704,\n \"CostLastPurchase\": 8682.015657115833,\n \"SupplierCode\": \"string\",\n \"IDSupplier\": 9742,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierProductReliability\": 5230,\n \"SupplierProductLeadTimeDays\": 2997,\n \"QuantityMultiply\": 5449.965187089944,\n \"PackageSize\": 9143,\n \"LastValueCost\": 1068.0533533643866,\n \"PisAliquotInbound\": 9040.110168551046,\n \"CofinsAliquotInbound\": 9151.440798477117,\n \"SkuHeight\": 6934.2514624559335,\n \"SkuLength\": 1917.407544355363,\n \"SkuWidth\": 9852.77259144351,\n \"SkuWeight\": 6165.36903460279,\n \"AbcCurve\": \"string\",\n \"InfiniteInventory\": 9271,\n \"QtySafetyStock\": 9478.58424929564,\n \"QtyAvailable\": 1978.798785964302,\n \"PriceSell\": 2226.0858097443956,\n \"PriceList\": 7259.006655090232,\n \"IDProduct\": 4453,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86ce3e04-e258-446a-8594-a146a5367587", "name": "Lista fornecedores de um SKU", "request": { "name": "Lista fornecedores de um SKU", "description": { "content": "Retorna os fornecedores vinculados a um produto. Informe `IDStockKeepingUnitSuplierCode` para restringir a um vínculo específico.", "type": "text/plain" }, "url": { "path": [ "sku", "supplier", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitSuplierCode", "value": "2232", "description": "Restringe a resposta a um vínculo específico." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "58f91466-1d67-43da-9f75-2048fdc1ef30", "name": "Fornecedores do produto.", "originalRequest": { "url": { "path": [ "sku", "supplier", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitSuplierCode", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSuplierCode\": 8289,\n \"IDSupplier\": 1961,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 6963.070245478111,\n \"PackageSize\": 1596,\n \"LastValueCost\": 7392.9526238145545,\n \"PisAliquotInbound\": 1247.2146740950918,\n \"CofinsAliquotInbound\": 8565.408446108027\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 6605,\n \"IDSupplier\": 5809,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 9397.88122840084,\n \"PackageSize\": 8012,\n \"LastValueCost\": 6278.870673823433,\n \"PisAliquotInbound\": 8119.667452817687,\n \"CofinsAliquotInbound\": 8025.9544967384345\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2732ee27-c572-4d77-841e-d3c505d73f9a", "name": "Vincula fornecedor ao SKU", "request": { "name": "Vincula fornecedor ao SKU", "description": { "content": "Cria um vínculo entre o produto e um fornecedor. Após inserir, reinvoca `skuSupplierGet` e devolve a lista de fornecedores do produto.", "type": "text/plain" }, "url": { "path": [ "sku", "supplier", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSupplier\": 565,\n \"QuantityMultiply\": 2779.201285652155,\n \"SupplierCode\": \"string\",\n \"PackageSize\": 8894,\n \"LastValueCost\": 6354.360307498719,\n \"PisAliquotInbound\": 2343.1625286756907,\n \"CofinsAliquotInbound\": 2858.1169273933992\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d439303-9011-4ae0-b597-2f18de61f77b", "name": "Fornecedores do produto após a inclusão.", "originalRequest": { "url": { "path": [ "sku", "supplier", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplier\": 565,\n \"QuantityMultiply\": 2779.201285652155,\n \"SupplierCode\": \"string\",\n \"PackageSize\": 8894,\n \"LastValueCost\": 6354.360307498719,\n \"PisAliquotInbound\": 2343.1625286756907,\n \"CofinsAliquotInbound\": 2858.1169273933992\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSuplierCode\": 8289,\n \"IDSupplier\": 1961,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 6963.070245478111,\n \"PackageSize\": 1596,\n \"LastValueCost\": 7392.9526238145545,\n \"PisAliquotInbound\": 1247.2146740950918,\n \"CofinsAliquotInbound\": 8565.408446108027\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 6605,\n \"IDSupplier\": 5809,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 9397.88122840084,\n \"PackageSize\": 8012,\n \"LastValueCost\": 6278.870673823433,\n \"PisAliquotInbound\": 8119.667452817687,\n \"CofinsAliquotInbound\": 8025.9544967384345\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc36283b-9046-4fc8-9e1c-3e6d0671bd57", "name": "`[BadRequest] - Sku não existe`, `[BadRequest] - Fornecedor não existe` ou `[BadRequest] - Código e fornecedor já estão cadastrados`.", "originalRequest": { "url": { "path": [ "sku", "supplier", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSupplier\": 565,\n \"QuantityMultiply\": 2779.201285652155,\n \"SupplierCode\": \"string\",\n \"PackageSize\": 8894,\n \"LastValueCost\": 6354.360307498719,\n \"PisAliquotInbound\": 2343.1625286756907,\n \"CofinsAliquotInbound\": 2858.1169273933992\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a59313d5-6d04-4565-a96d-2a0d4c9bb6ea", "name": "Atualiza vínculo de fornecedor", "request": { "name": "Atualiza vínculo de fornecedor", "description": { "content": "Atualiza um vínculo SKU-fornecedor existente. Após salvar, reinvoca `skuSupplierGet` e devolve a lista de fornecedores do produto.", "type": "text/plain" }, "url": { "path": [ "sku", "supplier", ":idsku", ":idstockkeepingunitsupliercode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsupliercode", "description": "(Required) Identificador do vínculo a atualizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSupplier\": 4528,\n \"QuantityMultiply\": 8387.538040744286,\n \"SupplierCode\": \"string\",\n \"PackageSize\": 7859,\n \"LastValueCost\": 2509.005992967912,\n \"PisAliquotInbound\": 3188.531480107304,\n \"CofinsAliquotInbound\": 2264.5551874151092\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b154149a-2356-4542-ab24-0e0cec6e896d", "name": "Fornecedores do produto após a atualização.", "originalRequest": { "url": { "path": [ "sku", "supplier", ":idsku", ":idstockkeepingunitsupliercode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsupliercode", "description": "(Required) Identificador do vínculo a atualizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSupplier\": 4528,\n \"QuantityMultiply\": 8387.538040744286,\n \"SupplierCode\": \"string\",\n \"PackageSize\": 7859,\n \"LastValueCost\": 2509.005992967912,\n \"PisAliquotInbound\": 3188.531480107304,\n \"CofinsAliquotInbound\": 2264.5551874151092\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSuplierCode\": 8289,\n \"IDSupplier\": 1961,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 6963.070245478111,\n \"PackageSize\": 1596,\n \"LastValueCost\": 7392.9526238145545,\n \"PisAliquotInbound\": 1247.2146740950918,\n \"CofinsAliquotInbound\": 8565.408446108027\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 6605,\n \"IDSupplier\": 5809,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 9397.88122840084,\n \"PackageSize\": 8012,\n \"LastValueCost\": 6278.870673823433,\n \"PisAliquotInbound\": 8119.667452817687,\n \"CofinsAliquotInbound\": 8025.9544967384345\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c6c1d1-ac5b-4fc1-95c2-cc1aa4d9e8e3", "name": "`[BadRequest] - Fornecedor SKU não existe`, `[BadRequest] - Fornecedor não existe` ou `[BadRequest] - Código e fornecedor já estão cadastrados`.", "originalRequest": { "url": { "path": [ "sku", "supplier", ":idsku", ":idstockkeepingunitsupliercode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsupliercode", "description": "(Required) Identificador do vínculo a atualizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSupplier\": 4528,\n \"QuantityMultiply\": 8387.538040744286,\n \"SupplierCode\": \"string\",\n \"PackageSize\": 7859,\n \"LastValueCost\": 2509.005992967912,\n \"PisAliquotInbound\": 3188.531480107304,\n \"CofinsAliquotInbound\": 2264.5551874151092\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c03ccf3-4cdf-47d2-b0c1-14c217a74f86", "name": "Remove vínculo de fornecedor", "request": { "name": "Remove vínculo de fornecedor", "description": { "content": "Remove o vínculo entre o produto e o fornecedor. O produto e o fornecedor continuam cadastrados. Após excluir, reinvoca `skuSupplierGet` e devolve os fornecedores restantes do produto.", "type": "text/plain" }, "url": { "path": [ "sku", "supplier", ":idsku", ":idstockkeepingunitsupliercode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsupliercode", "description": "(Required) Identificador do vínculo a remover." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "d5708878-21af-4ae6-89f1-5c017f0be53b", "name": "Fornecedores restantes do produto.", "originalRequest": { "url": { "path": [ "sku", "supplier", ":idsku", ":idstockkeepingunitsupliercode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsupliercode", "description": "(Required) Identificador do vínculo a remover." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitSuplierCode\": 8289,\n \"IDSupplier\": 1961,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 6963.070245478111,\n \"PackageSize\": 1596,\n \"LastValueCost\": 7392.9526238145545,\n \"PisAliquotInbound\": 1247.2146740950918,\n \"CofinsAliquotInbound\": 8565.408446108027\n },\n {\n \"IDStockKeepingUnitSuplierCode\": 6605,\n \"IDSupplier\": 5809,\n \"SupplierNameCorporateName\": \"string\",\n \"SupplierCode\": \"string\",\n \"QuantityMultiply\": 9397.88122840084,\n \"PackageSize\": 8012,\n \"LastValueCost\": 6278.870673823433,\n \"PisAliquotInbound\": 8119.667452817687,\n \"CofinsAliquotInbound\": 8025.9544967384345\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2ea9682-e29f-4949-928b-6f305bbcc82f", "name": "`[BadRequest] - Sku não existe`.", "originalRequest": { "url": { "path": [ "sku", "supplier", ":idsku", ":idstockkeepingunitsupliercode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) Identificador do produto (SKU)." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitsupliercode", "description": "(Required) Identificador do vínculo a remover." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "992159de-2ef6-4098-8dd6-4fca82920b62", "name": "Frente de Caixa", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0f647704-91a8-4d12-a501-30772207ea0b", "name": "Lista sessões de caixa do PDV", "request": { "name": "Lista sessões de caixa do PDV", "description": { "content": "Lista as sessões de caixa (`StoreFrontCashier`) — cada item é uma abertura/fechamento de caixa de uma das contas bancárias do tipo \"caixa do PDV\" da empresa. A listagem traz o operador (`Login`/`UserName`), o caixa (`Bank` da conta), as datas e os comentários de abertura/fechamento.\n\nO escopo é multi-empresa: respeita o contexto `accountname`/`idcompanylist` do token. Quando `accountname=[\"all\"]`, lista de todas as empresas do grupo; caso contrário, filtra pelas empresas habilitadas no token.\n\nOrdenação: data de abertura **decrescente**.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDBankAccount", "value": "2232", "description": "Filtra por conta bancária (caixa) específica." }, { "disabled": false, "key": "RecordUserCreated", "value": "2232", "description": "Filtra pelo usuário que abriu o caixa." }, { "disabled": false, "key": "IDStoreFrontCashier", "value": "2232", "description": "Filtra por identificador único da sessão de caixa." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra apenas sessões cujo banco usa este faturador." }, { "disabled": false, "key": "DateFromOpen", "value": "1980-02-08", "description": "Data inicial (inclusive) da abertura do caixa." }, { "disabled": false, "key": "DateToOpen", "value": "1980-02-08", "description": "Data final (inclusive — fim do dia) da abertura do caixa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "790b8649-af99-4f20-81ac-731bc2c478c1", "name": "Lista de sessões de caixa.", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankAccount", "value": "2232" }, { "key": "RecordUserCreated", "value": "2232" }, { "key": "IDStoreFrontCashier", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "DateFromOpen", "value": "1980-02-08" }, { "key": "DateToOpen", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 3939,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 2180,\n \"Bank\": \"string\",\n \"IDCompanyInvoice\": 5971,\n \"IDStoreFrontCashier\": 8661,\n \"RecordUserCreated\": 7059,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestampOpen\": \"1965-12-30T12:30:13.099Z\",\n \"RecordTimestampClose\": \"1987-09-28T13:37:41.542Z\",\n \"CommentsOpen\": \"string\",\n \"CommentsClose\": \"string\"\n },\n {\n \"IDCompany\": 943,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 8670,\n \"Bank\": \"string\",\n \"IDCompanyInvoice\": 1051,\n \"IDStoreFrontCashier\": 1463,\n \"RecordUserCreated\": 8897,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestampOpen\": \"1999-02-17T19:41:52.231Z\",\n \"RecordTimestampClose\": \"1994-10-22T03:54:20.318Z\",\n \"CommentsOpen\": \"string\",\n \"CommentsClose\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e8b26b9-297f-4685-9ed3-49043ad473fe", "name": "Configuração de empresa inválida (prefixo `[BadRequest]`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankAccount", "value": "2232" }, { "key": "RecordUserCreated", "value": "2232" }, { "key": "IDStoreFrontCashier", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "DateFromOpen", "value": "1980-02-08" }, { "key": "DateToOpen", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69eaf796-71f0-4376-92ef-acb642774c15", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDBankAccount", "value": "2232" }, { "key": "RecordUserCreated", "value": "2232" }, { "key": "IDStoreFrontCashier", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "DateFromOpen", "value": "1980-02-08" }, { "key": "DateToOpen", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "527df9e0-37ca-472c-94f4-1ee3e539406e", "name": "Detalhe (extrato) de uma sessão de caixa", "request": { "name": "Detalhe (extrato) de uma sessão de caixa", "description": { "content": "Retorna o **extrato completo** de uma sessão de caixa, com 3 listas agregadas:\n\n- **`OrderList[]`** — pedidos atendidos no caixa, **uma linha por recebimento** (`AccountsPayableReceivable`), com o tipo de pagamento, NSU, TID, parcelas, vendedor, cliente e o status do pedido (`IDStatusOrder` = `90` indica venda cancelada). Vem do join de `StoreFrontCashierOrder` × `AccountsPayableReceivable`.\n- **`TransactionList[]`** — lançamentos bancários (`AccountsPayableReceivableBankStatement`) gerados na sessão: sangrias, suprimentos, recebimentos baixados etc. `IDTypeAccount = 1` é débito (a tela inverte o sinal do valor) e demais valores são crédito.\n- **`PaymentSummary[]`** — soma dos recebimentos **válidos** (pedidos não cancelados) por tipo de pagamento. A lista começa com os tipos de pagamento habilitados no PDV (`EnableFrenteCaixa=1`) zerados e é incrementada conforme `OrderList` é processada.\n\nAlém disso, traz os totais agregados `TotalOrderValue` (soma de `OrderList`) e `TotalTransactionValue` (soma de `TransactionList`).", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", "history", ":idstorefrontcashier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashier", "description": "(Required) Identificador da sessão de caixa do PDV." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b918a5ed-aadf-4f46-b36b-f9a3786f91d0", "name": "Extrato da sessão (array com 1 item).", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history", ":idstorefrontcashier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashier", "description": "(Required) Identificador da sessão de caixa do PDV." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 1494,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 8878,\n \"Bank\": \"string\",\n \"IDStoreFrontCashier\": 5161,\n \"RecordUserCreated\": 7682,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestampOpen\": \"1995-05-20T15:33:45.788Z\",\n \"RecordTimestampClose\": \"1999-02-01T21:29:07.625Z\",\n \"CommentsOpen\": \"string\",\n \"CommentsClose\": \"string\",\n \"TotalOrderValue\": 7138.106703418841,\n \"TotalTransactionValue\": 8769.795260062934,\n \"OrderList\": [\n {\n \"IDOrder\": 2996,\n \"IDAccountPayableReceivable\": 7647,\n \"RecordTimestamp\": \"1998-06-02T05:54:12.575Z\",\n \"Value\": 9993.371820542732,\n \"IDTypePayment\": 8442,\n \"TypePaymentDescription\": \"string\",\n \"InstallmentTotal\": 9571,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"SalesmanLogin\": \"string\",\n \"SalesmanUsername\": \"string\",\n \"IDStatusOrder\": 1278,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n },\n {\n \"IDOrder\": 3771,\n \"IDAccountPayableReceivable\": 8624,\n \"RecordTimestamp\": \"1947-06-09T15:13:53.206Z\",\n \"Value\": 954.8853639692422,\n \"IDTypePayment\": 2584,\n \"TypePaymentDescription\": \"string\",\n \"InstallmentTotal\": 1513,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"SalesmanLogin\": \"string\",\n \"SalesmanUsername\": \"string\",\n \"IDStatusOrder\": 5834,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n }\n ],\n \"TransactionList\": [\n {\n \"DateTransactionTimestamp\": \"2019-05-14T02:39:46.550Z\",\n \"TransactionDescription\": \"string\",\n \"Value\": 6303.998937360236,\n \"IDTypeAccount\": 8519,\n \"IDAccountPayableReceivable\": 5224,\n \"IDBankStatement\": 4407,\n \"IDOrder\": 2656,\n \"IDStatusOrder\": 3359,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1956-11-06T22:07:25.529Z\",\n \"TransactionDescription\": \"string\",\n \"Value\": 7925.093218445367,\n \"IDTypeAccount\": 3559,\n \"IDAccountPayableReceivable\": 7667,\n \"IDBankStatement\": 9500,\n \"IDOrder\": 7512,\n \"IDStatusOrder\": 4660,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n }\n ],\n \"PaymentSummary\": [\n {\n \"IDTypePayment\": 1534,\n \"TypePaymentDescription\": \"string\",\n \"TotalValue\": 9377.311730244468\n },\n {\n \"IDTypePayment\": 8704,\n \"TypePaymentDescription\": \"string\",\n \"TotalValue\": 910.6425791043526\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8dc7e7c-0270-4712-b6fc-24283f44815e", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history", ":idstorefrontcashier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashier", "description": "(Required) Identificador da sessão de caixa do PDV." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38d25386-1a68-4f56-96fd-c54db849c8d5", "name": "Ajusta um recebimento da sessão de caixa", "request": { "name": "Ajusta um recebimento da sessão de caixa", "description": { "content": "Corrige os dados de um recebimento gerado dentro de uma sessão de caixa do PDV. Permite trocar o **tipo de pagamento** (`IDTypePayment`), informar/atualizar **TID** e **NSU** da maquininha e alterar a **quantidade de parcelas** (`InstallmentTotal`).\n\nRegras importantes:\n\n- O recebimento precisa estar com status conciliação **ainda aberto** — só são aceitos `IDStatusAccountPayableReceivable` ∈ `{0, 1, 6}`. Recebimentos já conciliados/baixados retornam `[BadRequest] - Recebimento já foi conciliado e não pode ser editado`.\n- `IDTypePayment` precisa pertencer à mesma empresa do recebimento (`IDCompany`).\n- O update afeta **todas as parcelas** do mesmo agrupamento `(IDOrder, IDTypePayment, IDTypeAccount, NSU, TID)` — quando há parcelamento, todas as linhas relacionadas recebem a mesma alteração.\n- Quando `InstallmentTotal` muda, o sistema **recria o parcelamento** com a nova quantidade de parcelas (apaga os recebimentos antigos e gera os novos com o valor recalculado). Quando `InstallmentTotal` permanece igual, apenas os campos enviados são gravados.\n- Cada alteração de campo (`IDTypePayment`/`TID`/`NSU`) é registrada em `AccountsPayableReceivableLog` no formato `DE: PARA: `.\n\nNa frente, o botão de edição exige a privilégio `PrivilegePointOfSaleEditTransaction` — quem não tem precisa autorizar via senha de gerente (`POST /user/{iduser}/verify`).\n\nA resposta é o extrato atualizado da sessão (mesma forma do `GET /store-front/cashier/history/{idstorefrontcashier}`).", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", "history", ":idstorefrontcashier", "adjust", ":idaccountpayablereceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashier", "description": "(Required) Identificador da sessão de caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayablereceivable", "description": "(Required) Identificador do recebimento (`AccountsPayableReceivable`) a ajustar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 7014,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"InstallmentTotal\": 3905\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d46cf9f3-c35e-4ca0-95f5-a72fbcc6e42c", "name": "Recebimento ajustado. Retorna o extrato atualizado.", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history", ":idstorefrontcashier", "adjust", ":idaccountpayablereceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashier", "description": "(Required) Identificador da sessão de caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayablereceivable", "description": "(Required) Identificador do recebimento (`AccountsPayableReceivable`) a ajustar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 7014,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"InstallmentTotal\": 3905\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 2822,\n \"AccountName\": \"string\",\n \"IDBankAccount\": 3640,\n \"Bank\": \"string\",\n \"IDStoreFrontCashier\": 4254,\n \"RecordUserCreated\": 1874,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"RecordTimestampOpen\": \"2018-10-21T07:24:46.062Z\",\n \"RecordTimestampClose\": \"1969-07-28T14:39:47.220Z\",\n \"CommentsOpen\": \"string\",\n \"CommentsClose\": \"string\",\n \"TotalOrderValue\": 571.2136245026201,\n \"TotalTransactionValue\": 5387.634392843621,\n \"OrderList\": [\n {\n \"IDOrder\": 5997,\n \"IDAccountPayableReceivable\": 30,\n \"RecordTimestamp\": \"1960-07-05T00:11:11.149Z\",\n \"Value\": 6501.7499275793525,\n \"IDTypePayment\": 1857,\n \"TypePaymentDescription\": \"string\",\n \"InstallmentTotal\": 6608,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"SalesmanLogin\": \"string\",\n \"SalesmanUsername\": \"string\",\n \"IDStatusOrder\": 4048,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n },\n {\n \"IDOrder\": 8455,\n \"IDAccountPayableReceivable\": 4785,\n \"RecordTimestamp\": \"1975-12-08T14:16:43.331Z\",\n \"Value\": 9690.309148218166,\n \"IDTypePayment\": 4135,\n \"TypePaymentDescription\": \"string\",\n \"InstallmentTotal\": 1543,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"SalesmanLogin\": \"string\",\n \"SalesmanUsername\": \"string\",\n \"IDStatusOrder\": 305,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n }\n ],\n \"TransactionList\": [\n {\n \"DateTransactionTimestamp\": \"1984-03-14T13:59:35.205Z\",\n \"TransactionDescription\": \"string\",\n \"Value\": 4672.506381388557,\n \"IDTypeAccount\": 2119,\n \"IDAccountPayableReceivable\": 9885,\n \"IDBankStatement\": 4540,\n \"IDOrder\": 5359,\n \"IDStatusOrder\": 2059,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n },\n {\n \"DateTransactionTimestamp\": \"1964-03-19T07:41:16.253Z\",\n \"TransactionDescription\": \"string\",\n \"Value\": 3568.5842683225032,\n \"IDTypeAccount\": 5339,\n \"IDAccountPayableReceivable\": 3636,\n \"IDBankStatement\": 2972,\n \"IDOrder\": 272,\n \"IDStatusOrder\": 1147,\n \"StatusOrder\": \"string\",\n \"OrderComments\": \"string\"\n }\n ],\n \"PaymentSummary\": [\n {\n \"IDTypePayment\": 8023,\n \"TypePaymentDescription\": \"string\",\n \"TotalValue\": 7113.173973587969\n },\n {\n \"IDTypePayment\": 3920,\n \"TypePaymentDescription\": \"string\",\n \"TotalValue\": 5065.473333280277\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2678cd67-5a59-40b6-a7e7-786830fdf004", "name": "Erros (prefixo `[BadRequest]`):\n- `Conta a receber não existe`\n- `Conta a receber não existe (parcelamentos)`\n- `Recebimento já foi conciliado e não pode ser editado`\n- `Tipo pagamento não existe`", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history", ":idstorefrontcashier", "adjust", ":idaccountpayablereceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashier", "description": "(Required) Identificador da sessão de caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayablereceivable", "description": "(Required) Identificador do recebimento (`AccountsPayableReceivable`) a ajustar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 7014,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"InstallmentTotal\": 3905\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37af538b-ac0f-477f-96ca-a383d3131462", "name": "Erro interno (prefixo `Error:`). Inclui falha do processo de retaguarda durante o recálculo do parcelamento.", "originalRequest": { "url": { "path": [ "store-front", "cashier", "history", ":idstorefrontcashier", "adjust", ":idaccountpayablereceivable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashier", "description": "(Required) Identificador da sessão de caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idaccountpayablereceivable", "description": "(Required) Identificador do recebimento (`AccountsPayableReceivable`) a ajustar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 7014,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"InstallmentTotal\": 3905\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90acf323-f8c5-4de0-8f93-dabe3be4a659", "name": "Inicia uma cobrança TEF ou Pix", "request": { "name": "Inicia uma cobrança TEF ou Pix", "description": { "content": "Cria o registro `StoreFrontCashierPayment` (status inicial **Pendente**) e dispara a cobrança no provedor configurado pela integração da conta bancária (`IDCompanyIntegration` → `IDTypeCompanyIntegration`).\n\n## Direcionamento por integração\n\n- **PayGo / ControlPay** (`IDTypeCompanyIntegration = 17`): manda a venda para a maquininha (TEF) com `formaPagamentoId` derivado da categoria do tipo de pagamento (`22`=crédito → `21`, `23`=débito → `22`, `24`=Pix → `24`). Exige `TefTerminal` preenchido e `Token` da integração configurado. Em sucesso de conexão, status vira **Em pagamento** (`2`). Erro de conexão em 15s vira status **Expirado** (`4`) com mensagem `Erro ao conectar ao terminal TEF...`.\n- **StarkBank** (`131`): gera um QR Code Pix dinâmico (`CreateDynamicBrcode`) com 3600s de expiração. Retorna `PixCopiaCola` (string copia-cola) e `QrCodeImageUrl`. Status vira **Em pagamento**.\n- **Pagar.me** (`13`): só suporta **Pix** (`Category = 24`). Outras categorias dão `Integração Pagarme no PDV suporta apenas Pix`. Retorna `PixCopiaCola`, `QrCodeImageUrl` e o `TID`.\n\n## Categorias de tipo de pagamento aceitas\n\nApenas tipos de pagamento com `Category` ∈ `{22 crédito, 23 débito, 24 Pix}`. Outros valores retornam `Tipo de pagamento inválido (categoria recebida: ), permitido apenas crédito, débito e Pix`.\n\n## IDOrderIntention\n\nQuando o cliente envia `IDOrderIntention` (UUID), o sistema usa esse valor para ligar a tentativa ao pedido. Quando omite, o sistema gera um UUID novo e devolve no body. Esse UUID é o que casa com `IDOrderIntention` (ligação tentativa → pedido fechado).\n\nA partir daí, o cliente deve fazer **polling** via `GET /store-front/cashier/{idbankaccount}/payment/{idstorefrontcashierpayment}` até obter `Success=1` ou um status final.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV (`IDBankAccount`) — define qual integração (PayGo/StarkBank/Pagar.me) será usada e em que terminal a venda é direcionada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 9307,\n \"Value\": 5519.277442496195,\n \"InstallmentTotal\": 1,\n \"IDOrderIntention\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8c0a0d51-78ad-4177-a304-f401ff091434", "name": "Cobrança iniciada (status retornado = `2` Em pagamento). PayGo (TEF) retorna `IDStoreFrontCashierPayment`, `IDOrderIntention`, `IDTypeStatusStoreFrontCashierPayment` e `ExternalId`. Pix (StarkBank/Pagar.me) retorna ainda `PixCopiaCola`, `QrCodeImageUrl` e `QrcodeExpirationTimeInSeconds`; Pagar.me inclui também o `TID`.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV (`IDBankAccount`) — define qual integração (PayGo/StarkBank/Pagar.me) será usada e em que terminal a venda é direcionada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 9307,\n \"Value\": 5519.277442496195,\n \"InstallmentTotal\": 1,\n \"IDOrderIntention\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"IDStoreFrontCashierPayment\": 2025,\n \"IDOrderIntention\": \"string\",\n \"IDTypeStatusStoreFrontCashierPayment\": 2,\n \"ExternalId\": \"string\",\n \"PixCopiaCola\": \"string\",\n \"QrCodeImageUrl\": \"http://YmFMbZhRKHRfxXBmmkyEyIVd.qnqpnQ4sfmjrFSfvypPo+dBJdhEmiPMzJBmYWTxvIxbEs1G3FJ\",\n \"QrcodeExpirationTimeInSeconds\": 7669,\n \"TID\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9afcd12e-c698-451d-b48f-e0b06367ccd4", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Necessário enviar dados para cobrança`\n- `Precisa enviar o valor, conta bancária e código do tipo de pagamento`\n- `Conta bancária não localizada`\n- `Conta bancária não tem integração selecionada`\n- `Conta bancária não tem integração configurada`\n- `Tipo pagamento não encontrado`\n- `Tipo de pagamento inválido (categoria recebida: ), permitido apenas crédito, débito e Pix`\n- `Conta bancária não tem terminal TEF preenchido` (PayGo)\n- `Token integração TEF não esta preenchido` (PayGo)\n- `Erro ao conectar ao terminal TEF. Verificar conexão da máquininha (PIN PAD) com computador, internet e aplicativo paygo` (PayGo, status 15)\n- `Integração Pagarme no PDV suporta apenas Pix` (Pagar.me, categoria ≠ 24)\n- `Integração não suportada para este fluxo de pagamento`\n- `` (quando o provedor recusa a cobrança)", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV (`IDBankAccount`) — define qual integração (PayGo/StarkBank/Pagar.me) será usada e em que terminal a venda é direcionada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 9307,\n \"Value\": 5519.277442496195,\n \"InstallmentTotal\": 1,\n \"IDOrderIntention\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70cf5c1-a5c6-436f-bbbb-2afa22d4c0fd", "name": "Erro interno inesperado (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV (`IDBankAccount`) — define qual integração (PayGo/StarkBank/Pagar.me) será usada e em que terminal a venda é direcionada." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypePayment\": 9307,\n \"Value\": 5519.277442496195,\n \"InstallmentTotal\": 1,\n \"IDOrderIntention\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2d76ca7-f90d-4996-8eed-8c296004fb09", "name": "Consulta status de uma transação TEF/Pix (polling)", "request": { "name": "Consulta status de uma transação TEF/Pix (polling)", "description": { "content": "Faz **polling síncrono no adquirente** dentro de um loop limitado a **60 tentativas** (1s entre elas) — quando esgota, retorna **HTTP 504** sem corpo. Por isso a chamada deve ser feita com **timeout client-side ≥ 60s** (a frente usa 180s).\n\n## Por integração\n\n- **PayGo / ControlPay**: consulta `IntencaoVenda/GetByFiltros` a cada segundo. Extrai do retorno o último `pagamentosExternos` (sempre o mais recente) e popula:\n - `IDTypeStatusStoreFrontCashierPayment` ← mapeamento de `intencaoVendaStatus.id` via `ExternalId`.\n - `TID` ← `nsuTid`, `AuthId` ← `autorizacao`, `Acquirer` ← `adquirente`, `PaymentSystemName` ← `bandeira` (Visa, Master etc.).\n - `ReturnCode` ← `codigoRespostaAdquirente`, `ReturnMessage` ← `mensagemRespostaAdquirente`.\n - `Receipt` (via estabelecimento) e `ReceiptBuyer` (via cliente) ← extraídos do `respostaAdquirente` (texto ZPL bruto entre `PWINFO_RCPTMERCH =` e `PWINFO_RCPTCHOLDER`/etc).\n - `CardLastDigits` ← últimos 4 dígitos do PAN extraído da string `CARTAO:` ou `PWINFO_CARDPARCPAN`.\n- **StarkBank**: chama `CheckPaymentByTag(ExternalId)` a cada segundo. Quando `paid === true`, status vira **Creditado** (`3`) com `Success=1`. Retorno inclui `PixCopiaCola`, `QrCodeImageUrl`, `QrcodeExpirationTimeInSeconds`.\n- **Pagar.me**: chama `GetPix(IDCompanyIntegration, ExternalId)` a cada segundo. `IDStatusBankSlip=2` → **Creditado**; `IDStatusBankSlip=4` → **Cancelado**; demais → continua **Em pagamento**.\n\n## Sucesso vs. falha\n\nO endpoint retorna **`Success`** no corpo para o cliente decidir o que fazer:\n\n- `Success=1` → transação finalizada com sucesso (Creditado ou Cancelado bem sucedido).\n- `Success=0` → falha (Expirado, Pagamento recusado, ou caso especial PayGo `codigoRespostaExecTransac=-2596` ou `idPagamento` vazio com status `15`).\n\nAo final do polling (sucesso ou falha definitiva), o sistema grava a atualização final em `StoreFrontCashierPayment` via `StoreFrontPaymentUpdate`. Se o loop esgotar sem decisão, retorna HTTP 504 e o cliente deve fazer nova chamada.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment", ":idstorefrontcashierpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierpayment", "description": "(Required) Identificador da transação criada em `POST /store-front/cashier/{idbankaccount}/payment`." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1eecd534-4e98-49e2-a27d-67557a0e73c1", "name": "Status retornado. Sempre inclui o status (`IDTypeStatusStoreFrontCashierPayment` + `TypeStatusStoreFrontCashierPayment`) e `Success` (0/1).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment", ":idstorefrontcashierpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierpayment", "description": "(Required) Identificador da transação criada em `POST /store-front/cashier/{idbankaccount}/payment`." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"IDStoreFrontCashierPayment\": 5982,\n \"IDTypeStatusStoreFrontCashierPayment\": 2,\n \"TypeStatusStoreFrontCashierPayment\": \"string\",\n \"Success\": 1,\n \"TID\": \"string\",\n \"AuthId\": \"string\",\n \"Acquirer\": \"string\",\n \"PaymentSystemName\": \"string\",\n \"ReturnCode\": \"string\",\n \"ReturnMessage\": \"string\",\n \"CardLastDigits\": \"string\",\n \"Receipt\": \"string\",\n \"ReceiptBuyer\": \"string\",\n \"ExternalId\": \"string\",\n \"PixCopiaCola\": \"string\",\n \"QrCodeImageUrl\": \"https://QjVCYftwINcvRZEmPd.mdqcNzdhcQEs-PXGpGSvlxyNkHEWh8JE4fYxRuBmqkLp,wMwhllxLsp8HK7rTk.08yZRTCojwRWSuu\",\n \"QrcodeExpirationTimeInSeconds\": 2417\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "407c4ece-e311-4a57-ac0c-fcf6d6043f55", "name": "Erros de validação:\n- `Transação não localizada idw`\n- `Transação não localizada controlpay` (PayGo)\n- `Transação divergente (referência controlpay: , esperado: )`\n- `Integração não suportada para este fluxo de pagamento`", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment", ":idstorefrontcashierpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierpayment", "description": "(Required) Identificador da transação criada em `POST /store-front/cashier/{idbankaccount}/payment`." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1ac7723-3231-43e4-bf6d-2420a920ce93", "name": "Timeout do polling — 60 tentativas esgotadas sem resultado final. Cliente deve repetir a chamada.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment", ":idstorefrontcashierpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierpayment", "description": "(Required) Identificador da transação criada em `POST /store-front/cashier/{idbankaccount}/payment`." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7deea046-7166-4eae-96f5-91c12438c42c", "name": "Cancela uma transação TEF/Pix", "request": { "name": "Cancela uma transação TEF/Pix", "description": { "content": "Cancela uma transação **autorizada** (status `3` Creditado) ou **em cancelamento** (status `6`). Outros status retornam `Transação não esta aprovada. O cancelamento é permitido apenas em transações autorizadas`.\n\n## Por integração\n\n- **PayGo / ControlPay**: chama `Venda/CancelarVenda` com `senhaTecnica` (senha técnica do TEF, passada via query `TEFPassword`). **Obrigatória** — se omitida, retorna `Precisa informar a senha do TEF para cancelamento (TEFPassword)`. Em sucesso de conexão, status vira **Em cancelamento** (`6`); cliente deve fazer polling via `GET` até o status final virar **Cancelado** (`7`). Erro de conexão → mensagem `Erro ao conectar ao terminal TEF...`.\n- **StarkBank**: retorna direto `Não é possível cancelar uma cobrança Pix. O QR Code apenas expira após o tempo configurado.` — Pix Stark Bank **não é cancelável** (só expira).\n- **Pagar.me**: chama `CancelPix(IDCompanyIntegration, ExternalId)`. Status vira **Cancelado** (`7`) com `RecordTimestampCancel` e `IDUserCancel` preenchidos.\n\nEm todos os casos com sucesso de conexão, grava `RecordTimestampCancel` (data/hora atual) e `IDUserCancel` (usuário que iniciou o cancelamento, vindo do token via `LAMBDA_REQUEST_CONTEXT.authorizer.User`).\n\nA frente de cancelamento da tela faz polling do `GET` por até 180 segundos com intervalo de 2s entre tentativas, mostrando \"Aguarde ou digite o número do cartão...\" enquanto espera o cliente operar a maquininha.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment", ":idstorefrontcashierpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "TEFPassword", "value": "string", "description": "Senha técnica do TEF (PayGo). Obrigatória para integração ControlPay; ignorada para StarkBank (não suporta) e opcional para Pagar.me." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierpayment", "description": "(Required) Identificador da transação criada em `POST /store-front/cashier/{idbankaccount}/payment`." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "627f3eff-b9a2-4132-a891-69e1c8b43d31", "name": "Cancelamento solicitado. Para PayGo retorna o `StoreFrontCashierPayment` com status atualizado para Em cancelamento (`6`) — cliente deve fazer polling via `GET`. Para Pagar.me retorna com status Cancelado (`7`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment", ":idstorefrontcashierpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "TEFPassword", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierpayment", "description": "(Required) Identificador da transação criada em `POST /store-front/cashier/{idbankaccount}/payment`." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"IDStoreFrontCashierPayment\": 8477,\n \"IDCompany\": 9031,\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 4441,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDBankAccount\": 1878,\n \"Bank\": \"string\",\n \"IDCompanyIntegration\": 7342,\n \"IDTypePayment\": 2756,\n \"TypePaymentDescription\": \"string\",\n \"RecordTimestamp\": \"1969-02-12T08:00:04.631Z\",\n \"RecordTimestampCancel\": \"1966-05-25T21:36:32.767Z\",\n \"IDUserCancel\": 2051,\n \"Value\": 928.3461435009599,\n \"InstallmentTotal\": 9781,\n \"IDOrderIntention\": \"string\",\n \"IDOrder\": 175,\n \"IDTypeStatusStoreFrontCashierPayment\": 5,\n \"TypeStatusStoreFrontCashierPayment\": \"string\",\n \"TefTerminal\": \"string\",\n \"TID\": \"string\",\n \"AuthId\": \"string\",\n \"Acquirer\": \"string\",\n \"PaymentSystemName\": \"string\",\n \"ReturnCode\": \"string\",\n \"ReturnMessage\": \"string\",\n \"CardLastDigits\": \"string\",\n \"Receipt\": \"string\",\n \"ReceiptBuyer\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ca898d-c8bb-4eb5-a7a7-090ca907c441", "name": "Erros:\n- `Transação não localizada`\n- `Transação não esta aprovada. O cancelamento é permitido apenas em transações autorizadas`\n- `Conta bancária não tem integração selecionada`\n- `Precisa informar a senha do TEF para cancelamento (TEFPassword)` (PayGo)\n- `Token integração TEF não está preenchido` (PayGo)\n- `Erro ao conectar ao terminal TEF...` (PayGo, status 15)\n- `Não é possível cancelar uma cobrança Pix. O QR Code apenas expira após o tempo configurado.` (StarkBank)\n- `Transação Pagarme sem ExternalId, não é possível cancelar`\n- `Integração da conta bancária não suportada para cancelamento`", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "payment", ":idstorefrontcashierpayment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "TEFPassword", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierpayment", "description": "(Required) Identificador da transação criada em `POST /store-front/cashier/{idbankaccount}/payment`." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df5ce378-952d-44a5-bede-97ad0fba690a", "name": "Lista os caixas (caixinhas) do PDV", "request": { "name": "Lista os caixas (caixinhas) do PDV", "description": { "content": "Lista todos os **caixas do PDV** (`BankAccount` com `BankNumber = '000'`, status ativo) da(s) empresa(s) do contexto. Cada item traz o **status** derivado (Aberto/Fechado), o **operador** logado (quando aberto), o **saldo** corrente do caixa (`Balance` = soma de todos os lançamentos em `AccountsPayableReceivableBankStatement` até agora) e o faturador (`IDCompanyInvoice`) que será usado na NFC-e.\n\nO escopo é multi-empresa: respeita `accountname`/`idcompanylist` do token. Quando `accountname=[\"all\"]`, lista todos os caixas do grupo.\n\nO front da Frente de Caixa filtra ainda na própria tela: mostra primeiro os caixas **abertos pelo usuário corrente** (oferecendo \"Retomar Caixa\"), em seguida os caixas **fechados** disponíveis, e bloqueia os caixas **abertos por outro usuário**.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra caixas cujo faturador é esta empresa. Usado pela tela de abertura para mostrar só os caixas da empresa selecionada." }, { "disabled": false, "key": "StoreFrontCashierStatus", "value": "1", "description": "Filtra pelo status: `1`=Fechado (sem sessão aberta), `2`=Aberto (com sessão ativa)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8d5a5c25-9287-4045-ae77-af1d4bab299f", "name": "Lista de caixas.", "originalRequest": { "url": { "path": [ "store-front", "cashier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "StoreFrontCashierStatus", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankAccount\": 2930,\n \"Bank\": \"string\",\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 4950,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyCpfCnpjInvoice\": \"string\",\n \"IDCompanyIntegration\": 9904,\n \"StoreFrontCashierStatus\": 2,\n \"StoreFrontCashierStatusDescription\": \"Fechado\",\n \"IDStoreFrontCashier\": 8,\n \"RecordTimestampOpen\": \"1974-05-31T02:14:04.580Z\",\n \"Login\": \"string\",\n \"Balance\": 7680.373227836397\n },\n {\n \"IDBankAccount\": 4306,\n \"Bank\": \"string\",\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 6556,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyCpfCnpjInvoice\": \"string\",\n \"IDCompanyIntegration\": 3790,\n \"StoreFrontCashierStatus\": 1,\n \"StoreFrontCashierStatusDescription\": \"Aberto\",\n \"IDStoreFrontCashier\": 5838,\n \"RecordTimestampOpen\": \"2019-06-25T03:19:14.543Z\",\n \"Login\": \"string\",\n \"Balance\": 129.47960594421826\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55225f08-9d9d-468c-bce0-f50e741dbe1e", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "StoreFrontCashierStatus", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ead2ef2-7d85-4dcd-a09e-30c6e06a10e1", "name": "Snapshot do caixa aberto (resumo financeiro + ZPL)", "request": { "name": "Snapshot do caixa aberto (resumo financeiro + ZPL)", "description": { "content": "Retorna o **caixa aberto** com cálculos financeiros completos da sessão atual + **dois recibos ZPL** prontos para impressão (usados no fechamento e na conferência diária).\n\n## Campos calculados\n\n- **`Balance`** — saldo atual do caixa (soma de todos os créditos menos débitos em `AccountsPayableReceivableBankStatement` até agora).\n- **`Income`** — soma de **créditos** desde a abertura do caixa (`IDTypeAccount=0`) **menos** o que foi pago em dinheiro nos pedidos (porque o dinheiro do cliente já entrou pela venda; evita contagem dupla).\n- **`Outcome`** — soma de **débitos** desde a abertura.\n- **`AdjustIn`** — reforços (créditos sem `IDAccountPayableReceivable` vinculado).\n- **`AdjustOut`** — sangrias (débitos sem `IDAccountPayableReceivable` vinculado).\n- **`TotalValueCancelled`** — diferença entre `Income` original e a soma dos pagamentos em dinheiro (usada para conciliar quando há vendas canceladas).\n- **`PaymentSummary`** — vendas da sessão agrupadas por **tipo de pagamento** (com descrição), incluindo os tipos zerados habilitados para PDV (`EnableFrenteCaixa=1`).\n- **`PaymentCategorySummary`** — vendas agrupadas por **categoria** de pagamento (Crédito, Débito, Dinheiro, Pix etc.).\n- **`InvoiceSummary`** — vendas agrupadas por modelo de NF emitida (`NfeModelo` = 55 NFe, 65 NFCe, ou null para pendentes).\n\n## Recibos ZPL\n\n- **`ReceiptBase64Encode`** — \"Fechamento de caixa\" para conferência (Saldo Anterior + Total Vendas por tipo + Reforço + Sangria + Saldo Final).\n- **`ReceiptFiscalBase64Encode`** — \"Resumo Fiscal\" (Total NFCe, Total NFe, Pendentes + quantidade de cada).\n\nAmbos os ZPL vêm codificados em **base64 + cp850** (encoding necessário para a maioria das impressoras térmicas Bematech/Daruma/Epson). Use o `PrintService` (com QzTray) para enviá-los para a impressora padrão (`LabelReceiptDefaultPrinter`).\n\n## Quando o caixa está fechado\n\nMesmo com o caixa fechado, o endpoint retorna o `BankAccount` com `Balance` corrente — apenas os campos da sessão (`RecordTimestampOpen`, `Income`, `Outcome`, etc.) vêm vazios.\n\n## Tipo de pedido padrão\n\nQuando a `IDTypeOrder` está nula, o sistema busca o **tipo de pedido marcado como padrão para Frente de Caixa** (`DefaultFrenteCaixa=1`). Se também não houver, retorna `[BadRequest] - Não existe tipo de pedido padrão para frente de caixa`.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9e3b1009-36be-4d12-b78b-c09af823df15", "name": "Snapshot do caixa.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBankAccount\": 9701,\n \"IDCompany\": 9004,\n \"BankNumber\": \"000\",\n \"IDStoreFrontCashier\": 8290,\n \"RecordTimestampOpen\": \"2006-05-02T10:18:22.317Z\",\n \"RecordUserCreated\": 1020,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"IDTypeOrder\": 8281,\n \"TypeOrder\": \"string\",\n \"IDCompanySalesPolicy\": 2074,\n \"CompanySalesPolicy\": \"string\",\n \"CompanyCpfCnpjInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"IDOrderStoreFrontCashierOrderList\": \"string\",\n \"Balance\": 3773.225630553263,\n \"Income\": 1038.4704128471212,\n \"Outcome\": 9326.048683489178,\n \"AdjustIn\": 9806.711381287214,\n \"AdjustOut\": 7649.239897673372,\n \"TotalValueCancelled\": 4441.0119787375215,\n \"PaymentSummary\": [\n {\n \"IDTypePayment\": 6564,\n \"TypePaymentDescription\": \"string\",\n \"Category\": 9074,\n \"TypePaymentCategory\": \"string\",\n \"EnableFrenteCaixa\": 0,\n \"TotalValue\": 1264.85432878765\n },\n {\n \"IDTypePayment\": 7617,\n \"TypePaymentDescription\": \"string\",\n \"Category\": 2498,\n \"TypePaymentCategory\": \"string\",\n \"EnableFrenteCaixa\": 1,\n \"TotalValue\": 8412.89122025501\n }\n ],\n \"PaymentCategorySummary\": [\n {\n \"Category\": 9040,\n \"TypePaymentCategory\": \"string\",\n \"EnableFrenteCaixa\": 1,\n \"TotalValue\": 2859.9820765586646\n },\n {\n \"Category\": 4539,\n \"TypePaymentCategory\": \"string\",\n \"EnableFrenteCaixa\": 0,\n \"TotalValue\": 9115.387182698225\n }\n ],\n \"InvoiceSummary\": [\n {\n \"NfeModelo\": 55,\n \"TotalValue\": 6130.733497715619,\n \"Count\": 8756\n },\n {\n \"NfeModelo\": null,\n \"TotalValue\": 6696.782259731733,\n \"Count\": 1795\n }\n ],\n \"ReceiptBase64Encode\": \"string\",\n \"ReceiptFiscalBase64Encode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a1ddde-0dae-4c99-9a76-485bdb5b4942", "name": "Erros (prefixo `[BadRequest]`):\n- `Caixa não existe`\n- `Não existe tipo de pedido padrão para frente de caixa`", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95523ed9-6bfd-4d78-b887-3edb3985f630", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ca197ae-0455-4072-9694-1264078085b5", "name": "Abre o caixa do PDV", "request": { "name": "Abre o caixa do PDV", "description": { "content": "Abre uma **nova sessão** de caixa ou **retoma** a sessão atual quando o caixa já está aberto pelo mesmo usuário.\n\n## Pré-condições\n\n1. **Controle de concorrência** (10 segundos) por conta bancária — evita abertura concorrente do mesmo caixa.\n2. **A conta precisa ser uma caixinha do PDV** — se não for, retorna `Banco informado não é do tipo Caixinha`.\n3. **Tipo de pedido padrão** — precisa estar configurado no cadastro da conta.\n4. **Caixa não pode estar aberto por outro usuário** — se estiver, retorna `Caixa já está aberto e precisa fechar antes de abrir novamente`. Se for o **mesmo usuário**, a chamada é **idempotente**: retoma a sessão existente sem criar nova.\n5. **Usuário não pode ter outro caixa aberto** — se tiver, retorna `Usuário já possui outro caixa aberto`.\n6. **Senha** — conferida contra a senha cadastrada do usuário. Senha errada → `Senha incorreta`. Usuário sem senha → `Usuário não tem senha cadastrada`.\n\n## Validações condicionais\n\nQuando a parametrização **Checar configuração na abertura do caixa** está ativa, o sistema **valida as configurações fiscais** antes de abrir:\n\n- Número, série, CSC e ID do CSC da NFC-e preenchidos no cadastro da empresa.\n- Existe ao menos uma regra fiscal habilitada para emissão de NFC-e.\n- Essa regra tem ao menos uma configuração de ICMS para consumidor final.\n- Existe ao menos um tipo de pagamento ativo e habilitado na frente de caixa.\n\nFalha em qualquer uma delas devolve a mensagem específica (`Precisa preencher o número da última NFCe...`, `Não existe nenhuma regra fiscal para emissão de NFCe...`, etc.).\n\n## Efeitos\n\n- Cria a sessão de caixa (ou reutiliza a existente, em caso de retomada).\n- Quando `InitialBalance` difere do saldo atual em mais de R$ 0,01, gera um lançamento de ajuste com a descrição **\"Ajuste abertura de caixa\"** (crédito se positivo, débito se negativo) — registra a divergência declarada pelo operador.\n- Grava `Comments` no histórico da sessão de caixa quando preenchido.\n\n## Resposta\n\nRetorna o caixa aberto com o **contexto operacional** (identificador da sessão, data/hora de abertura, login, tipo de pedido, política comercial, armazém, faturador e o indicador de emissão de NFC-e) — tudo o que a tela do PDV precisa para iniciar.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV a abrir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"InitialBalance\": 9450.699458581852,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f9cf743d-de3b-4a16-a75f-fa79b2a435f0", "name": "Caixa aberto (ou retomado). A resposta inclui o contexto operacional para inicializar o PDV. Existe um caminho residual em que o caixa é aberto mas a busca do contexto operacional não devolve linha — nesse caso o corpo é a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV a abrir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"InitialBalance\": 9450.699458581852,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStoreFrontCashier\": 8106,\n \"IDBankAccount\": 9305,\n \"IDCompany\": 9732,\n \"IDCompanyInvoice\": 3834,\n \"BankNumber\": \"string\",\n \"RecordTimestampOpen\": \"1985-10-05T20:35:09.949Z\",\n \"RecordUserCreated\": 4271,\n \"Login\": \"string\",\n \"UserName\": \"string\",\n \"IDTypeOrder\": 231,\n \"TypeOrder\": \"string\",\n \"IDCompanySalesPolicy\": 5199,\n \"CompanySalesPolicy\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 1048,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 1612,\n \"IssueNFCe\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e36c162e-4749-4e48-a1ad-fbceb4aaf25f", "name": "Erros (prefixo `[BadRequest]`):\n- `Caixa já está em processo de abertura` (controle de concorrência)\n- `Caixa não existe`\n- `Banco informado não é do tipo Caixinha`\n- `Banco informado não tem tipo de pedido padrão cadastrado`\n- `Caixa já está aberto e precisa fechar antes de abrir novamente`\n- `Usuário não localizado`\n- `Usuário não tem senha cadastrada`\n- `Senha incorreta`\n- `Usuário já possui outro caixa aberto`\n- `Erro ao abrir caixa. Verificar se o mesmo já está aberto`\n- `Não existe tipo de pedido padrão para frente de caixa`\n- Validações fiscais (com `CheckConfigCashierOpen=1`): `Precisa preencher o número da última NFCe dentro do cadastro da empresa`, `Precisa preencher a série da NFCe dentro do cadastro da empresa`, `Precisa preencher ID CSC da NFCe dentro do cadastro da empresa`, `Precisa preencher código de contribuinte da NFCe dentro do cadastro da empresa`, `Não existe nenhuma regra fiscal para emissão de NFCe. Acessar o dpto fiscal e configurar`, `Não existe nenhuma configuração de ICMS na regra fiscal para consumidor final`, `Não existe tipo de pagamento configurado para frente de caixa`", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV a abrir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"InitialBalance\": 9450.699458581852,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b62a42f-beca-4986-a9b8-7479d4bc0f6d", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa do PDV a abrir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"InitialBalance\": 9450.699458581852,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "23dab643-b1d9-4d78-937a-210b758eb0e7", "name": "Fecha o caixa do PDV", "request": { "name": "Fecha o caixa do PDV", "description": { "content": "Fecha a sessão atual do caixa, registrando a data e a hora do fechamento.\n\n## Validações\n\n- Caixa precisa estar **aberto** — se não, retorna `Caixa não está aberto e precisa abrir antes de fechar`.\n- **Senha** do operador autenticado, conferida contra a senha cadastrada do usuário — `Senha incorreta` quando não confere.\n- O operador precisa estar ativo e vinculado à empresa (`Usuário não localizado` quando não confere).\n\n## Efeitos\n\n- Se `FinalBalance` difere em mais de R$ 0,01 do saldo apurado da conta, gera um lançamento no extrato bancário com a descrição **\"Ajuste fechamento de caixa\"** — entrada quando o operador contou a mais, saída quando contou a menos. É assim que fica registrada a divergência apurada na conferência física (\"contei R$ 850 mas o sistema dizia R$ 870\").\n- Grava `Comments` no histórico da sessão de caixa quando preenchido.\n\nNa tela do PDV o encerramento fica bloqueado enquanto houver pedido em montagem ou transação de cartão em aberto, e o campo de observações passa a ser exigido quando há divergência de saldo — a API em si não impõe nenhuma das duas regras.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa a fechar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"FinalBalance\": 4172.629829861121,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0bc9f9b8-05af-403e-9856-d031d161964d", "name": "Caixa fechado. Resposta: string `Sucesso`.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa a fechar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"FinalBalance\": 4172.629829861121,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b33775f5-9f59-4bd9-ba18-172b4dfefd0a", "name": "Erros (prefixo `[BadRequest]`):\n- `Caixa não existe`\n- `Caixa não está aberto e precisa abrir antes de fechar`\n- `Usuário não localizado`\n- `Usuário não tem senha cadastrada`\n- `Senha incorreta`", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa a fechar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"FinalBalance\": 4172.629829861121,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88ef7f57-f924-45a4-85d8-4e03fdae1afd", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "close" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa a fechar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Password\": \"string\",\n \"FinalBalance\": 4172.629829861121,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3018931e-e118-4d27-88c7-ebd4d814cfd9", "name": "Sangria ou reforço de caixa", "request": { "name": "Sangria ou reforço de caixa", "description": { "content": "Registra uma **sangria** (saída de dinheiro do caixa para o cofre/banco, `Type=2`) ou **reforço** (entrada de dinheiro no caixa, geralmente troco, `Type=1`).\n\n## Validações\n\n- Caixa precisa estar **aberto** — `Caixa não esta aberto e não pode ter sangria/reforço` caso contrário.\n- Senha do usuário conferida contra a senha cadastrada.\n- **Sangria não pode ultrapassar o saldo** — se `Balance - Value < 0`, retorna `Sangria não pode ser realizada, pois valor é maior que disponível`.\n- Campo `Type` é **obrigatório** — se omitido, retorna `Precisa informar o Type (1 - reforço, 2 - sangria)`.\n\n## Efeitos\n\nCria um lançamento no extrato bancário da conta, vinculado à sessão de caixa atual: entrada no caso de reforço, saída no caso de sangria. A descrição do lançamento fica como **\"Reforço: \"** ou **\"Sangria: \"**.\n\n## Recibo ZPL\n\nA resposta inclui um **recibo ZPL** (`ReceiptBase64Encode`, base64 + cp850) com cabeçalho da empresa, operador, tipo (REFORÇO/SANGRIA), valor formatado em R$, data/hora, caixa e observações. O recibo tem espaço para assinatura do responsável e é impresso automaticamente pelo PDV (geralmente em 2 vias — uma fica com o operador, outra com quem recebeu o dinheiro retirado).", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Type\": 1,\n \"Value\": 5801.952044410073,\n \"Password\": \"string\",\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0b54225-956a-4369-bab7-24f76aa2a38a", "name": "Sangria/reforço registrado. Retorna o ZPL do recibo.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": 1,\n \"Value\": 5801.952044410073,\n \"Password\": \"string\",\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ReceiptBase64Encode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc9f13d1-7190-4141-86c5-9afb6e6f7afe", "name": "Erros (prefixo `[BadRequest]`):\n- `Precisa informar o Type (1 - reforço, 2 - sangria)`\n- `Caixa não existe`\n- `Caixa não esta aberto e não pode ter sangria/reforço`\n- `Sangria não pode ser realizada, pois valor é maior que disponível`\n- `Usuário não localizado`\n- `Usuário não tem senha cadastrada`\n- `Senha incorreta`", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": 1,\n \"Value\": 5801.952044410073,\n \"Password\": \"string\",\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24106e60-9821-4aad-baee-fe120fc3a926", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "adjust" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Type\": 1,\n \"Value\": 5801.952044410073,\n \"Password\": \"string\",\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88ac3c79-9b77-4511-9c25-4572a06ad596", "name": "Lista rascunhos de pedido do caixa", "request": { "name": "Lista rascunhos de pedido do caixa", "description": { "content": "Lista os **rascunhos de pedido** (`StoreFrontCashierOrderTemp`) salvos no caixa. Esses rascunhos são **gerados automaticamente** pelo motor de promoções `POST /sku/promotion/order/validate` a cada alteração do carrinho — funcionam como um \"backup\" do estado do PDV para permitir **retomar uma venda interrompida** em outro terminal.\n\nCada item tem o `OrderData` (JSON parseado) com a estrutura completa do carrinho: itens, cliente, pagamentos, tipo de pedido, política comercial, vendedor, etc. Quando o rascunho ainda não tem estado de carrinho persistido (rascunho vazio), `OrderData` vem `null`.\n\nA tela usa esses rascunhos no menu **Rascunho de Pedido** — o operador pode escolher um rascunho e o sistema **restaura todo o estado** da venda.", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "order-temp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1b62af2c-612b-4a16-ac85-d90594802a30", "name": "Lista de rascunhos com `OrderData` em JSON parseado.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "order-temp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStoreFrontCashierOrderTemp\": 3013,\n \"IDBankAccount\": 5223,\n \"OrderData\": {\n \"key_0\": true,\n \"key_1\": 9432\n },\n \"RecordTimestamp\": \"1966-09-24T09:53:48.645Z\"\n },\n {\n \"IDStoreFrontCashierOrderTemp\": 4914,\n \"IDBankAccount\": 3991,\n \"OrderData\": {\n \"key_0\": false,\n \"key_1\": 5471.106726955905\n },\n \"RecordTimestamp\": \"2017-08-13T22:05:33.902Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7315b7b5-e21d-4ae9-b556-4f4fa9b1c217", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "order-temp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "736599ea-91cb-4725-b409-cd0b68a6d11f", "name": "Apaga um rascunho de pedido", "request": { "name": "Apaga um rascunho de pedido", "description": { "content": "Remove fisicamente o rascunho de venda. Usado pelo PDV quando o operador descarta uma venda ou quando o pedido é efetivamente finalizado (`POST /orders`).", "type": "text/plain" }, "url": { "path": [ "store-front", "cashier", ":idbankaccount", "order-temp", ":idstorefrontcashierordertemp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierordertemp", "description": "(Required) Identificador do rascunho." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c785e354-e2b3-442d-97ec-e09384f86258", "name": "Rascunho removido. Resposta: string `sucesso`.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "order-temp", ":idstorefrontcashierordertemp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierordertemp", "description": "(Required) Identificador do rascunho." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e686ca30-7474-46bb-826a-af398367404f", "name": "Rascunho não encontrado. Mensagem: `[BadRequest] - Rascunho pedido não encontrado`.", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "order-temp", ":idstorefrontcashierordertemp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierordertemp", "description": "(Required) Identificador do rascunho." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a224f8de-d90f-4345-b3b9-440c797b4da6", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "store-front", "cashier", ":idbankaccount", "order-temp", ":idstorefrontcashierordertemp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbankaccount", "description": "(Required) Conta bancária do caixa." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstorefrontcashierordertemp", "description": "(Required) Identificador do rascunho." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "08d843f5-eae9-4296-ac0f-2f9e46c0322d", "name": "Grupos de SKU", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "948a589e-55f7-4a91-9b73-1bdc155fb379", "name": "Lista grupos SKU", "request": { "name": "Lista grupos SKU", "description": { "content": "Lista os grupos da empresa, ordenados por nome (`SkuGroupName ASC`), paginados em blocos de 10000. Em contexto multi-conta (`accountname = all`), traz todas as contas acessíveis.", "type": "text/plain" }, "url": { "path": [ "sku", "group" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "SkuGroupName", "value": "string", "description": "Filtra pelo nome do grupo (igualdade)." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca parcial (`LIKE`) no nome do grupo." }, { "disabled": false, "key": "IDStockKeepingUnitGroup", "value": "string", "description": "Filtra pelo id do grupo." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Página (offset = `Page * 10000`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f0c9a1ce-20ae-4800-91e2-0d904c506c47", "name": "Lista de grupos.", "originalRequest": { "url": { "path": [ "sku", "group" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SkuGroupName", "value": "string" }, { "key": "Search", "value": "string" }, { "key": "IDStockKeepingUnitGroup", "value": "string" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitGroup\": 4162,\n \"IDCompany\": 8075,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1984-08-08T07:14:04.050Z\"\n },\n {\n \"IDStockKeepingUnitGroup\": 1393,\n \"IDCompany\": 4289,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"2016-07-20T04:08:14.945Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31a42b5f-c7a6-4d7e-8dfa-d8b05df8dc0a", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "group" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "SkuGroupName", "value": "string" }, { "key": "Search", "value": "string" }, { "key": "IDStockKeepingUnitGroup", "value": "string" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ce8fa45-7fa9-4e07-8b39-74f56bb47f22", "name": "Cria grupo SKU", "request": { "name": "Cria grupo SKU", "description": { "content": "Cria um grupo para a empresa autenticada. Após inserir, reinvoca `skuGroupList` e devolve o grupo criado (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "sku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f9a039e6-72e0-45ae-9672-64d9a00a3cbc", "name": "Grupo criado (devolve o grupo em formato de lista).", "originalRequest": { "url": { "path": [ "sku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitGroup\": 4162,\n \"IDCompany\": 8075,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1984-08-08T07:14:04.050Z\"\n },\n {\n \"IDStockKeepingUnitGroup\": 1393,\n \"IDCompany\": 4289,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"2016-07-20T04:08:14.945Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ac36a11-d221-4d71-94f9-b22d0a644993", "name": "`[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "sku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d180e5d-771d-4646-b865-4f044d52c919", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10771581-0804-4af4-b601-4a91cdf802cd", "name": "Atualiza grupo SKU", "request": { "name": "Atualiza grupo SKU", "description": { "content": "Renomeia um grupo da empresa autenticada. Após atualizar, reinvoca `skuGroupList` e devolve o grupo atualizado (em formato de lista).", "type": "text/plain" }, "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e3610e8b-a1cb-42d0-ad34-be47b89c0eed", "name": "Grupo atualizado (em formato de lista).", "originalRequest": { "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitGroup\": 4162,\n \"IDCompany\": 8075,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1984-08-08T07:14:04.050Z\"\n },\n {\n \"IDStockKeepingUnitGroup\": 1393,\n \"IDCompany\": 4289,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"2016-07-20T04:08:14.945Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "735f9d87-9f6d-46e9-a838-c1d1f4110273", "name": "`[BadRequest] - Grupo não existe`.", "originalRequest": { "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de3bd1a0-1e55-4064-8f5b-ef2f7212e23f", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"SkuGroupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c83ceb7-2852-4958-b0db-249274d5c962", "name": "Exclui grupo SKU", "request": { "name": "Exclui grupo SKU", "description": { "content": "Exclui um grupo da empresa autenticada. **Bloqueado** quando o grupo tem SKUs associados ou códigos similares vinculados.", "type": "text/plain" }, "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "78d4e126-84d9-4e60-94ab-e7e0edbc8a7b", "name": "Grupo excluído. Corpo: string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e1a0b4f-8835-4dc9-a256-c22bd0081054", "name": "`[BadRequest] - Grupo não existe`; `[BadRequest] - Grupo está associado a SKUs, remover o vínculo antes de excluir o grupo`; `[BadRequest] - Grupo está associado a códigos similares, remover o vínculo antes de excluir o grupo`.", "originalRequest": { "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ff9968e-1dc1-4505-9a3b-f360ecbe091c", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "group", ":idstockkeepingunitgroup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroup", "description": "(Required) Id do grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51bbcd3f-49a0-4e72-84ba-eaf8dc3df6f3", "name": "Lista grupos associados ao SKU", "request": { "name": "Lista grupos associados ao SKU", "description": { "content": "Lista os grupos de SKU a que o SKU pertence, com os códigos similares cadastrados em cada grupo.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "50f44699-ee4c-49eb-89f7-165b734931ee", "name": "Lista de associações.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitGroupAssociation\": 8136,\n \"IDSku\": 3060,\n \"IDStockKeepingUnitGroup\": 5246,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"StockKeepingUnitSimilarCode\": [\n {\n \"IDStockKeepingUnitSimilarCode\": 7703,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 5618,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n }\n ],\n \"RecordTimestamp\": \"2020-06-17T16:24:42.228Z\"\n },\n {\n \"IDStockKeepingUnitGroupAssociation\": 8123,\n \"IDSku\": 6602,\n \"IDStockKeepingUnitGroup\": 7623,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"StockKeepingUnitSimilarCode\": [\n {\n \"IDStockKeepingUnitSimilarCode\": 1770,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 7193,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n }\n ],\n \"RecordTimestamp\": \"1987-12-16T12:26:17.685Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f08bf2f-6074-4c97-88f6-634cb34cfa19", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd052494-634a-49a6-9d57-0266f39a8587", "name": "Associa o SKU a um grupo", "request": { "name": "Associa o SKU a um grupo", "description": { "content": "Vincula o SKU ao grupo informado. Cada par SKU/grupo é único.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 9526\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "85d5e375-0f5f-4cad-8689-b1bf32f79a5b", "name": "Associação criada. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 9526\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitGroupAssociation\": 5023,\n \"IDSku\": 1583,\n \"IDStockKeepingUnitGroup\": 8707,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"StockKeepingUnitSimilarCode\": [\n {\n \"IDStockKeepingUnitSimilarCode\": 186,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 5132,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n }\n ],\n \"RecordTimestamp\": \"1960-03-12T11:18:01.925Z\"\n },\n {\n \"IDStockKeepingUnitGroupAssociation\": 7464,\n \"IDSku\": 8970,\n \"IDStockKeepingUnitGroup\": 811,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"StockKeepingUnitSimilarCode\": [\n {\n \"IDStockKeepingUnitSimilarCode\": 4004,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 2771,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n }\n ],\n \"RecordTimestamp\": \"2005-10-05T00:13:53.466Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f727238-41e7-46e7-a0f3-cd869e27a46a", "name": "Prefixo `[BadRequest]`. Mensagens: `Sku não existe`, `Sku já possui esse grupo`, `Grupo Sku não existe`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 9526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a559e98f-bb66-41bc-bded-976d2a28f148", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 9526\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c4c93f5-16e6-4ae7-9fcd-bb06b63019ab", "name": "Troca o grupo de uma associação existente", "request": { "name": "Troca o grupo de uma associação existente", "description": { "content": "Atualiza o grupo associado a um vínculo já existente.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 688\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8da7eb51-61cd-4bb9-8fef-2ed8c8b65a14", "name": "Associação atualizada. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 688\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitGroupAssociation\": 5023,\n \"IDSku\": 1583,\n \"IDStockKeepingUnitGroup\": 8707,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"StockKeepingUnitSimilarCode\": [\n {\n \"IDStockKeepingUnitSimilarCode\": 186,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 5132,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n }\n ],\n \"RecordTimestamp\": \"1960-03-12T11:18:01.925Z\"\n },\n {\n \"IDStockKeepingUnitGroupAssociation\": 7464,\n \"IDSku\": 8970,\n \"IDStockKeepingUnitGroup\": 811,\n \"SkuGroupName\": \"string\",\n \"AccountName\": \"string\",\n \"StockKeepingUnitSimilarCode\": [\n {\n \"IDStockKeepingUnitSimilarCode\": 4004,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n },\n {\n \"IDStockKeepingUnitSimilarCode\": 2771,\n \"SkuSimilarCode\": \"string\",\n \"SkuSimilarCodeTag\": \"string\"\n }\n ],\n \"RecordTimestamp\": \"2005-10-05T00:13:53.466Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6c0416a-3961-47bc-89a0-13dafe270911", "name": "Prefixo `[BadRequest]`. Mensagens: `Grupo Sku não existe`, `Sku já possui esse grupo`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 688\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70a10d60-1cf5-45d5-9a22-577034401b2a", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitGroup\": 688\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6fd5951-8d50-4ffd-8113-1a9ef310cabb", "name": "Remove a associação SKU/grupo", "request": { "name": "Remove a associação SKU/grupo", "description": { "content": "Desvincula o SKU do grupo.", "type": "text/plain" }, "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "4d5d51ef-9980-4640-a529-f08f00463902", "name": "Associação removida.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c040e76a-7bea-4c22-b61f-e06ab973df5e", "name": "Prefixo `[BadRequest]`. Mensagem: `Grupo Sku não existe`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0cd2dc1d-afb1-4eaf-9b33-b13e4697d7d3", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", ":idsku", "group", ":idstockkeepingunitgroupassociation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitgroupassociation", "description": "(Required) Identificador da associação SKU/grupo." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "59804e3b-2b89-465f-a56e-3d0df80c8807", "name": "Hub — Anúncios", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "45c53fd0-8f1c-4c38-b839-80903551be18", "name": "Lista templates de mensagem", "request": { "name": "Lista templates de mensagem", "description": { "content": "Lista os templates de mensagem da empresa. Filtros via querystring por `AnswerType` (`1` Resposta pré-cadastrada, `2` Mensagem automática).", "type": "text/plain" }, "url": { "path": [ "hub", "product", "question-answer-template" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "AnswerType", "value": "1", "description": "Filtra pelo tipo de resposta." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "596a3ed7-e0b5-4feb-b3d7-a25bd131b698", "name": "Array de templates.", "originalRequest": { "url": { "path": [ "hub", "product", "question-answer-template" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "AnswerType", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductQuestionAnswerTemplate\": 3783,\n \"AccountName\": \"string\",\n \"AnswerType\": 2,\n \"AnswerTypeDescription\": \"string\",\n \"Title\": \"string\",\n \"Answer\": \"string\"\n },\n {\n \"IDHubProductQuestionAnswerTemplate\": 2215,\n \"AccountName\": \"string\",\n \"AnswerType\": 1,\n \"AnswerTypeDescription\": \"string\",\n \"Title\": \"string\",\n \"Answer\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e441237-c13d-4585-9bd4-b64dd36f606f", "name": "Cria template de mensagem", "request": { "name": "Cria template de mensagem", "description": { "content": "Cria um novo template. `Title` é obrigatório quando `AnswerType=2` (Mensagem automática). Texto pode conter variáveis dinâmicas `{{Variável}}` substituídas no momento do uso.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "question-answer-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AnswerType\": 1,\n \"AnswerTemplate\": \"string\",\n \"AnswerTitle\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "903e92ca-ff1c-408a-9d85-9c49be3a7370", "name": "Template criado.", "originalRequest": { "url": { "path": [ "hub", "product", "question-answer-template" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AnswerType\": 1,\n \"AnswerTemplate\": \"string\",\n \"AnswerTitle\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22ae8baf-bdbd-4d76-85c6-3d974dda4d5e", "name": "Edita template de mensagem", "request": { "name": "Edita template de mensagem", "description": { "content": "Edita um template de mensagem usado para responder perguntas de compradores no canal de venda. Devolve o template atualizado.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "question-answer-template", ":idhubproductquestionanswertemplate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswertemplate", "description": "(Required) Identificador do modelo de pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AnswerType\": 1,\n \"AnswerTemplate\": \"string\",\n \"AnswerTitle\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6734effd-414f-4972-b672-75e2e1b80fdb", "name": "Sucesso.", "originalRequest": { "url": { "path": [ "hub", "product", "question-answer-template", ":idhubproductquestionanswertemplate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswertemplate", "description": "(Required) Identificador do modelo de pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"AnswerType\": 1,\n \"AnswerTemplate\": \"string\",\n \"AnswerTitle\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d91e0bd2-06f1-4d60-9a46-49fdc34fc6cf", "name": "Remove template de mensagem", "request": { "name": "Remove template de mensagem", "description": { "content": "Remove um template de mensagem de perguntas/respostas do canal de venda.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "question-answer-template", ":idhubproductquestionanswertemplate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswertemplate", "description": "(Required) Identificador do modelo de pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "ab50e009-608e-471c-a2b9-ddcb57524d58", "name": "Sucesso.", "originalRequest": { "url": { "path": [ "hub", "product", "question-answer-template", ":idhubproductquestionanswertemplate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswertemplate", "description": "(Required) Identificador do modelo de pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b99e50ce-1e10-43a7-8458-fbdf11446213", "name": "Lista perguntas dos compradores", "request": { "name": "Lista perguntas dos compradores", "description": { "content": "Lista as perguntas feitas pelos compradores nos anúncios. Filtros opcionais: `IDTypeHubProductQuestionAnswerStatus` (`1` Não Respondida, `2` Respondida), `Nickname` (histórico do comprador), `IDHubProduct` (anúncio específico).", "type": "text/plain" }, "url": { "path": [ "hub", "product", "question-answer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeHubProductQuestionAnswerStatus", "value": "1", "description": "Filtra pelo status da pergunta/resposta de produto no hub." }, { "disabled": false, "key": "Nickname", "value": "string", "description": "Filtra pelo apelido." }, { "disabled": false, "key": "IDHubProduct", "value": "1603", "description": "Filtra pelo identificador do produto no hub." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelo identificador da integração da empresa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "85668a0c-9355-4f91-8338-b18c56fac961", "name": "Array de perguntas.", "originalRequest": { "url": { "path": [ "hub", "product", "question-answer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeHubProductQuestionAnswerStatus", "value": "1" }, { "key": "Nickname", "value": "string" }, { "key": "IDHubProduct", "value": "1603" }, { "key": "IDCompanyIntegration", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductQuestionAnswer\": 2929,\n \"AccountName\": \"string\",\n \"IDCompanyIntegration\": 7694,\n \"CompanyIntegration\": \"string\",\n \"IDHubProduct\": 2159,\n \"ProductName\": \"string\",\n \"AdvertisementCode\": \"string\",\n \"ReferenceCode\": \"string\",\n \"Question\": \"string\",\n \"Answer\": \"string\",\n \"Nickname\": \"string\",\n \"QuestionTimestamp\": \"1949-12-08T15:37:27.184Z\",\n \"AnswerTimestamp\": \"1981-09-13T04:33:12.467Z\",\n \"IDTypeHubProductQuestionAnswerStatus\": 2,\n \"AdvertisementUrl\": \"http://vKbRGbInFZE.isxAz\"\n },\n {\n \"IDHubProductQuestionAnswer\": 6944,\n \"AccountName\": \"string\",\n \"IDCompanyIntegration\": 5981,\n \"CompanyIntegration\": \"string\",\n \"IDHubProduct\": 6629,\n \"ProductName\": \"string\",\n \"AdvertisementCode\": \"string\",\n \"ReferenceCode\": \"string\",\n \"Question\": \"string\",\n \"Answer\": \"string\",\n \"Nickname\": \"string\",\n \"QuestionTimestamp\": \"2002-01-14T14:52:14.026Z\",\n \"AnswerTimestamp\": \"1991-02-15T19:45:38.349Z\",\n \"IDTypeHubProductQuestionAnswerStatus\": 4,\n \"AdvertisementUrl\": \"http://SwkEkyplsjgoqbeLJpFUocNkOvyGVzS.tdc,200Jjyumi.wi7v-cy9g7G2qgCHu2PGzTrIU1Oj2p\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "658f6812-bf75-4e77-b958-e16024307a12", "name": "Responde uma pergunta", "request": { "name": "Responde uma pergunta", "description": { "content": "Envia a resposta para o canal e marca a pergunta como Respondida (status `2`). Limite de **2000 caracteres** imposto pelo canal.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "question-answer", ":idhubproductquestionanswer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswer", "description": "(Required) Identificador da pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a4194bb7-a999-4ba8-9927-f5b279630bdf", "name": "Resposta enviada.", "originalRequest": { "url": { "path": [ "hub", "product", "question-answer", ":idhubproductquestionanswer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswer", "description": "(Required) Identificador da pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Answer\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e4529db-a493-4fe1-8e0c-8d3a2ba1fa25", "name": "Remove uma pergunta", "request": { "name": "Remove uma pergunta", "description": { "content": "Permitido apenas em perguntas **Não Respondidas** (`IDTypeHubProductQuestionAnswerStatus=1`).", "type": "text/plain" }, "url": { "path": [ "hub", "product", "question-answer", ":idhubproductquestionanswer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswer", "description": "(Required) Identificador da pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "8acecbe2-440e-4906-b885-84db968a74ac", "name": "Sucesso.", "originalRequest": { "url": { "path": [ "hub", "product", "question-answer", ":idhubproductquestionanswer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquestionanswer", "description": "(Required) Identificador da pergunta/resposta de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af13f4a8-0453-4758-961c-c00ff6d1a248", "name": "Lista grades — Hub Grade de Tamanho", "request": { "name": "Lista grades — Hub Grade de Tamanho", "description": { "content": "Lista as grades de tamanho cadastradas. Retorna apenas grades com `SizeChartStatus` 1 ou 2.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "size-chart" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra por integração." }, { "disabled": false, "key": "ExternalId", "value": "string", "description": "Filtra pelo identificador da grade no canal." }, { "disabled": false, "key": "CatalogDomain", "value": "string", "description": "Filtra pelo domínio de catálogo (ex.: `MLB-FOOTWEAR`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cecc42ab-5e5a-4eb4-a4ff-204d55789181", "name": "Lista de grades.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "ExternalId", "value": "string" }, { "key": "CatalogDomain", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductSizeChart\": 8148,\n \"IDCompanyIntegration\": 7439,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 6145,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDHubProductSizeChart\": 2795,\n \"IDCompanyIntegration\": 9704,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 7522,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "668c1c8d-8a12-48c7-8cf4-20e28f1aca3e", "name": "Cria grade de tamanho — Hub Grade de Tamanho", "request": { "name": "Cria grade de tamanho — Hub Grade de Tamanho", "description": { "content": "Cria uma nova grade de tamanho com suas linhas (tamanhos) e atributos de medida. A grade nasce em status pendente de sincronização — um processo assíncrono envia ao canal. `RowId` precisa ser único dentro da grade.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "size-chart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 7845,\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6e830b4c-cc0f-4ced-aa6f-581a552e77bc", "name": "Grade criada (mesma estrutura do GET por ID).", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 2645,\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductSizeChart\": 4599,\n \"IDCompanyIntegration\": 2399,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 2750,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 6937,\n \"IDHubProductSizeChart\": 769,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 3970,\n \"IDHubProductSizeChart\": 6223,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5030,\n \"IDHubProductSizeChart\": 8895,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 9215,\n \"IDHubProductSizeChart\": 5549,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"IDHubProductSizeChart\": 8632,\n \"IDCompanyIntegration\": 2426,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 2260,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 2385,\n \"IDHubProductSizeChart\": 1050,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 4983,\n \"IDHubProductSizeChart\": 2054,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 3899,\n \"IDHubProductSizeChart\": 6633,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 8873,\n \"IDHubProductSizeChart\": 8577,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3529423-973d-4e02-9943-8ca6617f78cd", "name": "`[BadRequest] - Empresa não existe` · `[BadRequest] - Linha {RowId} duplicada`.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 2645,\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9591ddd0-457e-4cdf-94a1-ec4e96a3969f", "name": "Detalha grade — Hub Grade de Tamanho", "request": { "name": "Detalha grade — Hub Grade de Tamanho", "description": { "content": "Retorna a grade com todas as linhas (tamanhos) e atributos de medida.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "974219ff-4f68-48a8-9429-46e5d5b8680c", "name": "Grade detalhada. Retorna array vazio quando não existe ou pertence a outra empresa.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductSizeChart\": 5997,\n \"IDCompanyIntegration\": 9662,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 8462,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 2330,\n \"IDHubProductSizeChart\": 4600,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 8526,\n \"IDHubProductSizeChart\": 5057,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5687,\n \"IDHubProductSizeChart\": 1315,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 4589,\n \"IDHubProductSizeChart\": 8547,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"IDHubProductSizeChart\": 9951,\n \"IDCompanyIntegration\": 3888,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 6822,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5077,\n \"IDHubProductSizeChart\": 5049,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 5062,\n \"IDHubProductSizeChart\": 1443,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 3585,\n \"IDHubProductSizeChart\": 9981,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 1402,\n \"IDHubProductSizeChart\": 8961,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da9587c6-4620-42ab-9075-55845a12556d", "name": "Atualiza grade — Hub Grade de Tamanho", "request": { "name": "Atualiza grade — Hub Grade de Tamanho", "description": { "content": "Atualiza nome e tipo de medida da grade. Tipo de medida **não pode** ser alterado depois que a grade foi sincronizada com o canal (já tem `ExternalId`).", "type": "text/plain" }, "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c0140c74-0899-4421-a9d2-512ffcdb77e9", "name": "Grade atualizada.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductSizeChart\": 5997,\n \"IDCompanyIntegration\": 9662,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 8462,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 2330,\n \"IDHubProductSizeChart\": 4600,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 8526,\n \"IDHubProductSizeChart\": 5057,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5687,\n \"IDHubProductSizeChart\": 1315,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 4589,\n \"IDHubProductSizeChart\": 8547,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"IDHubProductSizeChart\": 9951,\n \"IDCompanyIntegration\": 3888,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 6822,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5077,\n \"IDHubProductSizeChart\": 5049,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 5062,\n \"IDHubProductSizeChart\": 1443,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 3585,\n \"IDHubProductSizeChart\": 9981,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 1402,\n \"IDHubProductSizeChart\": 8961,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "410b45a7-e861-4e85-b9f0-50c96135cb36", "name": "`[BadRequest] - Grade de tamanho não existe` · `[BadRequest] - Grade de tamanho já foi sincronizada com canal e não pode ser alterada`.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68dd5305-d183-47ea-9c0c-d6b6be2ac6a1", "name": "Adiciona linha à grade — Hub Grade de Tamanho", "request": { "name": "Adiciona linha à grade — Hub Grade de Tamanho", "description": { "content": "Adiciona uma nova linha (tamanho) à grade existente. O `RowId` precisa ser único na grade. Cada combinação `FieldId`+`FieldValue` precisa ser única — o sistema rejeita atributos duplicados.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "00153511-1fba-46c3-92f5-7e3087064b0d", "name": "Linha adicionada (retorna a grade completa).", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductSizeChart\": 5997,\n \"IDCompanyIntegration\": 9662,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 8462,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 2330,\n \"IDHubProductSizeChart\": 4600,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 8526,\n \"IDHubProductSizeChart\": 5057,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5687,\n \"IDHubProductSizeChart\": 1315,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 4589,\n \"IDHubProductSizeChart\": 8547,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"IDHubProductSizeChart\": 9951,\n \"IDCompanyIntegration\": 3888,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 6822,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5077,\n \"IDHubProductSizeChart\": 5049,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 5062,\n \"IDHubProductSizeChart\": 1443,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 3585,\n \"IDHubProductSizeChart\": 9981,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 1402,\n \"IDHubProductSizeChart\": 8961,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a95b7c6d-b049-44a4-98a5-1df6921cde24", "name": "`[BadRequest] - Empresa não existe` · `[BadRequest] - Já existe um tamanho com mesmo código (rowid)` · `[BadRequest] - Já existe o atributo {FieldName} com o mesmo valor {FieldValue}`.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d638f5f7-3cca-4633-aa12-61f88e62b78b", "name": "Exclui grade — Hub Grade de Tamanho", "request": { "name": "Exclui grade — Hub Grade de Tamanho", "description": { "content": "Exclui a grade. Quando a grade ainda não foi sincronizada com o canal (sem `ExternalId`) a exclusão é imediata. Quando já foi sincronizada, dispara um pedido assíncrono ao canal — o status só será atualizado depois de até 24h.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c3de544c-630b-45ff-853d-6d964a750905", "name": "Mensagem `Sucesso` (quando excluída localmente) ou `Solicitação de exclusão realizada com sucesso. Se houver algum problema, a tabela retornará a lista em 24h` (quando dispara processo no canal).", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2b5f13a-2d67-4c8c-87b9-989fa4fe5b1a", "name": "`[BadRequest] - Grade de tamanho não existe`.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "081c2289-1429-4eac-aace-920de0e2ab8f", "name": "Atualiza atributos da linha — Hub Grade de Tamanho", "request": { "name": "Atualiza atributos da linha — Hub Grade de Tamanho", "description": { "content": "Atualiza (upsert) os atributos de medida de uma linha existente. Combinações `FieldId` já presentes têm `FieldName`, `FieldValue` e `Unit` atualizados; novas combinações são inseridas.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart", ":rowid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "disabled": false, "type": "any", "value": "string", "key": "rowid", "description": "(Required) Código do tamanho dentro da grade." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a287624c-6b45-47c0-815b-2970619b0ea6", "name": "Linha atualizada (retorna a grade completa).", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart", ":rowid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "disabled": false, "type": "any", "value": "string", "key": "rowid", "description": "(Required) Código do tamanho dentro da grade." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductSizeChart\": 5997,\n \"IDCompanyIntegration\": 9662,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 8462,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 2330,\n \"IDHubProductSizeChart\": 4600,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 8526,\n \"IDHubProductSizeChart\": 5057,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5687,\n \"IDHubProductSizeChart\": 1315,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 4589,\n \"IDHubProductSizeChart\": 8547,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"IDHubProductSizeChart\": 9951,\n \"IDCompanyIntegration\": 3888,\n \"ExternalId\": \"string\",\n \"SizeChartName\": \"string\",\n \"TypeMeasure\": \"string\",\n \"TypeMeasureDescription\": \"string\",\n \"Gender\": \"string\",\n \"GenderId\": \"string\",\n \"CatalogDomain\": \"string\",\n \"CatalogDomainName\": \"string\",\n \"SizeChartStatus\": 6822,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationLogoUrl\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductSizeChartRow\": [\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 5077,\n \"IDHubProductSizeChart\": 5049,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 5062,\n \"IDHubProductSizeChart\": 1443,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n },\n {\n \"RowId\": \"string\",\n \"Attributes\": [\n {\n \"IDHubProductSizeChartRow\": 3585,\n \"IDHubProductSizeChart\": 9981,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"IDHubProductSizeChartRow\": 1402,\n \"IDHubProductSizeChart\": 8961,\n \"FieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76adedf9-5279-4a43-b4e5-b312da1e1e35", "name": "`[BadRequest] - Linha grade de tamanho não existe`.", "originalRequest": { "url": { "path": [ "hub", "product", "size-chart", ":idhubproductsizechart", ":rowid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductsizechart", "description": "(Required) Identificador da tabela de medidas de produto no hub." }, { "disabled": false, "type": "any", "value": "string", "key": "rowid", "description": "(Required) Código do tamanho dentro da grade." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Attributes\": [\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n },\n {\n \"FieldId\": \"string\",\n \"FieldValue\": \"string\",\n \"FieldName\": \"string\",\n \"Unit\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10f10952-db92-4852-b26c-7129b3a03f86", "name": "Lista promoções — Hub Promoções", "request": { "name": "Lista promoções — Hub Promoções", "description": { "content": "Lista as promoções do hub. Use `IDProductHub` para verificar se um anúncio específico está em alguma promoção — quando informado, cada promoção retornada inclui o objeto `HubProductPromotionItem` com os campos do anúncio dentro daquela promoção. Página de até 2000 registros.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelo identificador da integração da empresa." }, { "disabled": false, "key": "IDTypeHubProductPromotionStatus", "value": "8", "description": "Filtra por status (`1`-`8`)." }, { "disabled": false, "key": "IDTypeHubProductPromotion", "value": "2232", "description": "Filtra por tipo. Consulte `/type/hub/product/promotion/type`." }, { "disabled": false, "key": "IDProductHub", "value": "string", "description": "Filtra promoções que contenham o anúncio informado (ex.: `MLB123456789`)." }, { "disabled": false, "key": "IDHubProductPromotion", "value": "1603", "description": "Filtra pelo identificador da promoção de produto no hub." }, { "disabled": false, "key": "DateFromDateFrom", "value": "1980-02-08", "description": "Filtra promoções com `DateFrom` >= esta data." }, { "disabled": false, "key": "DateFromDateTo", "value": "1980-02-08", "description": "Filtra promoções com `DateFrom` <= esta data (23:59:59)." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Página (cada página = 2000 registros)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "790b6ee1-f4f2-4362-b6f4-2200098c5d4b", "name": "Promoções.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeHubProductPromotionStatus", "value": "8" }, { "key": "IDTypeHubProductPromotion", "value": "2232" }, { "key": "IDProductHub", "value": "string" }, { "key": "IDHubProductPromotion", "value": "1603" }, { "key": "DateFromDateFrom", "value": "1980-02-08" }, { "key": "DateFromDateTo", "value": "1980-02-08" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotion\": 5422,\n \"IDCompanyIntegration\": 9801,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 8101,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 4990,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 3,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"1987-03-03\",\n \"DateTo\": \"1966-04-22\",\n \"DateDeadline\": \"1982-06-04\",\n \"SellerPercent\": 2666.035263291542,\n \"IntegrationPercent\": 8297.928812728638,\n \"IntegrationStatus\": 8536,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 448,\n \"AccountName\": \"string\",\n \"SellerCreate\": 4370\n },\n {\n \"IDHubProductPromotion\": 2533,\n \"IDCompanyIntegration\": 9983,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 8342,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 7997,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 8,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"1989-07-09\",\n \"DateTo\": \"2013-12-10\",\n \"DateDeadline\": \"1971-11-06\",\n \"SellerPercent\": 3885.0726259287094,\n \"IntegrationPercent\": 3239.025285027648,\n \"IntegrationStatus\": 3732,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 1403,\n \"AccountName\": \"string\",\n \"SellerCreate\": 3503\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0ab2bef-4621-4951-a75f-779efdd7feba", "name": "Cria promoção — Hub Promoções", "request": { "name": "Cria promoção — Hub Promoções", "description": { "content": "Cria promoção localmente e dispara sincronização assíncrona com o canal. Só funciona para tipos com `SellerCreate = 1`. Os demais tipos são gerados no canal e apenas recebidos no idworks. Para `Campanha vendedor` (tipo 8) o nome é único entre promoções ativas/programadas da mesma integração.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6555,\n \"IDTypeHubProductPromotion\": 2528,\n \"PromotionName\": \"string\",\n \"DateFrom\": \"1998-03-27T23:41:39.001Z\",\n \"DateTo\": \"1988-09-26T21:50:21.696Z\",\n \"SellerPercent\": 4991.722562501739\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e994567-54d2-4d38-840f-807327facda7", "name": "Promoção criada.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6555,\n \"IDTypeHubProductPromotion\": 2528,\n \"PromotionName\": \"string\",\n \"DateFrom\": \"1998-03-27T23:41:39.001Z\",\n \"DateTo\": \"1988-09-26T21:50:21.696Z\",\n \"SellerPercent\": 4991.722562501739\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotion\": 4030,\n \"IDCompanyIntegration\": 4595,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 9086,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 3000,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"1990-10-06\",\n \"DateTo\": \"1951-10-09\",\n \"DateDeadline\": \"1969-09-05\",\n \"SellerPercent\": 553.0216547128641,\n \"IntegrationPercent\": 5307.046956061346,\n \"IntegrationStatus\": 480,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 2877,\n \"AccountName\": \"string\",\n \"SellerCreate\": 4493,\n \"HasNextPageItems\": 9446,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 5288,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 6638,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 637.099503257188,\n \"OriginalPrice\": 6051.207582617055,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1949-02-24T16:08:43.978Z\",\n \"DateTo\": \"1963-03-13T09:06:19.067Z\",\n \"SellerPercent\": 4020.1949739797005,\n \"IntegrationPercent\": 9915.673048719851,\n \"MaximumDiscountedPrice\": 9924.466686670283,\n \"MinimumDiscountedPrice\": 4710.456599832513,\n \"SetQuantityAvailable\": 694,\n \"MaximumQuantityAvailable\": 1529,\n \"MinimumQuantityAvailable\": 9424,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 5628,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 7921,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 1538,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 4679.323047755431,\n \"OriginalPrice\": 640.7771835698361,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"2002-10-03T23:57:19.955Z\",\n \"DateTo\": \"1985-06-17T22:49:59.037Z\",\n \"SellerPercent\": 1026.5813859182326,\n \"IntegrationPercent\": 9177.663663228539,\n \"MaximumDiscountedPrice\": 888.6865420480406,\n \"MinimumDiscountedPrice\": 5994.297158855208,\n \"SetQuantityAvailable\": 763,\n \"MaximumQuantityAvailable\": 5330,\n \"MinimumQuantityAvailable\": 7634,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 8195,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n },\n {\n \"IDHubProductPromotion\": 9252,\n \"IDCompanyIntegration\": 9268,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 4202,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 3804,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 7,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"2011-07-06\",\n \"DateTo\": \"1970-02-23\",\n \"DateDeadline\": \"1976-09-13\",\n \"SellerPercent\": 3214.2702390793975,\n \"IntegrationPercent\": 8769.773512277576,\n \"IntegrationStatus\": 1524,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 2113,\n \"AccountName\": \"string\",\n \"SellerCreate\": 3748,\n \"HasNextPageItems\": 3624,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 1265,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 4114,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 3219.33807101634,\n \"OriginalPrice\": 7493.151610492104,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"2012-08-10T02:57:06.605Z\",\n \"DateTo\": \"1972-01-19T23:23:06.784Z\",\n \"SellerPercent\": 5456.040696444619,\n \"IntegrationPercent\": 1230.0907904265434,\n \"MaximumDiscountedPrice\": 2733.7767169403946,\n \"MinimumDiscountedPrice\": 3639.9316719784647,\n \"SetQuantityAvailable\": 4528,\n \"MaximumQuantityAvailable\": 6991,\n \"MinimumQuantityAvailable\": 8455,\n \"IDTypeHubProductPromotionStatus\": 7,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 5146,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 969,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 6065,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 5967.651496753326,\n \"OriginalPrice\": 9327.35598295409,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"2022-12-23T19:36:01.707Z\",\n \"DateTo\": \"1947-02-22T22:14:02.058Z\",\n \"SellerPercent\": 6303.693654646911,\n \"IntegrationPercent\": 8937.712661454974,\n \"MaximumDiscountedPrice\": 9152.145840575278,\n \"MinimumDiscountedPrice\": 8299.33310262517,\n \"SetQuantityAvailable\": 2037,\n \"MaximumQuantityAvailable\": 6937,\n \"MinimumQuantityAvailable\": 9838,\n \"IDTypeHubProductPromotionStatus\": 1,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 5866,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b6b9c8-6d0c-4d06-a319-57a51ac4d217", "name": "`[BadRequest] - Empresa não existe` · `[BadRequest] - Tipo de promoção não pode ser criada` · `[BadRequest] - Obrigatório data de neste tipo de promoção` · `[BadRequest] - Obrigatório data até neste tipo de promoção` · `[BadRequest] - Nome da promoção não pode ser maior que 25 caracteres` · `[BadRequest] - Intervalo de data tem que ser inferior a 31 dias` · `[BadRequest] - Data até precisa ser maior que hoje` · `[BadRequest] - Desconto precisa ser maior que 10%` · `[BadRequest] - Desconto precisa ser menor que 70%` · `[BadRequest] - Já existe uma promoção ativa/programada com o mesmo nome`.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6555,\n \"IDTypeHubProductPromotion\": 2528,\n \"PromotionName\": \"string\",\n \"DateFrom\": \"1998-03-27T23:41:39.001Z\",\n \"DateTo\": \"1988-09-26T21:50:21.696Z\",\n \"SellerPercent\": 4991.722562501739\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aee9cc97-567b-4430-86f8-17c4840a71ae", "name": "Detalha promoção — Hub Promoções", "request": { "name": "Detalha promoção — Hub Promoções", "description": { "content": "Retorna a promoção com seus anúncios. A lista de anúncios é paginada em blocos de 5000 — use `Page` para navegar. `HasNextPageItems = 1` indica que há mais itens.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "2232", "description": "Página de anúncios (cada página = 5000 anúncios)." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0d9990e7-d4be-4688-8f51-347805938b6c", "name": "Promoção detalhada. Array vazio quando não existe ou pertence a outra empresa.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotion\": 8922,\n \"IDCompanyIntegration\": 4787,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1617,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 2944,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"2017-09-18\",\n \"DateTo\": \"1960-02-29\",\n \"DateDeadline\": \"1982-02-27\",\n \"SellerPercent\": 5154.2107762706955,\n \"IntegrationPercent\": 5145.026945309286,\n \"IntegrationStatus\": 8070,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 9454,\n \"AccountName\": \"string\",\n \"SellerCreate\": 7599,\n \"HasNextPageItems\": 743,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 2287,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 2450,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 3808.9650229409976,\n \"OriginalPrice\": 6570.649372632353,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1990-10-24T03:04:07.044Z\",\n \"DateTo\": \"1948-07-31T10:31:14.132Z\",\n \"SellerPercent\": 1430.6644173934435,\n \"IntegrationPercent\": 7122.234262454945,\n \"MaximumDiscountedPrice\": 7999.205885101975,\n \"MinimumDiscountedPrice\": 1160.981503736427,\n \"SetQuantityAvailable\": 8150,\n \"MaximumQuantityAvailable\": 2537,\n \"MinimumQuantityAvailable\": 5930,\n \"IDTypeHubProductPromotionStatus\": 3,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 7851,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 9697,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 1084,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 230.269715906517,\n \"OriginalPrice\": 1750.0940357540728,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1993-04-09T21:47:13.235Z\",\n \"DateTo\": \"1990-04-07T00:30:38.949Z\",\n \"SellerPercent\": 6708.255249609203,\n \"IntegrationPercent\": 6327.973111233631,\n \"MaximumDiscountedPrice\": 8967.759914983144,\n \"MinimumDiscountedPrice\": 5306.329150471658,\n \"SetQuantityAvailable\": 163,\n \"MaximumQuantityAvailable\": 2215,\n \"MinimumQuantityAvailable\": 2900,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 8788,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n },\n {\n \"IDHubProductPromotion\": 3491,\n \"IDCompanyIntegration\": 1873,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 3881,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 2155,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 8,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"1957-09-04\",\n \"DateTo\": \"1989-04-07\",\n \"DateDeadline\": \"2004-06-28\",\n \"SellerPercent\": 3127.5640903734757,\n \"IntegrationPercent\": 9748.66229385756,\n \"IntegrationStatus\": 6970,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 1180,\n \"AccountName\": \"string\",\n \"SellerCreate\": 5443,\n \"HasNextPageItems\": 8565,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 9963,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9219,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 1360.1735774997148,\n \"OriginalPrice\": 8282.975108097578,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1956-08-16T04:33:06.702Z\",\n \"DateTo\": \"1997-06-14T11:13:21.298Z\",\n \"SellerPercent\": 6391.878207692609,\n \"IntegrationPercent\": 2254.4816852333447,\n \"MaximumDiscountedPrice\": 8399.43391712825,\n \"MinimumDiscountedPrice\": 7411.238359678904,\n \"SetQuantityAvailable\": 1263,\n \"MaximumQuantityAvailable\": 1840,\n \"MinimumQuantityAvailable\": 6339,\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 8662,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 1257,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 744,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 119.00631014920116,\n \"OriginalPrice\": 6544.899392150518,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1989-01-23T04:47:52.673Z\",\n \"DateTo\": \"2020-08-11T07:10:20.658Z\",\n \"SellerPercent\": 6984.687281527524,\n \"IntegrationPercent\": 1631.9192135135975,\n \"MaximumDiscountedPrice\": 8059.759076797568,\n \"MinimumDiscountedPrice\": 7690.100157136681,\n \"SetQuantityAvailable\": 7706,\n \"MaximumQuantityAvailable\": 573,\n \"MinimumQuantityAvailable\": 7771,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 9125,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61961c4f-a23f-476a-9403-90a1170a5e74", "name": "Atualiza promoção — Hub Promoções", "request": { "name": "Atualiza promoção — Hub Promoções", "description": { "content": "Atualiza dados da promoção e dispara nova sincronização. Para `Campanha vendedor` em status `Iniciado` a `DateFrom` não pode ser alterada. Mesmas validações de datas/percentual da criação.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"PromotionName\": \"string\",\n \"DateFrom\": \"1976-03-31T14:35:43.612Z\",\n \"DateTo\": \"2018-10-30T04:13:04.669Z\",\n \"SellerPercent\": 1116.1460015341884\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3c082bf6-055e-480d-bf66-ff3d62861639", "name": "Promoção atualizada.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"PromotionName\": \"string\",\n \"DateFrom\": \"1976-03-31T14:35:43.612Z\",\n \"DateTo\": \"2018-10-30T04:13:04.669Z\",\n \"SellerPercent\": 1116.1460015341884\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotion\": 8922,\n \"IDCompanyIntegration\": 4787,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1617,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 2944,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"2017-09-18\",\n \"DateTo\": \"1960-02-29\",\n \"DateDeadline\": \"1982-02-27\",\n \"SellerPercent\": 5154.2107762706955,\n \"IntegrationPercent\": 5145.026945309286,\n \"IntegrationStatus\": 8070,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 9454,\n \"AccountName\": \"string\",\n \"SellerCreate\": 7599,\n \"HasNextPageItems\": 743,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 2287,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 2450,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 3808.9650229409976,\n \"OriginalPrice\": 6570.649372632353,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1990-10-24T03:04:07.044Z\",\n \"DateTo\": \"1948-07-31T10:31:14.132Z\",\n \"SellerPercent\": 1430.6644173934435,\n \"IntegrationPercent\": 7122.234262454945,\n \"MaximumDiscountedPrice\": 7999.205885101975,\n \"MinimumDiscountedPrice\": 1160.981503736427,\n \"SetQuantityAvailable\": 8150,\n \"MaximumQuantityAvailable\": 2537,\n \"MinimumQuantityAvailable\": 5930,\n \"IDTypeHubProductPromotionStatus\": 3,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 7851,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 9697,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 1084,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 230.269715906517,\n \"OriginalPrice\": 1750.0940357540728,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1993-04-09T21:47:13.235Z\",\n \"DateTo\": \"1990-04-07T00:30:38.949Z\",\n \"SellerPercent\": 6708.255249609203,\n \"IntegrationPercent\": 6327.973111233631,\n \"MaximumDiscountedPrice\": 8967.759914983144,\n \"MinimumDiscountedPrice\": 5306.329150471658,\n \"SetQuantityAvailable\": 163,\n \"MaximumQuantityAvailable\": 2215,\n \"MinimumQuantityAvailable\": 2900,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 8788,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n },\n {\n \"IDHubProductPromotion\": 3491,\n \"IDCompanyIntegration\": 1873,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 3881,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 2155,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 8,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"1957-09-04\",\n \"DateTo\": \"1989-04-07\",\n \"DateDeadline\": \"2004-06-28\",\n \"SellerPercent\": 3127.5640903734757,\n \"IntegrationPercent\": 9748.66229385756,\n \"IntegrationStatus\": 6970,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 1180,\n \"AccountName\": \"string\",\n \"SellerCreate\": 5443,\n \"HasNextPageItems\": 8565,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 9963,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9219,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 1360.1735774997148,\n \"OriginalPrice\": 8282.975108097578,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1956-08-16T04:33:06.702Z\",\n \"DateTo\": \"1997-06-14T11:13:21.298Z\",\n \"SellerPercent\": 6391.878207692609,\n \"IntegrationPercent\": 2254.4816852333447,\n \"MaximumDiscountedPrice\": 8399.43391712825,\n \"MinimumDiscountedPrice\": 7411.238359678904,\n \"SetQuantityAvailable\": 1263,\n \"MaximumQuantityAvailable\": 1840,\n \"MinimumQuantityAvailable\": 6339,\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 8662,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 1257,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 744,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 119.00631014920116,\n \"OriginalPrice\": 6544.899392150518,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1989-01-23T04:47:52.673Z\",\n \"DateTo\": \"2020-08-11T07:10:20.658Z\",\n \"SellerPercent\": 6984.687281527524,\n \"IntegrationPercent\": 1631.9192135135975,\n \"MaximumDiscountedPrice\": 8059.759076797568,\n \"MinimumDiscountedPrice\": 7690.100157136681,\n \"SetQuantityAvailable\": 7706,\n \"MaximumQuantityAvailable\": 573,\n \"MinimumQuantityAvailable\": 7771,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 9125,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa5592cd-7ad6-402f-be18-bca8ec0538cc", "name": "`[BadRequest] - Promoção não existe` · `[BadRequest] - Data inicio não pode ser alterada em promoção com status iniciada` · `[BadRequest] - Data inicio precisa ser maior ou igual a hoje` · `[BadRequest] - Já existe uma promoção ativa/programada com o mesmo nome`.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"PromotionName\": \"string\",\n \"DateFrom\": \"1976-03-31T14:35:43.612Z\",\n \"DateTo\": \"2018-10-30T04:13:04.669Z\",\n \"SellerPercent\": 1116.1460015341884\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ba01d31-209b-47d6-8a3d-9c6ef4787478", "name": "Exclui promoção — Hub Promoções", "request": { "name": "Exclui promoção — Hub Promoções", "description": { "content": "Solicita exclusão da promoção no canal (assíncrono). Só funciona para `Campanha vendedor` (tipo 8) — demais tipos não permitem exclusão pela API.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "92d02d7a-b872-43c6-aaf9-07bd09a44ad6", "name": "Pedido de exclusão registrado. Promoção retorna em status `Exclusão pendente` enquanto o canal processa.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotion\": 8922,\n \"IDCompanyIntegration\": 4787,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1617,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 2944,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"2017-09-18\",\n \"DateTo\": \"1960-02-29\",\n \"DateDeadline\": \"1982-02-27\",\n \"SellerPercent\": 5154.2107762706955,\n \"IntegrationPercent\": 5145.026945309286,\n \"IntegrationStatus\": 8070,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 9454,\n \"AccountName\": \"string\",\n \"SellerCreate\": 7599,\n \"HasNextPageItems\": 743,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 2287,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 2450,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 3808.9650229409976,\n \"OriginalPrice\": 6570.649372632353,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1990-10-24T03:04:07.044Z\",\n \"DateTo\": \"1948-07-31T10:31:14.132Z\",\n \"SellerPercent\": 1430.6644173934435,\n \"IntegrationPercent\": 7122.234262454945,\n \"MaximumDiscountedPrice\": 7999.205885101975,\n \"MinimumDiscountedPrice\": 1160.981503736427,\n \"SetQuantityAvailable\": 8150,\n \"MaximumQuantityAvailable\": 2537,\n \"MinimumQuantityAvailable\": 5930,\n \"IDTypeHubProductPromotionStatus\": 3,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 7851,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 9697,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 1084,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 230.269715906517,\n \"OriginalPrice\": 1750.0940357540728,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1993-04-09T21:47:13.235Z\",\n \"DateTo\": \"1990-04-07T00:30:38.949Z\",\n \"SellerPercent\": 6708.255249609203,\n \"IntegrationPercent\": 6327.973111233631,\n \"MaximumDiscountedPrice\": 8967.759914983144,\n \"MinimumDiscountedPrice\": 5306.329150471658,\n \"SetQuantityAvailable\": 163,\n \"MaximumQuantityAvailable\": 2215,\n \"MinimumQuantityAvailable\": 2900,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 8788,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n },\n {\n \"IDHubProductPromotion\": 3491,\n \"IDCompanyIntegration\": 1873,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 3881,\n \"IntegrationLogoUrl\": \"string\",\n \"PromotionId\": \"string\",\n \"PromotionName\": \"string\",\n \"IDTypeHubProductPromotion\": 2155,\n \"TypeHubProductPromotionDescription\": \"string\",\n \"TypeHubProductPromotionId\": \"string\",\n \"IDTypeHubProductPromotionStatus\": 8,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"DateFrom\": \"1957-09-04\",\n \"DateTo\": \"1989-04-07\",\n \"DateDeadline\": \"2004-06-28\",\n \"SellerPercent\": 3127.5640903734757,\n \"IntegrationPercent\": 9748.66229385756,\n \"IntegrationStatus\": 6970,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\",\n \"HubProductPromotionItemCount\": 1180,\n \"AccountName\": \"string\",\n \"SellerCreate\": 5443,\n \"HasNextPageItems\": 8565,\n \"HubProductPromotionItems\": [\n {\n \"IDHubProductPromotionItem\": 9963,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9219,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 1360.1735774997148,\n \"OriginalPrice\": 8282.975108097578,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1956-08-16T04:33:06.702Z\",\n \"DateTo\": \"1997-06-14T11:13:21.298Z\",\n \"SellerPercent\": 6391.878207692609,\n \"IntegrationPercent\": 2254.4816852333447,\n \"MaximumDiscountedPrice\": 8399.43391712825,\n \"MinimumDiscountedPrice\": 7411.238359678904,\n \"SetQuantityAvailable\": 1263,\n \"MaximumQuantityAvailable\": 1840,\n \"MinimumQuantityAvailable\": 6339,\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 8662,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 1257,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 744,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 119.00631014920116,\n \"OriginalPrice\": 6544.899392150518,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1989-01-23T04:47:52.673Z\",\n \"DateTo\": \"2020-08-11T07:10:20.658Z\",\n \"SellerPercent\": 6984.687281527524,\n \"IntegrationPercent\": 1631.9192135135975,\n \"MaximumDiscountedPrice\": 8059.759076797568,\n \"MinimumDiscountedPrice\": 7690.100157136681,\n \"SetQuantityAvailable\": 7706,\n \"MaximumQuantityAvailable\": 573,\n \"MinimumQuantityAvailable\": 7771,\n \"IDTypeHubProductPromotionStatus\": 4,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 9125,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03daabb5-77fa-492d-9bbd-7b2f2dac6259", "name": "`[BadRequest] - Promoção não existe` · `[BadRequest] - Tipo de promoção não permite excluir`.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a581e969-c239-4637-912a-337a1eb014b2", "name": "Adiciona anúncio à promoção — Hub Promoções", "request": { "name": "Adiciona anúncio à promoção — Hub Promoções", "description": { "content": "Adiciona um anúncio à promoção e dispara a sincronização com o canal. Só é permitido em promoções cujo tipo aceita inclusão pelo vendedor — `Desconto individual` e `Campanha vendedor`. Em `Desconto individual` o sistema consulta o anúncio no canal: o preço promocional precisa ficar entre 20% e 95% do preço anunciado, o anúncio não pode estar em revisão, `DateFrom` e `DateTo` são obrigatórios, `DateTo` precisa ser futura e o intervalo entre as duas datas não pode passar de 31 dias.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDProductHub\": \"string\",\n \"SellingPrice\": 4652.198824514382,\n \"IDSkuHub\": \"string\",\n \"DateFrom\": \"2005-02-05T12:59:34.978Z\",\n \"DateTo\": \"2003-05-09T18:14:00.904Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d1bbcb58-ed5d-4091-baab-477f644145c9", "name": "Anúncio adicionado.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDProductHub\": \"string\",\n \"SellingPrice\": 4652.198824514382,\n \"IDSkuHub\": \"string\",\n \"DateFrom\": \"2005-02-05T12:59:34.978Z\",\n \"DateTo\": \"2003-05-09T18:14:00.904Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotionItem\": 1182,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9517,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 5421.230944234882,\n \"OriginalPrice\": 3961.4579633172098,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1957-01-13T13:05:32.756Z\",\n \"DateTo\": \"1965-01-18T16:40:09.211Z\",\n \"SellerPercent\": 3909.773075419991,\n \"IntegrationPercent\": 107.153777266491,\n \"MaximumDiscountedPrice\": 2657.816229810006,\n \"MinimumDiscountedPrice\": 1290.1628003535625,\n \"SetQuantityAvailable\": 9889,\n \"MaximumQuantityAvailable\": 3938,\n \"MinimumQuantityAvailable\": 1416,\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 6808,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 8062,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 7309,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 8454.692927392507,\n \"OriginalPrice\": 4884.8553650019185,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1971-01-29T21:44:40.164Z\",\n \"DateTo\": \"2005-05-28T00:32:13.631Z\",\n \"SellerPercent\": 172.33303801879262,\n \"IntegrationPercent\": 1772.6691377360094,\n \"MaximumDiscountedPrice\": 9947.526998156241,\n \"MinimumDiscountedPrice\": 6293.876203570008,\n \"SetQuantityAvailable\": 2333,\n \"MaximumQuantityAvailable\": 7057,\n \"MinimumQuantityAvailable\": 8501,\n \"IDTypeHubProductPromotionStatus\": 5,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 7789,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2e18b05-170b-4196-bd58-4528194ee418", "name": "`[BadRequest] - Promoção não localizada` · `[BadRequest] - Promoção não permite adicionar itens` · `[BadRequest] - Este anúncio já está na promoção e não pode ser adicionado novamente. Editar o mesmo` · `[BadRequest] - Anúncio não encontrado` · `[BadRequest] - Anúncio não localizado no canal` · `[BadRequest] - Item está em revisão e não pode ser incluído promoção` · `[BadRequest] - Desconto precisa ser superior a 5%. Preço anunciado do item no canal é {preço}` · `[BadRequest] - Desconto não pode ser maior que 80%. Preço anunciado do item no canal é {preço}` · `[BadRequest] - Problema ao baixar anúncio no canal. Tentar novamente em instantes` · `[BadRequest] - Obrigatório data de neste tipo de promoção` (falta `DateTo` em `Desconto individual`) · `[BadRequest] - Obrigatório data até neste tipo de promoção` (falta `DateFrom`) · `[BadRequest] - Intervalo de data tem que ser inferior a 31 dias` · `[BadRequest] - Data até precisa ser maior que hoje` · `[BadRequest] - Access_token não encontrado` (integração do canal sem credencial válida) · `[BadRequest] - Erro ao adicionar item a promoção`.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDProductHub\": \"string\",\n \"SellingPrice\": 4652.198824514382,\n \"IDSkuHub\": \"string\",\n \"DateFrom\": \"2005-02-05T12:59:34.978Z\",\n \"DateTo\": \"2003-05-09T18:14:00.904Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16b45edc-107f-4b07-b023-6ab6775c3668", "name": "Atualiza anúncio na promoção — Hub Promoções", "request": { "name": "Atualiza anúncio na promoção — Hub Promoções", "description": { "content": "Atualiza um anúncio dentro da promoção e dispara nova sincronização. **Disponível apenas** para integrações de promoção (`IDTypeCompanyIntegration = 10`). Os campos aceitos e as validações dependem do tipo da promoção: `Tradicional` valida preço acima de 0 e abaixo do original e do mínimo do canal; `Oferta relâmpago` valida preço e quantidade dentro dos limites do canal; `Oferta do dia` valida apenas preço; `Desconto individual` valida intervalo de datas (máx 31 dias); `Campanha vendedor` aceita só `SellingPrice` quando não há percentual fixo na promoção. Quando há `DateDeadline` na promoção, ela precisa estar no futuro.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item", ":idhubproductpromotionitem" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotionitem", "description": "(Required) Identificador do item da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SellingPrice\": 5409.097692801192,\n \"SetQuantityAvailable\": 6056,\n \"DateFrom\": \"1953-11-11T08:38:04.289Z\",\n \"DateTo\": \"1987-04-17T18:33:24.839Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "68046658-ad05-4897-927d-de5c799f91a2", "name": "Anúncio atualizado.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item", ":idhubproductpromotionitem" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotionitem", "description": "(Required) Identificador do item da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"SellingPrice\": 5409.097692801192,\n \"SetQuantityAvailable\": 6056,\n \"DateFrom\": \"1953-11-11T08:38:04.289Z\",\n \"DateTo\": \"1987-04-17T18:33:24.839Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotionItem\": 1182,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9517,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 5421.230944234882,\n \"OriginalPrice\": 3961.4579633172098,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1957-01-13T13:05:32.756Z\",\n \"DateTo\": \"1965-01-18T16:40:09.211Z\",\n \"SellerPercent\": 3909.773075419991,\n \"IntegrationPercent\": 107.153777266491,\n \"MaximumDiscountedPrice\": 2657.816229810006,\n \"MinimumDiscountedPrice\": 1290.1628003535625,\n \"SetQuantityAvailable\": 9889,\n \"MaximumQuantityAvailable\": 3938,\n \"MinimumQuantityAvailable\": 1416,\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 6808,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 8062,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 7309,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 8454.692927392507,\n \"OriginalPrice\": 4884.8553650019185,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1971-01-29T21:44:40.164Z\",\n \"DateTo\": \"2005-05-28T00:32:13.631Z\",\n \"SellerPercent\": 172.33303801879262,\n \"IntegrationPercent\": 1772.6691377360094,\n \"MaximumDiscountedPrice\": 9947.526998156241,\n \"MinimumDiscountedPrice\": 6293.876203570008,\n \"SetQuantityAvailable\": 2333,\n \"MaximumQuantityAvailable\": 7057,\n \"MinimumQuantityAvailable\": 8501,\n \"IDTypeHubProductPromotionStatus\": 5,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 7789,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55b4794a-d6e6-446b-a03f-7ebefa91cfa9", "name": "`[BadRequest] - Item promoção não existe` · `[BadRequest] - Integração não tem recurso de promoção` · `[BadRequest] - Data limite para participar da promoção já terminou` · `[BadRequest] - Tipo de promoção não pertence a integração` · `[BadRequest] - Valor da oferta precisa ser maior que 0` · `[BadRequest] - Valor promocional precisa ser menor que preço base do item` · `[BadRequest] - Valor promocional não pode ser inferior ao valor mínimo do item em campanha, {valor}` · `[BadRequest] - Quantidade disponível precisa ser maior que 0` · `[BadRequest] - Valor da oferta não pode ser menor que valor mínimo de {valor}` · `[BadRequest] - Valor da oferta não pode ser maior que valor maximo de {valor}` · `[BadRequest] - Quantidade de estoque precisa ser maior que {qty}` · `[BadRequest] - Quantidade de estoque precisa ser menor que {qty}` · `[BadRequest] - Intervalo de data tem que ser inferior a 31 dias`.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item", ":idhubproductpromotionitem" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotionitem", "description": "(Required) Identificador do item da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"SellingPrice\": 5409.097692801192,\n \"SetQuantityAvailable\": 6056,\n \"DateFrom\": \"1953-11-11T08:38:04.289Z\",\n \"DateTo\": \"1987-04-17T18:33:24.839Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a116347-8e00-4295-82da-d5488e8c86b2", "name": "Remove anúncio da promoção — Hub Promoções", "request": { "name": "Remove anúncio da promoção — Hub Promoções", "description": { "content": "Remove o anúncio da promoção e dispara sincronização para retirar do canal. Disponível apenas para integrações de promoção (`IDTypeCompanyIntegration = 10`). O item entra em status `Pendente` até o canal confirmar.", "type": "text/plain" }, "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item", ":idhubproductpromotionitem" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotionitem", "description": "(Required) Identificador do item da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "4e7957df-971b-4374-aa4b-c804111015ab", "name": "Anúncio em remoção.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item", ":idhubproductpromotionitem" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotionitem", "description": "(Required) Identificador do item da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductPromotionItem\": 1182,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9517,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 5421.230944234882,\n \"OriginalPrice\": 3961.4579633172098,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1957-01-13T13:05:32.756Z\",\n \"DateTo\": \"1965-01-18T16:40:09.211Z\",\n \"SellerPercent\": 3909.773075419991,\n \"IntegrationPercent\": 107.153777266491,\n \"MaximumDiscountedPrice\": 2657.816229810006,\n \"MinimumDiscountedPrice\": 1290.1628003535625,\n \"SetQuantityAvailable\": 9889,\n \"MaximumQuantityAvailable\": 3938,\n \"MinimumQuantityAvailable\": 1416,\n \"IDTypeHubProductPromotionStatus\": 2,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 6808,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n },\n {\n \"IDHubProductPromotionItem\": 8062,\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 7309,\n \"HubProductName\": \"string\",\n \"MainImageURL\": \"string\",\n \"SellingPrice\": 8454.692927392507,\n \"OriginalPrice\": 4884.8553650019185,\n \"EffectiveDiscountPercent\": \"string\",\n \"DateFrom\": \"1971-01-29T21:44:40.164Z\",\n \"DateTo\": \"2005-05-28T00:32:13.631Z\",\n \"SellerPercent\": 172.33303801879262,\n \"IntegrationPercent\": 1772.6691377360094,\n \"MaximumDiscountedPrice\": 9947.526998156241,\n \"MinimumDiscountedPrice\": 6293.876203570008,\n \"SetQuantityAvailable\": 2333,\n \"MaximumQuantityAvailable\": 7057,\n \"MinimumQuantityAvailable\": 8501,\n \"IDTypeHubProductPromotionStatus\": 5,\n \"TypeHubProductPromotionStatus\": \"string\",\n \"IntegrationStatus\": 7789,\n \"IntegrationStatusName\": \"string\",\n \"IntegrationErrorDescription\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a7049a8-57b9-480f-8c99-aaf4097244ba", "name": "`[BadRequest] - Item promoção não existe` · `[BadRequest] - Integração não tem recurso de promoção`.", "originalRequest": { "url": { "path": [ "hub", "product", "promotion", ":idhubproductpromotion", "item", ":idhubproductpromotionitem" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotion", "description": "(Required) Identificador da promoção de produto no hub." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductpromotionitem", "description": "(Required) Identificador do item da promoção de produto no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4cec3a5-3af2-4079-95c6-6a84b7b3b8f6", "name": "Lista anúncios — Hub Anúncios", "request": { "name": "Lista anúncios — Hub Anúncios", "description": { "content": "Lista os anúncios (ofertas publicadas nos canais de venda) da empresa autenticada, agrupados por anúncio. Cada item traz o produto vinculado, canal, status, qualidade, preços e o array `HubSku` com as variações. Use `GroupByHubSku=1` para receber uma linha por variação em vez de uma por anúncio. Página de até 400 registros.", "type": "text/plain" }, "url": { "path": [ "hub", "product" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "2232", "description": "Página (cada página = 400 registros)." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca textual em código/nome do produto, código do anúncio (`IDProductHub`), código de referência (`IDSkuCompany`) e código de variação (`IDSkuHub`)." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra por integração (conta de canal) específica." }, { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "1603", "description": "Filtra por tipo de canal (ex.: Mercado Livre, Shopee)." }, { "disabled": false, "key": "IDSalesChannel", "value": "1603", "description": "Filtra por canal de vendas." }, { "disabled": false, "key": "IDProduct", "value": "1603", "description": "Filtra pelo SKU/produto vinculado." }, { "disabled": false, "key": "IDSku", "value": "1603", "description": "Filtra anúncios que contenham este SKU em alguma variação." }, { "disabled": false, "key": "IDProductCompany", "value": "string", "description": "Filtra pelo código de referência do produto (`IDSkuCompany`)." }, { "disabled": false, "key": "IDSkuCompany", "value": "string", "description": "Filtra pelo código de referência da variação." }, { "disabled": false, "key": "IDHubProduct", "value": "1603", "description": "Filtra pelo identificador interno do anúncio." }, { "disabled": false, "key": "IDProductHub", "value": "string", "description": "Filtra pelo código do anúncio no canal (ex.: `MLB123456789`)." }, { "disabled": false, "key": "IDSkuHub", "value": "string", "description": "Filtra pelo código da variação no canal." }, { "disabled": false, "key": "SkuName", "value": "string", "description": "Filtra pelo nome do produto (busca parcial)." }, { "disabled": false, "key": "BarCode", "value": "string", "description": "Filtra pelo código de barras." }, { "disabled": false, "key": "IDBrand", "value": "1603", "description": "Filtra pela marca." }, { "disabled": false, "key": "IDTypeSku", "value": "1603", "description": "Filtra pelo tipo de produto." }, { "disabled": false, "key": "IDStatus", "value": "1603", "description": "Filtra pelo status do anúncio (`AdvertisementStatus`): `0` Inativo, `1` Ativo, `2` Fechado, `3` Pausado, `4` Em revisão, `5` Inabilitado canal." }, { "disabled": false, "key": "HubProductSubStatus", "value": "2232", "description": "Filtra pelo sub-status (mesma tabela de status)." }, { "disabled": false, "key": "Published", "value": "2232", "description": "`1` somente publicados no canal (com `IDProductHub`), `0` somente não publicados." }, { "disabled": false, "key": "HasProduct", "value": "2232", "description": "`1` somente anúncios vinculados a um produto, `0` somente sem vínculo." }, { "disabled": false, "key": "HasSku", "value": "2232", "description": "`1` somente anúncios com variação vinculada, `0` somente sem." }, { "disabled": false, "key": "HasManualPrice", "value": "2232", "description": "`1` somente anúncios com preço manual em alguma variação, `0` somente sem." }, { "disabled": false, "key": "Health", "value": "478.75460817372374", "description": "Valor de qualidade do anúncio (%) usado com `HealthType`." }, { "disabled": false, "key": "HealthType", "value": "string", "description": "Comparador da qualidade: `greater` (maior que `Health`) ou `smaller` (menor que `Health`)." }, { "disabled": false, "key": "AutopartsPendingCompatibility", "value": "2232", "description": "Autopeças: `1` somente anúncios com compatibilidade pendente." }, { "disabled": false, "key": "AutopartsRequiredCompatibility", "value": "2232", "description": "Autopeças: `1` somente anúncios que exigem lista de compatibilidade." }, { "disabled": false, "key": "GroupByHubSku", "value": "2232", "description": "`1` retorna uma linha por variação (item) em vez de uma por anúncio." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6c33b112-103a-423d-9a52-6bc174f1c2ca", "name": "Lista de anúncios (ou de variações quando `GroupByHubSku=1`).", "originalRequest": { "url": { "path": [ "hub", "product" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "2232" }, { "key": "Search", "value": "string" }, { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "IDSalesChannel", "value": "1603" }, { "key": "IDProduct", "value": "1603" }, { "key": "IDSku", "value": "1603" }, { "key": "IDProductCompany", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "IDHubProduct", "value": "1603" }, { "key": "IDProductHub", "value": "string" }, { "key": "IDSkuHub", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "IDBrand", "value": "1603" }, { "key": "IDTypeSku", "value": "1603" }, { "key": "IDStatus", "value": "1603" }, { "key": "HubProductSubStatus", "value": "2232" }, { "key": "Published", "value": "2232" }, { "key": "HasProduct", "value": "2232" }, { "key": "HasSku", "value": "2232" }, { "key": "HasManualPrice", "value": "2232" }, { "key": "Health", "value": "478.75460817372374" }, { "key": "HealthType", "value": "string" }, { "key": "AutopartsPendingCompatibility", "value": "2232" }, { "key": "AutopartsRequiredCompatibility", "value": "2232" }, { "key": "GroupByHubSku", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProduct\": 2812,\n \"IDCompanyIntegration\": 2498,\n \"AccountName\": \"string\",\n \"IDProduct\": 9669,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"Brand\": \"string\",\n \"IDBrand\": 4587,\n \"IDTypeSku\": 458,\n \"TypeProduct\": \"string\",\n \"SalesChannelName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 5570,\n \"LogoUrl\": \"string\",\n \"CategoryId\": \"string\",\n \"AdvertisementStatus\": 6786,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 6345,\n \"SubStatus\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"gold_special\",\n \"ListingTypeDescription\": \"string\",\n \"Health\": 4031.5712719601415,\n \"PriceListSet\": 4182.829243558128,\n \"PriceSellSet\": 6098.855323276697,\n \"ShippingFree\": true,\n \"ShippingMode\": \"not_specified\",\n \"ShippingLocalPickUp\": false,\n \"ShippingLogisticType\": \"string\",\n \"ShippingLogisticValue\": \"string\",\n \"ShippingTags\": \"string\",\n \"ShippingTagsValue\": \"string\",\n \"OfficialStore\": \"string\",\n \"WarrantyTime\": 468,\n \"WarrantyTimeType\": \"string\",\n \"ShowWithoutStock\": true,\n \"LeadTimeDays\": 6818,\n \"Catalog\": \"string\",\n \"CatalogListing\": true,\n \"CatalogEligible\": true,\n \"CatalogStatus\": \"string\",\n \"CatalogStatusValue\": \"string\",\n \"AutopartsPendingCompatibility\": 5770,\n \"AutopartsRequiredCompatibility\": 1229,\n \"AutopartsUniversalCompatibility\": 8770,\n \"HubProductAutopartsQuantity\": 7326,\n \"PurchaseExperienceValue\": 6001.936870098437,\n \"IDHubProductQuestionAnswerTemplate\": 8555,\n \"AnswerTitle\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 379,\n \"IDSku\": 4719,\n \"IDSkuHub\": \"string\",\n \"PricingCheck\": 2048.723868779616,\n \"PricingSet\": 1964.2253121959418,\n \"OriginalPrice\": 9983.2310219657,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 738,\n \"PurchaseExperienceValue\": 2335.318077479549,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDHubAdvertisement\": 1478,\n \"IDSku\": 4656,\n \"IDSkuHub\": \"string\",\n \"PricingCheck\": 3494.5040815075745,\n \"PricingSet\": 7582.037109358328,\n \"OriginalPrice\": 2597.812688677097,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 5151,\n \"PurchaseExperienceValue\": 4995.04615305147,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"AccountName\": \"string\"\n }\n ]\n },\n {\n \"IDHubProduct\": 257,\n \"IDCompanyIntegration\": 6171,\n \"AccountName\": \"string\",\n \"IDProduct\": 1902,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"Brand\": \"string\",\n \"IDBrand\": 6083,\n \"IDTypeSku\": 7972,\n \"TypeProduct\": \"string\",\n \"SalesChannelName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1300,\n \"LogoUrl\": \"string\",\n \"CategoryId\": \"string\",\n \"AdvertisementStatus\": 6820,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 5421,\n \"SubStatus\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"silver\",\n \"ListingTypeDescription\": \"string\",\n \"Health\": 9785.670148600891,\n \"PriceListSet\": 7998.44777090017,\n \"PriceSellSet\": 995.676545556834,\n \"ShippingFree\": true,\n \"ShippingMode\": \"me2\",\n \"ShippingLocalPickUp\": false,\n \"ShippingLogisticType\": \"string\",\n \"ShippingLogisticValue\": \"string\",\n \"ShippingTags\": \"string\",\n \"ShippingTagsValue\": \"string\",\n \"OfficialStore\": \"string\",\n \"WarrantyTime\": 9806,\n \"WarrantyTimeType\": \"string\",\n \"ShowWithoutStock\": false,\n \"LeadTimeDays\": 6143,\n \"Catalog\": \"string\",\n \"CatalogListing\": false,\n \"CatalogEligible\": false,\n \"CatalogStatus\": \"string\",\n \"CatalogStatusValue\": \"string\",\n \"AutopartsPendingCompatibility\": 153,\n \"AutopartsRequiredCompatibility\": 3863,\n \"AutopartsUniversalCompatibility\": 4349,\n \"HubProductAutopartsQuantity\": 8155,\n \"PurchaseExperienceValue\": 3526.029470130647,\n \"IDHubProductQuestionAnswerTemplate\": 7774,\n \"AnswerTitle\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 9137,\n \"IDSku\": 3917,\n \"IDSkuHub\": \"string\",\n \"PricingCheck\": 4930.93468113369,\n \"PricingSet\": 2531.022032705523,\n \"OriginalPrice\": 7174.069057280932,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 1402,\n \"PurchaseExperienceValue\": 2060.16602292751,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDHubAdvertisement\": 4924,\n \"IDSku\": 6154,\n \"IDSkuHub\": \"string\",\n \"PricingCheck\": 5738.636334623579,\n \"PricingSet\": 8145.075609649683,\n \"OriginalPrice\": 6092.261956647389,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4169,\n \"PurchaseExperienceValue\": 1112.4465484785562,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"AccountName\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ca059cd-2a70-4465-8ab7-bca6d48ed71f", "name": "Cria anúncio — Hub Anúncios", "request": { "name": "Cria anúncio — Hub Anúncios", "description": { "content": "Cria um anúncio para um produto em uma integração (canal). O anúncio nasce pendente de sincronização — um processo assíncrono o envia ao canal. As variações (`HubSku`) são geradas automaticamente a partir do produto: para um produto com grade de variação, uma variação por componente; caso contrário, uma única variação.\n\nOs campos disponíveis dependem do canal — itens como `ListingTypeId`, `ShippingMode`, `OfficialStore` e preço por quantidade são específicos do Mercado Livre.\n\nPara **duplicar** um anúncio existente, informe a query string `IDHubProduct` com o anúncio de origem (e `IDCompanyIntegration` no corpo com o canal de destino); nesse fluxo os arrays `HubSku`, `Autoparts`, `HubProductSpecification` e `HubProductSalesPolicy` são copiados.", "type": "text/plain" }, "url": { "path": [ "hub", "product" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDHubProduct", "value": "1603", "description": "Anúncio de origem a duplicar. Quando informado, o corpo é montado a partir desse anúncio." }, { "disabled": false, "key": "IgnoreHubSku", "value": "2232", "description": "`1` não cria automaticamente as variações (`HubSku`)." }, { "disabled": false, "key": "NoInvoke", "value": "2232", "description": "`1` retorna apenas a string `\"sucesso\"` em vez do anúncio criado." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 2549,\n \"IDProduct\": 6919,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"CategoryId\": \"string\",\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 7832,\n \"ListingTypeId\": \"bronze\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me2\",\n \"ShippingFree\": true,\n \"ShippingLocalPickUp\": false,\n \"LeadTimeDays\": 2643,\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 8961,\n \"WarrantyTimeType\": \"string\",\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": true,\n \"Visible\": false,\n \"Comments\": \"string\",\n \"IDHubProductQuestionAnswerTemplate\": 9053,\n \"PriceListSet\": 2791.946875177391,\n \"PriceSellSet\": 3057.678036015108,\n \"NetPricingSet\": 2578.0151079513435,\n \"HubProductSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 8783\n },\n {\n \"IDTypeSkuSalesPolicy\": 8085\n }\n ],\n \"PricingSet\": 1681.1392225412992,\n \"HubSku\": [\n {\n \"IDSku\": 3505,\n \"IDCommercialCondition\": 902,\n \"EcommerceModal\": \"string\"\n },\n {\n \"IDSku\": 1228,\n \"IDCommercialCondition\": 4746,\n \"EcommerceModal\": \"string\"\n }\n ],\n \"Autoparts\": [\n {\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"PositionArray\": \"string\"\n },\n {\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"PositionArray\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30b6547b-c828-4a2b-921d-ad77070b0f58", "name": "Anúncio criado (mesma estrutura do GET por id) ou `\"sucesso\"` quando `NoInvoke=1`.", "originalRequest": { "url": { "path": [ "hub", "product" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDHubProduct", "value": "1603" }, { "key": "IgnoreHubSku", "value": "2232" }, { "key": "NoInvoke", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 1242,\n \"IDProduct\": 3787,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"CategoryId\": \"string\",\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 8756,\n \"ListingTypeId\": \"bronze\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingFree\": true,\n \"ShippingLocalPickUp\": true,\n \"LeadTimeDays\": 9239,\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 4565,\n \"WarrantyTimeType\": \"string\",\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": true,\n \"Visible\": false,\n \"Comments\": \"string\",\n \"IDHubProductQuestionAnswerTemplate\": 9922,\n \"PriceListSet\": 3599.3104520566967,\n \"PriceSellSet\": 9705.823375296339,\n \"NetPricingSet\": 8200.790107004592,\n \"HubProductSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 6114\n },\n {\n \"IDTypeSkuSalesPolicy\": 6823\n }\n ],\n \"PricingSet\": 8063.576610905372,\n \"HubSku\": [\n {\n \"IDSku\": 290,\n \"IDCommercialCondition\": 1386,\n \"EcommerceModal\": \"string\"\n },\n {\n \"IDSku\": 526,\n \"IDCommercialCondition\": 6165,\n \"EcommerceModal\": \"string\"\n }\n ],\n \"Autoparts\": [\n {\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"PositionArray\": \"string\"\n },\n {\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"PositionArray\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProduct\": 5116,\n \"IDProduct\": 1667,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 7811,\n \"IDTypeSku\": 5497,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 1288,\n \"IDTypeCompanyIntegration\": 3620,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 1900,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 5313,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 4377,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"free\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"custom\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 8267,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 4551,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 1290.3432225349043,\n \"TotalVisits\": 2150,\n \"SoldQuantity\": 3018,\n \"Rating\": 7683.300238365698,\n \"PurchaseExperienceValue\": 2122.294934744573,\n \"PriceListSet\": 3237.253826454778,\n \"PriceSellSet\": 9269.280081293062,\n \"NetPricingSet\": 9928.24039745151,\n \"NetPricingEligible\": true,\n \"CatalogListing\": false,\n \"CatalogEligible\": false,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1409.833982766393,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": true,\n \"AutopartsUniversalCompatibilityAllowed\": 8216,\n \"AutopartsPendingCompatibility\": true,\n \"AutopartsRequiredCompatibility\": false,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 9933,\n \"HubUserProductEligible\": false,\n \"HubProductQuantityPricingAllowed\": 8662,\n \"IDHubProductQuestionAnswerTemplate\": 7944,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"2009-12-29T13:34:59.547Z\",\n \"RecordTimestamp\": \"1953-04-06T00:40:09.227Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 2699,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 4259,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 4501,\n \"IDImage\": 1183,\n \"ImageOrder\": 3049,\n \"Url\": \"string\",\n \"ImageSize\": 150,\n \"ImageWidth\": 1246,\n \"ImageHeight\": 3790,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 3160,\n \"IDImage\": 9923,\n \"ImageOrder\": 9767,\n \"Url\": \"string\",\n \"ImageSize\": 2449,\n \"ImageWidth\": 8258,\n \"ImageHeight\": 5263,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 3765.028269929147\n },\n {\n \"PurchaseExperienceValue\": 2563.790271219277\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 5032,\n \"IDHubProduct\": 128,\n \"Quantity\": 6688,\n \"Price\": 5457.560453237713,\n \"IDHubProductQuantityPricingB2C\": 1356,\n \"MinPurchaseUnit\": 7014,\n \"DiscountPercentage\": 7727.200586858287\n },\n {\n \"IDHubProductQuantityPricing\": 9808,\n \"IDHubProduct\": 1431,\n \"Quantity\": 1265,\n \"Price\": 6295.041654712119,\n \"IDHubProductQuantityPricingB2C\": 7353,\n \"MinPurchaseUnit\": 8556,\n \"DiscountPercentage\": 9020.849379092431\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 610,\n \"IDHubProduct\": 4949,\n \"IDSku\": 8705,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 3278,\n \"IDTypeSku\": 7005,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 9783.31300729276,\n \"QtyToSell\": 5473.322510286495,\n \"QtySafetyStock\": 320,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 4787,\n \"PricingSet\": 3867.327763046986,\n \"PricingCheck\": 7539.817141373397,\n \"PricingSell\": 4931.770805670132,\n \"PricingList\": 2656.3789625243417,\n \"OriginalPrice\": 4688.912775537593,\n \"PriceMultiplyValue\": 271.35083023500204,\n \"PriceAddValue\": 2800.012416152844,\n \"PriceRounding\": 3113.7348240147267,\n \"CostAverage\": 3964.3366382014024,\n \"CostLastPurchase\": 394.5044255814434,\n \"IDCommercialCondition\": 4896,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"free\",\n \"HubSkuShippingFree\": true,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 5469.604890533144,\n \"IDHubUserProduct\": 6709,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 9388,\n \"IDImage\": 4508,\n \"ImageOrder\": 8140,\n \"Url\": \"string\",\n \"ImageSize\": 2979,\n \"ImageWidth\": 9968,\n \"ImageHeight\": 6674,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 8755\n },\n {\n \"IDHubSkuImage\": 9503,\n \"IDImage\": 9816,\n \"ImageOrder\": 3352,\n \"Url\": \"string\",\n \"ImageSize\": 1757,\n \"ImageWidth\": 2532,\n \"ImageHeight\": 6166,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 5497\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 5934.187491575658\n },\n {\n \"PurchaseExperienceValue\": 9667.749635916276\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 8395,\n \"IDHubProduct\": 5034,\n \"IDSku\": 5595,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 6248,\n \"IDTypeSku\": 6468,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 5856.281798023701,\n \"QtyToSell\": 4498.265829395676,\n \"QtySafetyStock\": 8130,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 484,\n \"PricingSet\": 945.8283860836802,\n \"PricingCheck\": 5486.483615776004,\n \"PricingSell\": 895.4112145270665,\n \"PricingList\": 959.0206722408734,\n \"OriginalPrice\": 849.8469755151139,\n \"PriceMultiplyValue\": 1830.8024002231994,\n \"PriceAddValue\": 8163.761353525356,\n \"PriceRounding\": 4638.692749753593,\n \"CostAverage\": 2051.217277249955,\n \"CostLastPurchase\": 1401.0812702375808,\n \"IDCommercialCondition\": 1197,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"free\",\n \"HubSkuShippingFree\": true,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 5393.779558889709,\n \"IDHubUserProduct\": 5025,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 3263,\n \"IDImage\": 1699,\n \"ImageOrder\": 9650,\n \"Url\": \"string\",\n \"ImageSize\": 422,\n \"ImageWidth\": 6208,\n \"ImageHeight\": 3535,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 7330\n },\n {\n \"IDHubSkuImage\": 2998,\n \"IDImage\": 4834,\n \"ImageOrder\": 7125,\n \"Url\": \"string\",\n \"ImageSize\": 7297,\n \"ImageWidth\": 4509,\n \"ImageHeight\": 6527,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1902\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 4284.6980847029845\n },\n {\n \"PurchaseExperienceValue\": 7099.141173134611\n }\n ]\n }\n ]\n },\n {\n \"IDHubProduct\": 2997,\n \"IDProduct\": 1972,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 2274,\n \"IDTypeSku\": 8445,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 3835,\n \"IDTypeCompanyIntegration\": 726,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 9529,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 4272,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 9596,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"bronze\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 5242,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 7680,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 667.1187101824838,\n \"TotalVisits\": 4274,\n \"SoldQuantity\": 6055,\n \"Rating\": 9665.815822299402,\n \"PurchaseExperienceValue\": 4918.589441274368,\n \"PriceListSet\": 473.873076435396,\n \"PriceSellSet\": 489.8874897814687,\n \"NetPricingSet\": 6060.281395243652,\n \"NetPricingEligible\": true,\n \"CatalogListing\": false,\n \"CatalogEligible\": true,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1068.2590880567777,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": true,\n \"AutopartsUniversalCompatibilityAllowed\": 1037,\n \"AutopartsPendingCompatibility\": true,\n \"AutopartsRequiredCompatibility\": true,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 7071,\n \"HubUserProductEligible\": false,\n \"HubProductQuantityPricingAllowed\": 5984,\n \"IDHubProductQuestionAnswerTemplate\": 494,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1966-05-11T17:04:37.415Z\",\n \"RecordTimestamp\": \"2025-12-03T18:21:39.931Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 3828,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 8752,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 4778,\n \"IDImage\": 9371,\n \"ImageOrder\": 9988,\n \"Url\": \"string\",\n \"ImageSize\": 711,\n \"ImageWidth\": 4832,\n \"ImageHeight\": 7689,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 9360,\n \"IDImage\": 3393,\n \"ImageOrder\": 3309,\n \"Url\": \"string\",\n \"ImageSize\": 449,\n \"ImageWidth\": 7144,\n \"ImageHeight\": 5496,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 8938.378942796751\n },\n {\n \"PurchaseExperienceValue\": 2766.8998467682113\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 9996,\n \"IDHubProduct\": 6226,\n \"Quantity\": 1831,\n \"Price\": 9545.565170570653,\n \"IDHubProductQuantityPricingB2C\": 6552,\n \"MinPurchaseUnit\": 933,\n \"DiscountPercentage\": 9800.652987094374\n },\n {\n \"IDHubProductQuantityPricing\": 1370,\n \"IDHubProduct\": 456,\n \"Quantity\": 1701,\n \"Price\": 4668.454056685651,\n \"IDHubProductQuantityPricingB2C\": 8987,\n \"MinPurchaseUnit\": 4323,\n \"DiscountPercentage\": 7394.980017979656\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 5362,\n \"IDHubProduct\": 2831,\n \"IDSku\": 8253,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 7618,\n \"IDTypeSku\": 9834,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 7674.4340670796655,\n \"QtyToSell\": 7924.671459830563,\n \"QtySafetyStock\": 2790,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 3025,\n \"PricingSet\": 4135.877765409102,\n \"PricingCheck\": 61.06303165506644,\n \"PricingSell\": 8138.1308832585655,\n \"PricingList\": 2794.410045147917,\n \"OriginalPrice\": 9208.539142777328,\n \"PriceMultiplyValue\": 9831.131920269303,\n \"PriceAddValue\": 7374.685168952713,\n \"PriceRounding\": 2064.4245479780498,\n \"CostAverage\": 1626.6669421954848,\n \"CostLastPurchase\": 9376.37609862879,\n \"IDCommercialCondition\": 7561,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"free\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 5686.490762930141,\n \"IDHubUserProduct\": 4946,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5726,\n \"IDImage\": 1569,\n \"ImageOrder\": 9609,\n \"Url\": \"string\",\n \"ImageSize\": 6515,\n \"ImageWidth\": 1461,\n \"ImageHeight\": 8917,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1021\n },\n {\n \"IDHubSkuImage\": 2454,\n \"IDImage\": 5286,\n \"ImageOrder\": 2633,\n \"Url\": \"string\",\n \"ImageSize\": 3971,\n \"ImageWidth\": 394,\n \"ImageHeight\": 7821,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6268\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 9041.417992443132\n },\n {\n \"PurchaseExperienceValue\": 4440.115030127894\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 5280,\n \"IDHubProduct\": 4433,\n \"IDSku\": 3794,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 7619,\n \"IDTypeSku\": 7880,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 8045.907757753333,\n \"QtyToSell\": 9727.532245966113,\n \"QtySafetyStock\": 3726,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 4521,\n \"PricingSet\": 7503.612866999163,\n \"PricingCheck\": 4430.621916336919,\n \"PricingSell\": 9631.911472020718,\n \"PricingList\": 5686.012981985576,\n \"OriginalPrice\": 8784.854444713863,\n \"PriceMultiplyValue\": 4177.903419166049,\n \"PriceAddValue\": 6793.067185935489,\n \"PriceRounding\": 3235.2054583766308,\n \"CostAverage\": 5361.638597525333,\n \"CostLastPurchase\": 3753.8506516302905,\n \"IDCommercialCondition\": 4970,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_premium\",\n \"HubSkuShippingFree\": true,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 255.0475059344648,\n \"IDHubUserProduct\": 626,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 4632,\n \"IDImage\": 7169,\n \"ImageOrder\": 6747,\n \"Url\": \"string\",\n \"ImageSize\": 2588,\n \"ImageWidth\": 3581,\n \"ImageHeight\": 1485,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 4783\n },\n {\n \"IDHubSkuImage\": 8625,\n \"IDImage\": 3777,\n \"ImageOrder\": 8441,\n \"Url\": \"string\",\n \"ImageSize\": 4152,\n \"ImageWidth\": 8265,\n \"ImageHeight\": 7491,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 3868\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 5506.094871268999\n },\n {\n \"PurchaseExperienceValue\": 6891.769854253748\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b497f16-e7aa-41c8-bd07-ab81551ce9ad", "name": "`[BadRequest] - Integração não existe` · `[BadRequest] - Produto não existe` · `[BadRequest] - Produto sem componentes de variação` · `[BadRequest] - Já existe um anúncio com o mesmo código para essa integração` · `[BadRequest] - Template de mensagem não encontrado` · `[BadRequest] - Anúncio para duplicar não encontrado`", "originalRequest": { "url": { "path": [ "hub", "product" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDHubProduct", "value": "1603" }, { "key": "IgnoreHubSku", "value": "2232" }, { "key": "NoInvoke", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 1242,\n \"IDProduct\": 3787,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"CategoryId\": \"string\",\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 8756,\n \"ListingTypeId\": \"bronze\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingFree\": true,\n \"ShippingLocalPickUp\": true,\n \"LeadTimeDays\": 9239,\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 4565,\n \"WarrantyTimeType\": \"string\",\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": true,\n \"Visible\": false,\n \"Comments\": \"string\",\n \"IDHubProductQuestionAnswerTemplate\": 9922,\n \"PriceListSet\": 3599.3104520566967,\n \"PriceSellSet\": 9705.823375296339,\n \"NetPricingSet\": 8200.790107004592,\n \"HubProductSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 6114\n },\n {\n \"IDTypeSkuSalesPolicy\": 6823\n }\n ],\n \"PricingSet\": 8063.576610905372,\n \"HubSku\": [\n {\n \"IDSku\": 290,\n \"IDCommercialCondition\": 1386,\n \"EcommerceModal\": \"string\"\n },\n {\n \"IDSku\": 526,\n \"IDCommercialCondition\": 6165,\n \"EcommerceModal\": \"string\"\n }\n ],\n \"Autoparts\": [\n {\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"PositionArray\": \"string\"\n },\n {\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"PositionArray\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a84425a6-0769-481f-a1c5-aaf5843ab81b", "name": "Detalha anúncio — Hub Anúncios", "request": { "name": "Detalha anúncio — Hub Anúncios", "description": { "content": "Retorna o detalhe completo de um anúncio: dados do canal, categoria, preços, status, qualidade, experiência de compra, avaliação, dados de catálogo, imagens, ficha técnica, variações (`HubSku`) e — para o Mercado Livre — preço por quantidade. A resposta é um array com um único objeto.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "80fe0378-d452-4dd5-b6b5-faa7194d1280", "name": "Detalhe do anúncio (array com um objeto; vazio se não existir).", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProduct\": 6722,\n \"IDProduct\": 5153,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 7804,\n \"IDTypeSku\": 3883,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 8987,\n \"IDTypeCompanyIntegration\": 7778,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 9138,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 8621,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 7870,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"free\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 2088,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 8592,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 5585.899769001375,\n \"TotalVisits\": 9987,\n \"SoldQuantity\": 622,\n \"Rating\": 948.1160572763914,\n \"PurchaseExperienceValue\": 2165.81957488571,\n \"PriceListSet\": 7314.756335335935,\n \"PriceSellSet\": 9837.865156218635,\n \"NetPricingSet\": 9070.177039980832,\n \"NetPricingEligible\": false,\n \"CatalogListing\": false,\n \"CatalogEligible\": false,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1518.9630880793636,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": true,\n \"AutopartsUniversalCompatibilityAllowed\": 1873,\n \"AutopartsPendingCompatibility\": true,\n \"AutopartsRequiredCompatibility\": true,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 4142,\n \"HubUserProductEligible\": true,\n \"HubProductQuantityPricingAllowed\": 6021,\n \"IDHubProductQuestionAnswerTemplate\": 2427,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1997-10-29T08:01:56.486Z\",\n \"RecordTimestamp\": \"2021-10-25T12:40:01.369Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 6348,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 7693,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 3151,\n \"IDImage\": 7223,\n \"ImageOrder\": 252,\n \"Url\": \"string\",\n \"ImageSize\": 5038,\n \"ImageWidth\": 5415,\n \"ImageHeight\": 547,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 6731,\n \"IDImage\": 7488,\n \"ImageOrder\": 3891,\n \"Url\": \"string\",\n \"ImageSize\": 1108,\n \"ImageWidth\": 2975,\n \"ImageHeight\": 5864,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 3299.322767849924\n },\n {\n \"PurchaseExperienceValue\": 2885.7176474231474\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 4490,\n \"IDHubProduct\": 3206,\n \"Quantity\": 7469,\n \"Price\": 6378.371705440877,\n \"IDHubProductQuantityPricingB2C\": 7686,\n \"MinPurchaseUnit\": 2199,\n \"DiscountPercentage\": 4936.589873941663\n },\n {\n \"IDHubProductQuantityPricing\": 7540,\n \"IDHubProduct\": 6120,\n \"Quantity\": 6515,\n \"Price\": 1459.6751626183036,\n \"IDHubProductQuantityPricingB2C\": 7330,\n \"MinPurchaseUnit\": 5718,\n \"DiscountPercentage\": 5664.302687033145\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 8083,\n \"IDHubProduct\": 6594,\n \"IDSku\": 9671,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 263,\n \"IDTypeSku\": 5025,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 9227.30220559089,\n \"QtyToSell\": 662.5848040969151,\n \"QtySafetyStock\": 2412,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 8883,\n \"PricingSet\": 6358.04423954063,\n \"PricingCheck\": 3585.582746734275,\n \"PricingSell\": 490.7125961605852,\n \"PricingList\": 2818.309114085824,\n \"OriginalPrice\": 6113.42953091397,\n \"PriceMultiplyValue\": 4897.970807810388,\n \"PriceAddValue\": 6629.852913827843,\n \"PriceRounding\": 6970.738491624901,\n \"CostAverage\": 3545.2691971491836,\n \"CostLastPurchase\": 2792.1836385718057,\n \"IDCommercialCondition\": 7009,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_premium\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 6938.82597420934,\n \"IDHubUserProduct\": 5149,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 7231,\n \"IDImage\": 5399,\n \"ImageOrder\": 3371,\n \"Url\": \"string\",\n \"ImageSize\": 8498,\n \"ImageWidth\": 4180,\n \"ImageHeight\": 5149,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1002\n },\n {\n \"IDHubSkuImage\": 9600,\n \"IDImage\": 4407,\n \"ImageOrder\": 1343,\n \"Url\": \"string\",\n \"ImageSize\": 1539,\n \"ImageWidth\": 1338,\n \"ImageHeight\": 9957,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 8133\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 2541.456114826892\n },\n {\n \"PurchaseExperienceValue\": 4451.432723962598\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 3766,\n \"IDHubProduct\": 3269,\n \"IDSku\": 239,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 2386,\n \"IDTypeSku\": 5211,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 8305.772420037325,\n \"QtyToSell\": 9859.332994451772,\n \"QtySafetyStock\": 250,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 7028,\n \"PricingSet\": 1205.0267431290495,\n \"PricingCheck\": 5065.755964928109,\n \"PricingSell\": 8345.650552903327,\n \"PricingList\": 1955.3885404546656,\n \"OriginalPrice\": 6489.33055296764,\n \"PriceMultiplyValue\": 5714.585890662312,\n \"PriceAddValue\": 5743.597788144843,\n \"PriceRounding\": 1142.131514094804,\n \"CostAverage\": 9017.884765173116,\n \"CostLastPurchase\": 9080.455488157908,\n \"IDCommercialCondition\": 6952,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_pro\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 9670.86473472076,\n \"IDHubUserProduct\": 8799,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5856,\n \"IDImage\": 3143,\n \"ImageOrder\": 1731,\n \"Url\": \"string\",\n \"ImageSize\": 2627,\n \"ImageWidth\": 6255,\n \"ImageHeight\": 9167,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6011\n },\n {\n \"IDHubSkuImage\": 6011,\n \"IDImage\": 7269,\n \"ImageOrder\": 766,\n \"Url\": \"string\",\n \"ImageSize\": 1676,\n \"ImageWidth\": 7294,\n \"ImageHeight\": 519,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9597\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 155.79477236615568\n },\n {\n \"PurchaseExperienceValue\": 2269.085704839695\n }\n ]\n }\n ]\n },\n {\n \"IDHubProduct\": 3728,\n \"IDProduct\": 79,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 226,\n \"IDTypeSku\": 996,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 733,\n \"IDTypeCompanyIntegration\": 2180,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 6436,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 3023,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 3023,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"silver\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"not_specified\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 7258,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 9133,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 3332.485006572603,\n \"TotalVisits\": 4443,\n \"SoldQuantity\": 9481,\n \"Rating\": 2063.560557228825,\n \"PurchaseExperienceValue\": 4442.729235241598,\n \"PriceListSet\": 3720.666182042782,\n \"PriceSellSet\": 3342.6181017831814,\n \"NetPricingSet\": 9604.809789202804,\n \"NetPricingEligible\": true,\n \"CatalogListing\": false,\n \"CatalogEligible\": true,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1884.9368040799197,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": false,\n \"AutopartsUniversalCompatibilityAllowed\": 1953,\n \"AutopartsPendingCompatibility\": false,\n \"AutopartsRequiredCompatibility\": false,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 9086,\n \"HubUserProductEligible\": false,\n \"HubProductQuantityPricingAllowed\": 1081,\n \"IDHubProductQuestionAnswerTemplate\": 3992,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1996-04-14T01:10:20.246Z\",\n \"RecordTimestamp\": \"1964-06-08T11:58:16.156Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 7880,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 905,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 316,\n \"IDImage\": 4754,\n \"ImageOrder\": 2841,\n \"Url\": \"string\",\n \"ImageSize\": 8175,\n \"ImageWidth\": 5243,\n \"ImageHeight\": 5919,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 8188,\n \"IDImage\": 8803,\n \"ImageOrder\": 8382,\n \"Url\": \"string\",\n \"ImageSize\": 5947,\n \"ImageWidth\": 5898,\n \"ImageHeight\": 633,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 9163.952598621985\n },\n {\n \"PurchaseExperienceValue\": 475.19981328132843\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 3043,\n \"IDHubProduct\": 5431,\n \"Quantity\": 1133,\n \"Price\": 6549.394272760114,\n \"IDHubProductQuantityPricingB2C\": 8068,\n \"MinPurchaseUnit\": 836,\n \"DiscountPercentage\": 7135.182514893832\n },\n {\n \"IDHubProductQuantityPricing\": 1528,\n \"IDHubProduct\": 5702,\n \"Quantity\": 2401,\n \"Price\": 2127.469918080678,\n \"IDHubProductQuantityPricingB2C\": 4557,\n \"MinPurchaseUnit\": 4504,\n \"DiscountPercentage\": 6698.532715617873\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 9123,\n \"IDHubProduct\": 3352,\n \"IDSku\": 3528,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4131,\n \"IDTypeSku\": 955,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 6583.913207316927,\n \"QtyToSell\": 3292.2472290965056,\n \"QtySafetyStock\": 792,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 2613,\n \"PricingSet\": 6096.146377080289,\n \"PricingCheck\": 5105.615865648392,\n \"PricingSell\": 8733.867167826205,\n \"PricingList\": 2334.2365102811777,\n \"OriginalPrice\": 3118.748562369289,\n \"PriceMultiplyValue\": 9312.455985049704,\n \"PriceAddValue\": 2888.5039216805962,\n \"PriceRounding\": 1171.2702204143,\n \"CostAverage\": 6915.43083274061,\n \"CostLastPurchase\": 3166.429662952712,\n \"IDCommercialCondition\": 7457,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"bronze\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 7167.382857735305,\n \"IDHubUserProduct\": 6147,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 2331,\n \"IDImage\": 8461,\n \"ImageOrder\": 1622,\n \"Url\": \"string\",\n \"ImageSize\": 1765,\n \"ImageWidth\": 8075,\n \"ImageHeight\": 5586,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9760\n },\n {\n \"IDHubSkuImage\": 6060,\n \"IDImage\": 2933,\n \"ImageOrder\": 7791,\n \"Url\": \"string\",\n \"ImageSize\": 7520,\n \"ImageWidth\": 3532,\n \"ImageHeight\": 9369,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 5803\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 715.4080617469294\n },\n {\n \"PurchaseExperienceValue\": 8850.96958932822\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 9920,\n \"IDHubProduct\": 7655,\n \"IDSku\": 55,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4614,\n \"IDTypeSku\": 852,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 3301.8476527908615,\n \"QtyToSell\": 5975.0714203374855,\n \"QtySafetyStock\": 8552,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 5082,\n \"PricingSet\": 6141.175576289617,\n \"PricingCheck\": 6883.859558810354,\n \"PricingSell\": 688.0953300553405,\n \"PricingList\": 5218.128716056327,\n \"OriginalPrice\": 131.7210335203889,\n \"PriceMultiplyValue\": 5614.365045722964,\n \"PriceAddValue\": 3582.055545424081,\n \"PriceRounding\": 5371.231782843133,\n \"CostAverage\": 1867.3295724299544,\n \"CostLastPurchase\": 795.2424191921614,\n \"IDCommercialCondition\": 5885,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 20.099136661850814,\n \"IDHubUserProduct\": 7178,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5952,\n \"IDImage\": 3173,\n \"ImageOrder\": 4080,\n \"Url\": \"string\",\n \"ImageSize\": 5646,\n \"ImageWidth\": 2175,\n \"ImageHeight\": 5757,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 4468\n },\n {\n \"IDHubSkuImage\": 9683,\n \"IDImage\": 6622,\n \"ImageOrder\": 2564,\n \"Url\": \"string\",\n \"ImageSize\": 4163,\n \"ImageWidth\": 4542,\n \"ImageHeight\": 4262,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 877\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 6417.869787343764\n },\n {\n \"PurchaseExperienceValue\": 678.802946538033\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6aa2380e-7225-4444-908e-8db00faecf6d", "name": "Atualiza anúncio — Hub Anúncios", "request": { "name": "Atualiza anúncio — Hub Anúncios", "description": { "content": "Atualiza um anúncio (atualização parcial — só os campos enviados são alterados) e reenvia a mudança ao canal de forma assíncrona; com a query string `SyncVariations=1` o endpoint faz outra coisa: ignora o corpo e reconcilia as variações do anúncio com as variações ativas cadastradas no produto, devolvendo o resumo das inclusões e remoções.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "NoInvoke", "value": "2232", "description": "`1` retorna apenas `\"sucesso\"` em vez do anúncio atualizado." }, { "disabled": false, "key": "SyncVariations", "value": "1", "description": "`1` executa apenas a sincronização das variações: o corpo da requisição é ignorado e o anúncio passa a refletir as variações ativas cadastradas hoje no produto — as que faltam são criadas, as que não existem mais no produto (ou cujo SKU foi inativado) são removidas. A resposta traz o resumo da sincronização em vez do anúncio." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6080,\n \"IDProduct\": 3741,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"CategoryId\": \"string\",\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 5672,\n \"ListingTypeId\": \"gold_special\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"custom\",\n \"ShippingFree\": false,\n \"ShippingLocalPickUp\": true,\n \"LeadTimeDays\": 7357,\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 3100,\n \"WarrantyTimeType\": \"string\",\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": false,\n \"Visible\": true,\n \"Comments\": \"string\",\n \"IDHubProductQuestionAnswerTemplate\": 3567,\n \"PriceListSet\": 6769.357532726725,\n \"PriceSellSet\": 7754.115324629684,\n \"NetPricingSet\": 6497.431985006266,\n \"HubProductSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 566\n },\n {\n \"IDTypeSkuSalesPolicy\": 1995\n }\n ],\n \"CatalogProductId\": \"string\",\n \"AutopartsException\": true,\n \"AutopartsUniversalCompatibility\": false,\n \"HubProductImage\": [\n {\n \"IDImage\": 2539,\n \"ImageOrder\": 2975\n },\n {\n \"IDImage\": 6479,\n \"ImageOrder\": 2815\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9a29ed8b-41a6-4e52-a980-a5bdef908934", "name": "Sem `SyncVariations`: anúncio atualizado, mesma estrutura do `GET` por id — ou a string `\"sucesso\"` quando `NoInvoke=1`.\n\nCom `SyncVariations=1` a resposta é um **objeto único** (não array) com:\n- `IDHubProduct` (integer) — identificador do anúncio sincronizado.\n- `TotalUpdates` (integer) — quantidade de variações incluídas mais removidas.\n- `Results` (array) — uma entrada por variação processada, com `AccountName`, `IDSku`, `ActionTitle` (`Adicionar` ou `REMOVER`), `ActionStatus` (`Sucesso` ou `Atenção`) e `ActionMessage` (vazia no sucesso; motivo da falha quando `Atenção`).\n\nFalhas individuais não abortam a sincronização: cada variação problemática vira uma linha com `ActionStatus` `Atenção` e a chamada segue com `200`. `TotalUpdates` `0` com `Results` vazio quando o anúncio não tem produto vinculado ou quando as variações já estão em dia — não é erro.\n\nAs variações criadas herdam o preço manual das variações já existentes no anúncio; se o anúncio tiver preço definido no seu próprio nível, as novas variações nascem sem preço manual. Cada inclusão e cada remoção registra histórico no anúncio e notifica o webhook nos tópicos `OfferSkuPost` e `OfferSkuDelete`.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "2232" }, { "key": "SyncVariations", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 1389,\n \"IDProduct\": 5343,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"CategoryId\": \"string\",\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 6340,\n \"ListingTypeId\": \"gold_special\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingFree\": true,\n \"ShippingLocalPickUp\": true,\n \"LeadTimeDays\": 5380,\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 5911,\n \"WarrantyTimeType\": \"string\",\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": false,\n \"Visible\": true,\n \"Comments\": \"string\",\n \"IDHubProductQuestionAnswerTemplate\": 5580,\n \"PriceListSet\": 996.9936223445463,\n \"PriceSellSet\": 8976.370609725634,\n \"NetPricingSet\": 914.413946506849,\n \"HubProductSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 2084\n },\n {\n \"IDTypeSkuSalesPolicy\": 7777\n }\n ],\n \"CatalogProductId\": \"string\",\n \"AutopartsException\": true,\n \"AutopartsUniversalCompatibility\": true,\n \"HubProductImage\": [\n {\n \"IDImage\": 2091,\n \"ImageOrder\": 6160\n },\n {\n \"IDImage\": 7778,\n \"ImageOrder\": 5286\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProduct\": 6722,\n \"IDProduct\": 5153,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 7804,\n \"IDTypeSku\": 3883,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 8987,\n \"IDTypeCompanyIntegration\": 7778,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 9138,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 8621,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 7870,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"free\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 2088,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 8592,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 5585.899769001375,\n \"TotalVisits\": 9987,\n \"SoldQuantity\": 622,\n \"Rating\": 948.1160572763914,\n \"PurchaseExperienceValue\": 2165.81957488571,\n \"PriceListSet\": 7314.756335335935,\n \"PriceSellSet\": 9837.865156218635,\n \"NetPricingSet\": 9070.177039980832,\n \"NetPricingEligible\": false,\n \"CatalogListing\": false,\n \"CatalogEligible\": false,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1518.9630880793636,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": true,\n \"AutopartsUniversalCompatibilityAllowed\": 1873,\n \"AutopartsPendingCompatibility\": true,\n \"AutopartsRequiredCompatibility\": true,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 4142,\n \"HubUserProductEligible\": true,\n \"HubProductQuantityPricingAllowed\": 6021,\n \"IDHubProductQuestionAnswerTemplate\": 2427,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1997-10-29T08:01:56.486Z\",\n \"RecordTimestamp\": \"2021-10-25T12:40:01.369Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 6348,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 7693,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 3151,\n \"IDImage\": 7223,\n \"ImageOrder\": 252,\n \"Url\": \"string\",\n \"ImageSize\": 5038,\n \"ImageWidth\": 5415,\n \"ImageHeight\": 547,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 6731,\n \"IDImage\": 7488,\n \"ImageOrder\": 3891,\n \"Url\": \"string\",\n \"ImageSize\": 1108,\n \"ImageWidth\": 2975,\n \"ImageHeight\": 5864,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 3299.322767849924\n },\n {\n \"PurchaseExperienceValue\": 2885.7176474231474\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 4490,\n \"IDHubProduct\": 3206,\n \"Quantity\": 7469,\n \"Price\": 6378.371705440877,\n \"IDHubProductQuantityPricingB2C\": 7686,\n \"MinPurchaseUnit\": 2199,\n \"DiscountPercentage\": 4936.589873941663\n },\n {\n \"IDHubProductQuantityPricing\": 7540,\n \"IDHubProduct\": 6120,\n \"Quantity\": 6515,\n \"Price\": 1459.6751626183036,\n \"IDHubProductQuantityPricingB2C\": 7330,\n \"MinPurchaseUnit\": 5718,\n \"DiscountPercentage\": 5664.302687033145\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 8083,\n \"IDHubProduct\": 6594,\n \"IDSku\": 9671,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 263,\n \"IDTypeSku\": 5025,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 9227.30220559089,\n \"QtyToSell\": 662.5848040969151,\n \"QtySafetyStock\": 2412,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 8883,\n \"PricingSet\": 6358.04423954063,\n \"PricingCheck\": 3585.582746734275,\n \"PricingSell\": 490.7125961605852,\n \"PricingList\": 2818.309114085824,\n \"OriginalPrice\": 6113.42953091397,\n \"PriceMultiplyValue\": 4897.970807810388,\n \"PriceAddValue\": 6629.852913827843,\n \"PriceRounding\": 6970.738491624901,\n \"CostAverage\": 3545.2691971491836,\n \"CostLastPurchase\": 2792.1836385718057,\n \"IDCommercialCondition\": 7009,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_premium\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 6938.82597420934,\n \"IDHubUserProduct\": 5149,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 7231,\n \"IDImage\": 5399,\n \"ImageOrder\": 3371,\n \"Url\": \"string\",\n \"ImageSize\": 8498,\n \"ImageWidth\": 4180,\n \"ImageHeight\": 5149,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1002\n },\n {\n \"IDHubSkuImage\": 9600,\n \"IDImage\": 4407,\n \"ImageOrder\": 1343,\n \"Url\": \"string\",\n \"ImageSize\": 1539,\n \"ImageWidth\": 1338,\n \"ImageHeight\": 9957,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 8133\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 2541.456114826892\n },\n {\n \"PurchaseExperienceValue\": 4451.432723962598\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 3766,\n \"IDHubProduct\": 3269,\n \"IDSku\": 239,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 2386,\n \"IDTypeSku\": 5211,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 8305.772420037325,\n \"QtyToSell\": 9859.332994451772,\n \"QtySafetyStock\": 250,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 7028,\n \"PricingSet\": 1205.0267431290495,\n \"PricingCheck\": 5065.755964928109,\n \"PricingSell\": 8345.650552903327,\n \"PricingList\": 1955.3885404546656,\n \"OriginalPrice\": 6489.33055296764,\n \"PriceMultiplyValue\": 5714.585890662312,\n \"PriceAddValue\": 5743.597788144843,\n \"PriceRounding\": 1142.131514094804,\n \"CostAverage\": 9017.884765173116,\n \"CostLastPurchase\": 9080.455488157908,\n \"IDCommercialCondition\": 6952,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_pro\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 9670.86473472076,\n \"IDHubUserProduct\": 8799,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5856,\n \"IDImage\": 3143,\n \"ImageOrder\": 1731,\n \"Url\": \"string\",\n \"ImageSize\": 2627,\n \"ImageWidth\": 6255,\n \"ImageHeight\": 9167,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6011\n },\n {\n \"IDHubSkuImage\": 6011,\n \"IDImage\": 7269,\n \"ImageOrder\": 766,\n \"Url\": \"string\",\n \"ImageSize\": 1676,\n \"ImageWidth\": 7294,\n \"ImageHeight\": 519,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9597\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 155.79477236615568\n },\n {\n \"PurchaseExperienceValue\": 2269.085704839695\n }\n ]\n }\n ]\n },\n {\n \"IDHubProduct\": 3728,\n \"IDProduct\": 79,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 226,\n \"IDTypeSku\": 996,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 733,\n \"IDTypeCompanyIntegration\": 2180,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 6436,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 3023,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 3023,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"silver\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"not_specified\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 7258,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 9133,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 3332.485006572603,\n \"TotalVisits\": 4443,\n \"SoldQuantity\": 9481,\n \"Rating\": 2063.560557228825,\n \"PurchaseExperienceValue\": 4442.729235241598,\n \"PriceListSet\": 3720.666182042782,\n \"PriceSellSet\": 3342.6181017831814,\n \"NetPricingSet\": 9604.809789202804,\n \"NetPricingEligible\": true,\n \"CatalogListing\": false,\n \"CatalogEligible\": true,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1884.9368040799197,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": false,\n \"AutopartsUniversalCompatibilityAllowed\": 1953,\n \"AutopartsPendingCompatibility\": false,\n \"AutopartsRequiredCompatibility\": false,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 9086,\n \"HubUserProductEligible\": false,\n \"HubProductQuantityPricingAllowed\": 1081,\n \"IDHubProductQuestionAnswerTemplate\": 3992,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1996-04-14T01:10:20.246Z\",\n \"RecordTimestamp\": \"1964-06-08T11:58:16.156Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 7880,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 905,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 316,\n \"IDImage\": 4754,\n \"ImageOrder\": 2841,\n \"Url\": \"string\",\n \"ImageSize\": 8175,\n \"ImageWidth\": 5243,\n \"ImageHeight\": 5919,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 8188,\n \"IDImage\": 8803,\n \"ImageOrder\": 8382,\n \"Url\": \"string\",\n \"ImageSize\": 5947,\n \"ImageWidth\": 5898,\n \"ImageHeight\": 633,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 9163.952598621985\n },\n {\n \"PurchaseExperienceValue\": 475.19981328132843\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 3043,\n \"IDHubProduct\": 5431,\n \"Quantity\": 1133,\n \"Price\": 6549.394272760114,\n \"IDHubProductQuantityPricingB2C\": 8068,\n \"MinPurchaseUnit\": 836,\n \"DiscountPercentage\": 7135.182514893832\n },\n {\n \"IDHubProductQuantityPricing\": 1528,\n \"IDHubProduct\": 5702,\n \"Quantity\": 2401,\n \"Price\": 2127.469918080678,\n \"IDHubProductQuantityPricingB2C\": 4557,\n \"MinPurchaseUnit\": 4504,\n \"DiscountPercentage\": 6698.532715617873\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 9123,\n \"IDHubProduct\": 3352,\n \"IDSku\": 3528,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4131,\n \"IDTypeSku\": 955,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 6583.913207316927,\n \"QtyToSell\": 3292.2472290965056,\n \"QtySafetyStock\": 792,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 2613,\n \"PricingSet\": 6096.146377080289,\n \"PricingCheck\": 5105.615865648392,\n \"PricingSell\": 8733.867167826205,\n \"PricingList\": 2334.2365102811777,\n \"OriginalPrice\": 3118.748562369289,\n \"PriceMultiplyValue\": 9312.455985049704,\n \"PriceAddValue\": 2888.5039216805962,\n \"PriceRounding\": 1171.2702204143,\n \"CostAverage\": 6915.43083274061,\n \"CostLastPurchase\": 3166.429662952712,\n \"IDCommercialCondition\": 7457,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"bronze\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 7167.382857735305,\n \"IDHubUserProduct\": 6147,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 2331,\n \"IDImage\": 8461,\n \"ImageOrder\": 1622,\n \"Url\": \"string\",\n \"ImageSize\": 1765,\n \"ImageWidth\": 8075,\n \"ImageHeight\": 5586,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9760\n },\n {\n \"IDHubSkuImage\": 6060,\n \"IDImage\": 2933,\n \"ImageOrder\": 7791,\n \"Url\": \"string\",\n \"ImageSize\": 7520,\n \"ImageWidth\": 3532,\n \"ImageHeight\": 9369,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 5803\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 715.4080617469294\n },\n {\n \"PurchaseExperienceValue\": 8850.96958932822\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 9920,\n \"IDHubProduct\": 7655,\n \"IDSku\": 55,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4614,\n \"IDTypeSku\": 852,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 3301.8476527908615,\n \"QtyToSell\": 5975.0714203374855,\n \"QtySafetyStock\": 8552,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 5082,\n \"PricingSet\": 6141.175576289617,\n \"PricingCheck\": 6883.859558810354,\n \"PricingSell\": 688.0953300553405,\n \"PricingList\": 5218.128716056327,\n \"OriginalPrice\": 131.7210335203889,\n \"PriceMultiplyValue\": 5614.365045722964,\n \"PriceAddValue\": 3582.055545424081,\n \"PriceRounding\": 5371.231782843133,\n \"CostAverage\": 1867.3295724299544,\n \"CostLastPurchase\": 795.2424191921614,\n \"IDCommercialCondition\": 5885,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 20.099136661850814,\n \"IDHubUserProduct\": 7178,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5952,\n \"IDImage\": 3173,\n \"ImageOrder\": 4080,\n \"Url\": \"string\",\n \"ImageSize\": 5646,\n \"ImageWidth\": 2175,\n \"ImageHeight\": 5757,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 4468\n },\n {\n \"IDHubSkuImage\": 9683,\n \"IDImage\": 6622,\n \"ImageOrder\": 2564,\n \"Url\": \"string\",\n \"ImageSize\": 4163,\n \"ImageWidth\": 4542,\n \"ImageHeight\": 4262,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 877\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 6417.869787343764\n },\n {\n \"PurchaseExperienceValue\": 678.802946538033\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83ad1c1-8458-4276-9768-1fccf7b80629", "name": "`[BadRequest] - Produto Hub não existe` · `[BadRequest] - Produto/Sku não existe` · `[BadRequest] - Integração não existe` · `[BadRequest] - Já existe uma anuncio igual para a mesma integração` · `[BadRequest] - Não pode ser alterada a categoria, pois já houve venda do anúncio` · `[BadRequest] - Variação anúncio tem preço manual setado. Remover antes de atualizar o preço a nível de anúncio` · `[BadRequest] - Template de mensagem não encontrado`\n\nNo modo `SyncVariations=1` o único erro possível é `[BadRequest] - Produto Hub não existe`: as demais mensagens dependem da validação do corpo, que não chega a rodar.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "2232" }, { "key": "SyncVariations", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 1389,\n \"IDProduct\": 5343,\n \"IDProductHub\": \"string\",\n \"HubProductName\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"CategoryId\": \"string\",\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 6340,\n \"ListingTypeId\": \"gold_special\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingFree\": true,\n \"ShippingLocalPickUp\": true,\n \"LeadTimeDays\": 5380,\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 5911,\n \"WarrantyTimeType\": \"string\",\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": false,\n \"Visible\": true,\n \"Comments\": \"string\",\n \"IDHubProductQuestionAnswerTemplate\": 5580,\n \"PriceListSet\": 996.9936223445463,\n \"PriceSellSet\": 8976.370609725634,\n \"NetPricingSet\": 914.413946506849,\n \"HubProductSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 2084\n },\n {\n \"IDTypeSkuSalesPolicy\": 7777\n }\n ],\n \"CatalogProductId\": \"string\",\n \"AutopartsException\": true,\n \"AutopartsUniversalCompatibility\": true,\n \"HubProductImage\": [\n {\n \"IDImage\": 2091,\n \"ImageOrder\": 6160\n },\n {\n \"IDImage\": 7778,\n \"ImageOrder\": 5286\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b3135c9-2ab2-496d-9c5f-7423edc632b9", "name": "Exclui anúncio — Hub Anúncios", "request": { "name": "Exclui anúncio — Hub Anúncios", "description": { "content": "Exclui o anúncio e suas variações do cadastro e comunica a remoção ao canal de forma assíncrona. Dependendo do canal e do status, o anúncio pode permanecer no marketplace (encerrado em vez de apagado).", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "26a89ad5-2798-4ebe-a3b1-bd5ce669ced7", "name": "Anúncio excluído.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4d8622-c475-402d-aa3d-b30b07bc232a", "name": "`[BadRequest] - Anúncio não existe` · `[BadRequest] - Erro ao deletar anúncio`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0dace6ca-d687-499b-b0f9-fa3a0d0bfc63", "name": "Lista compatibilidade de autopeças — Hub Anúncios", "request": { "name": "Lista compatibilidade de autopeças — Hub Anúncios", "description": { "content": "Lista os veículos compatíveis associados ao anúncio de autopeças (marca, modelo, ano, versão e demais atributos do veículo), as posições de aplicação e eventuais reclamações de compatibilidade registradas pelos compradores. Recurso específico de autopeças (principalmente Mercado Livre).", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4e905a31-1e21-4bc3-bd5b-c537f06b9b9f", "name": "Veículos compatíveis (array vazio se não houver).", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductAutoparts\": 5623,\n \"IDHubProduct\": 8075,\n \"IDCompanyIntegration\": 6078,\n \"IDProductHub\": \"string\",\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"Trim\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"IDHubOrderClaim\": 3746,\n \"IDOrder\": 8941,\n \"ClaimQuantity\": 7027,\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n },\n {\n \"IDHubProductAutoparts\": 7925,\n \"IDHubProduct\": 2391,\n \"IDCompanyIntegration\": 6347,\n \"IDProductHub\": \"string\",\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"Trim\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"IDHubOrderClaim\": 6353,\n \"IDOrder\": 4507,\n \"ClaimQuantity\": 4813,\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f0fdc2b-94e3-4e9d-9a66-1151d801f64d", "name": "Adiciona veículo compatível — Hub Anúncios", "request": { "name": "Adiciona veículo compatível — Hub Anúncios", "description": { "content": "Associa um veículo (compatibilidade) ao anúncio de autopeças. Os atributos do veículo (`Brand`, `Model`, `Year`, etc.) só são usados para cadastrar o veículo no catálogo do canal quando ele ainda não existe; em geral basta o `ProductId` do veículo.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "NoInvoke", "value": "2232", "description": "`1` retorna apenas `\"sucesso\"` em vez da lista atualizada." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"Trim\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "27999098-23f5-44b3-bc17-ed6f3289f2eb", "name": "Lista de veículos compatíveis atualizada ou `\"sucesso\"` quando `NoInvoke=1`.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"Trim\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductAutoparts\": 1967,\n \"IDHubProduct\": 3226,\n \"IDCompanyIntegration\": 2161,\n \"IDProductHub\": \"string\",\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"Trim\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"IDHubOrderClaim\": 6424,\n \"IDOrder\": 6073,\n \"ClaimQuantity\": 1256,\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n },\n {\n \"IDHubProductAutoparts\": 7512,\n \"IDHubProduct\": 6759,\n \"IDCompanyIntegration\": 5749,\n \"IDProductHub\": \"string\",\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"Trim\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"IDHubOrderClaim\": 4435,\n \"IDOrder\": 8880,\n \"ClaimQuantity\": 872,\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82fa7f3f-daca-4b58-86c5-0f3c6e1aab23", "name": "`[BadRequest] - Anúncio não existe` · `[BadRequest] - este veículo já existe no anúncio`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"Trim\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ba3b33f-8f9c-4459-9dd9-52549739ea93", "name": "Atualiza veículo compatível — Hub Anúncios", "request": { "name": "Atualiza veículo compatível — Hub Anúncios", "description": { "content": "Atualiza as observações e as posições de aplicação de um veículo compatível do anúncio de autopeças.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts", ":idhubproductautoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductautoparts", "description": "(Required) Identificador do veículo compatível." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Notes\": \"string\",\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7fd049ce-ac40-4a40-be72-1cbe2ce472aa", "name": "Lista de veículos compatíveis atualizada.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts", ":idhubproductautoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductautoparts", "description": "(Required) Identificador do veículo compatível." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Notes\": \"string\",\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductAutoparts\": 1967,\n \"IDHubProduct\": 3226,\n \"IDCompanyIntegration\": 2161,\n \"IDProductHub\": \"string\",\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"Trim\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"IDHubOrderClaim\": 6424,\n \"IDOrder\": 6073,\n \"ClaimQuantity\": 1256,\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n },\n {\n \"IDHubProductAutoparts\": 7512,\n \"IDHubProduct\": 6759,\n \"IDCompanyIntegration\": 5749,\n \"IDProductHub\": \"string\",\n \"ProductId\": \"string\",\n \"Notes\": \"string\",\n \"Brand\": \"string\",\n \"Model\": \"string\",\n \"Year\": \"string\",\n \"Trim\": \"string\",\n \"ShortVersion\": \"string\",\n \"Engine\": \"string\",\n \"Fuel\": \"string\",\n \"Power\": \"string\",\n \"BodyType\": \"string\",\n \"Transmission\": \"string\",\n \"Gear\": \"string\",\n \"Doors\": \"string\",\n \"Steering\": \"string\",\n \"Traction\": \"string\",\n \"Valves\": \"string\",\n \"IDHubOrderClaim\": 4435,\n \"IDOrder\": 8880,\n \"ClaimQuantity\": 872,\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32c810ee-90fe-4cfa-954f-a88b2af94c34", "name": "`[BadRequest] - Autopartes anúncio não existe`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts", ":idhubproductautoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductautoparts", "description": "(Required) Identificador do veículo compatível." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Notes\": \"string\",\n \"HubProductAutopartsPosition\": [\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"SpecificationValue\": [\n \"string\",\n \"string\"\n ],\n \"IDSpecificationValue\": [\n \"string\",\n \"string\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a17284c-1ac1-4745-b866-ce9da7c5167c", "name": "Remove veículo compatível — Hub Anúncios", "request": { "name": "Remove veículo compatível — Hub Anúncios", "description": { "content": "Remove um veículo compatível (e suas posições) do anúncio de autopeças.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts", ":idhubproductautoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductautoparts", "description": "(Required) Identificador do veículo compatível." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "727a4cdd-1b4b-4987-a164-6289a02a1d98", "name": "Veículo removido.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts", ":idhubproductautoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductautoparts", "description": "(Required) Identificador do veículo compatível." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d54d834d-a97c-4d8b-b588-672a9858db69", "name": "`[BadRequest] - Autopartes anúncio não existe`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "autoparts", ":idhubproductautoparts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductautoparts", "description": "(Required) Identificador do veículo compatível." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff144fd2-572c-4237-956f-a863b92fc008", "name": "Adiciona variação ao anúncio — Hub Anúncios", "request": { "name": "Adiciona variação ao anúncio — Hub Anúncios", "description": { "content": "Adiciona uma variação (item) ao anúncio, vinculando um SKU. Aceita preço manual da variação (`PricingSet`), ficha técnica e ordem da variação. O preço da variação não pode coexistir com o preço a nível de anúncio.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "offer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "NoInvoke", "value": "2232", "description": "`1` retorna apenas `\"sucesso\"` em vez do anúncio atualizado." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSku\": 259,\n \"IDSkuHub\": \"string\",\n \"PricingSet\": 2285.067494768638,\n \"HubSkuOrder\": 6616,\n \"Comments\": \"string\",\n \"HubSkuListingTypeId\": \"gold_special\",\n \"HubSkuShippingFree\": false,\n \"EcommerceModal\": \"string\",\n \"IDCommercialCondition\": 5599,\n \"HubSkuSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "061a87c8-5209-4f3a-a05e-22afb34a807a", "name": "Anúncio atualizado (mesma estrutura do GET por id) ou `\"sucesso\"` quando `NoInvoke=1`.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "offer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 4314,\n \"IDSkuHub\": \"string\",\n \"PricingSet\": 4221.2515525212675,\n \"HubSkuOrder\": 1078,\n \"Comments\": \"string\",\n \"HubSkuListingTypeId\": \"gold_special\",\n \"HubSkuShippingFree\": true,\n \"EcommerceModal\": \"string\",\n \"IDCommercialCondition\": 3784,\n \"HubSkuSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProduct\": 6722,\n \"IDProduct\": 5153,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 7804,\n \"IDTypeSku\": 3883,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 8987,\n \"IDTypeCompanyIntegration\": 7778,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 9138,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 8621,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 7870,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"free\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 2088,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 8592,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 5585.899769001375,\n \"TotalVisits\": 9987,\n \"SoldQuantity\": 622,\n \"Rating\": 948.1160572763914,\n \"PurchaseExperienceValue\": 2165.81957488571,\n \"PriceListSet\": 7314.756335335935,\n \"PriceSellSet\": 9837.865156218635,\n \"NetPricingSet\": 9070.177039980832,\n \"NetPricingEligible\": false,\n \"CatalogListing\": false,\n \"CatalogEligible\": false,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1518.9630880793636,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": true,\n \"AutopartsUniversalCompatibilityAllowed\": 1873,\n \"AutopartsPendingCompatibility\": true,\n \"AutopartsRequiredCompatibility\": true,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 4142,\n \"HubUserProductEligible\": true,\n \"HubProductQuantityPricingAllowed\": 6021,\n \"IDHubProductQuestionAnswerTemplate\": 2427,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1997-10-29T08:01:56.486Z\",\n \"RecordTimestamp\": \"2021-10-25T12:40:01.369Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 6348,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 7693,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 3151,\n \"IDImage\": 7223,\n \"ImageOrder\": 252,\n \"Url\": \"string\",\n \"ImageSize\": 5038,\n \"ImageWidth\": 5415,\n \"ImageHeight\": 547,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 6731,\n \"IDImage\": 7488,\n \"ImageOrder\": 3891,\n \"Url\": \"string\",\n \"ImageSize\": 1108,\n \"ImageWidth\": 2975,\n \"ImageHeight\": 5864,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 3299.322767849924\n },\n {\n \"PurchaseExperienceValue\": 2885.7176474231474\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 4490,\n \"IDHubProduct\": 3206,\n \"Quantity\": 7469,\n \"Price\": 6378.371705440877,\n \"IDHubProductQuantityPricingB2C\": 7686,\n \"MinPurchaseUnit\": 2199,\n \"DiscountPercentage\": 4936.589873941663\n },\n {\n \"IDHubProductQuantityPricing\": 7540,\n \"IDHubProduct\": 6120,\n \"Quantity\": 6515,\n \"Price\": 1459.6751626183036,\n \"IDHubProductQuantityPricingB2C\": 7330,\n \"MinPurchaseUnit\": 5718,\n \"DiscountPercentage\": 5664.302687033145\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 8083,\n \"IDHubProduct\": 6594,\n \"IDSku\": 9671,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 263,\n \"IDTypeSku\": 5025,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 9227.30220559089,\n \"QtyToSell\": 662.5848040969151,\n \"QtySafetyStock\": 2412,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 8883,\n \"PricingSet\": 6358.04423954063,\n \"PricingCheck\": 3585.582746734275,\n \"PricingSell\": 490.7125961605852,\n \"PricingList\": 2818.309114085824,\n \"OriginalPrice\": 6113.42953091397,\n \"PriceMultiplyValue\": 4897.970807810388,\n \"PriceAddValue\": 6629.852913827843,\n \"PriceRounding\": 6970.738491624901,\n \"CostAverage\": 3545.2691971491836,\n \"CostLastPurchase\": 2792.1836385718057,\n \"IDCommercialCondition\": 7009,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_premium\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 6938.82597420934,\n \"IDHubUserProduct\": 5149,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 7231,\n \"IDImage\": 5399,\n \"ImageOrder\": 3371,\n \"Url\": \"string\",\n \"ImageSize\": 8498,\n \"ImageWidth\": 4180,\n \"ImageHeight\": 5149,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1002\n },\n {\n \"IDHubSkuImage\": 9600,\n \"IDImage\": 4407,\n \"ImageOrder\": 1343,\n \"Url\": \"string\",\n \"ImageSize\": 1539,\n \"ImageWidth\": 1338,\n \"ImageHeight\": 9957,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 8133\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 2541.456114826892\n },\n {\n \"PurchaseExperienceValue\": 4451.432723962598\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 3766,\n \"IDHubProduct\": 3269,\n \"IDSku\": 239,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 2386,\n \"IDTypeSku\": 5211,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 8305.772420037325,\n \"QtyToSell\": 9859.332994451772,\n \"QtySafetyStock\": 250,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 7028,\n \"PricingSet\": 1205.0267431290495,\n \"PricingCheck\": 5065.755964928109,\n \"PricingSell\": 8345.650552903327,\n \"PricingList\": 1955.3885404546656,\n \"OriginalPrice\": 6489.33055296764,\n \"PriceMultiplyValue\": 5714.585890662312,\n \"PriceAddValue\": 5743.597788144843,\n \"PriceRounding\": 1142.131514094804,\n \"CostAverage\": 9017.884765173116,\n \"CostLastPurchase\": 9080.455488157908,\n \"IDCommercialCondition\": 6952,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_pro\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 9670.86473472076,\n \"IDHubUserProduct\": 8799,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5856,\n \"IDImage\": 3143,\n \"ImageOrder\": 1731,\n \"Url\": \"string\",\n \"ImageSize\": 2627,\n \"ImageWidth\": 6255,\n \"ImageHeight\": 9167,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6011\n },\n {\n \"IDHubSkuImage\": 6011,\n \"IDImage\": 7269,\n \"ImageOrder\": 766,\n \"Url\": \"string\",\n \"ImageSize\": 1676,\n \"ImageWidth\": 7294,\n \"ImageHeight\": 519,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9597\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 155.79477236615568\n },\n {\n \"PurchaseExperienceValue\": 2269.085704839695\n }\n ]\n }\n ]\n },\n {\n \"IDHubProduct\": 3728,\n \"IDProduct\": 79,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 226,\n \"IDTypeSku\": 996,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 733,\n \"IDTypeCompanyIntegration\": 2180,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 6436,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 3023,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 3023,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"silver\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"not_specified\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 7258,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 9133,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 3332.485006572603,\n \"TotalVisits\": 4443,\n \"SoldQuantity\": 9481,\n \"Rating\": 2063.560557228825,\n \"PurchaseExperienceValue\": 4442.729235241598,\n \"PriceListSet\": 3720.666182042782,\n \"PriceSellSet\": 3342.6181017831814,\n \"NetPricingSet\": 9604.809789202804,\n \"NetPricingEligible\": true,\n \"CatalogListing\": false,\n \"CatalogEligible\": true,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1884.9368040799197,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": false,\n \"AutopartsUniversalCompatibilityAllowed\": 1953,\n \"AutopartsPendingCompatibility\": false,\n \"AutopartsRequiredCompatibility\": false,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 9086,\n \"HubUserProductEligible\": false,\n \"HubProductQuantityPricingAllowed\": 1081,\n \"IDHubProductQuestionAnswerTemplate\": 3992,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1996-04-14T01:10:20.246Z\",\n \"RecordTimestamp\": \"1964-06-08T11:58:16.156Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 7880,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 905,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 316,\n \"IDImage\": 4754,\n \"ImageOrder\": 2841,\n \"Url\": \"string\",\n \"ImageSize\": 8175,\n \"ImageWidth\": 5243,\n \"ImageHeight\": 5919,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 8188,\n \"IDImage\": 8803,\n \"ImageOrder\": 8382,\n \"Url\": \"string\",\n \"ImageSize\": 5947,\n \"ImageWidth\": 5898,\n \"ImageHeight\": 633,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 9163.952598621985\n },\n {\n \"PurchaseExperienceValue\": 475.19981328132843\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 3043,\n \"IDHubProduct\": 5431,\n \"Quantity\": 1133,\n \"Price\": 6549.394272760114,\n \"IDHubProductQuantityPricingB2C\": 8068,\n \"MinPurchaseUnit\": 836,\n \"DiscountPercentage\": 7135.182514893832\n },\n {\n \"IDHubProductQuantityPricing\": 1528,\n \"IDHubProduct\": 5702,\n \"Quantity\": 2401,\n \"Price\": 2127.469918080678,\n \"IDHubProductQuantityPricingB2C\": 4557,\n \"MinPurchaseUnit\": 4504,\n \"DiscountPercentage\": 6698.532715617873\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 9123,\n \"IDHubProduct\": 3352,\n \"IDSku\": 3528,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4131,\n \"IDTypeSku\": 955,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 6583.913207316927,\n \"QtyToSell\": 3292.2472290965056,\n \"QtySafetyStock\": 792,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 2613,\n \"PricingSet\": 6096.146377080289,\n \"PricingCheck\": 5105.615865648392,\n \"PricingSell\": 8733.867167826205,\n \"PricingList\": 2334.2365102811777,\n \"OriginalPrice\": 3118.748562369289,\n \"PriceMultiplyValue\": 9312.455985049704,\n \"PriceAddValue\": 2888.5039216805962,\n \"PriceRounding\": 1171.2702204143,\n \"CostAverage\": 6915.43083274061,\n \"CostLastPurchase\": 3166.429662952712,\n \"IDCommercialCondition\": 7457,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"bronze\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 7167.382857735305,\n \"IDHubUserProduct\": 6147,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 2331,\n \"IDImage\": 8461,\n \"ImageOrder\": 1622,\n \"Url\": \"string\",\n \"ImageSize\": 1765,\n \"ImageWidth\": 8075,\n \"ImageHeight\": 5586,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9760\n },\n {\n \"IDHubSkuImage\": 6060,\n \"IDImage\": 2933,\n \"ImageOrder\": 7791,\n \"Url\": \"string\",\n \"ImageSize\": 7520,\n \"ImageWidth\": 3532,\n \"ImageHeight\": 9369,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 5803\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 715.4080617469294\n },\n {\n \"PurchaseExperienceValue\": 8850.96958932822\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 9920,\n \"IDHubProduct\": 7655,\n \"IDSku\": 55,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4614,\n \"IDTypeSku\": 852,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 3301.8476527908615,\n \"QtyToSell\": 5975.0714203374855,\n \"QtySafetyStock\": 8552,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 5082,\n \"PricingSet\": 6141.175576289617,\n \"PricingCheck\": 6883.859558810354,\n \"PricingSell\": 688.0953300553405,\n \"PricingList\": 5218.128716056327,\n \"OriginalPrice\": 131.7210335203889,\n \"PriceMultiplyValue\": 5614.365045722964,\n \"PriceAddValue\": 3582.055545424081,\n \"PriceRounding\": 5371.231782843133,\n \"CostAverage\": 1867.3295724299544,\n \"CostLastPurchase\": 795.2424191921614,\n \"IDCommercialCondition\": 5885,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 20.099136661850814,\n \"IDHubUserProduct\": 7178,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5952,\n \"IDImage\": 3173,\n \"ImageOrder\": 4080,\n \"Url\": \"string\",\n \"ImageSize\": 5646,\n \"ImageWidth\": 2175,\n \"ImageHeight\": 5757,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 4468\n },\n {\n \"IDHubSkuImage\": 9683,\n \"IDImage\": 6622,\n \"ImageOrder\": 2564,\n \"Url\": \"string\",\n \"ImageSize\": 4163,\n \"ImageWidth\": 4542,\n \"ImageHeight\": 4262,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 877\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 6417.869787343764\n },\n {\n \"PurchaseExperienceValue\": 678.802946538033\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6e03ec4-4c9b-4e38-94e3-75b15f97b4f2", "name": "`[BadRequest] - Anúncio não existe` · `[BadRequest] - Sku não existe` · `[BadRequest] - Este anúncio já tem este SKU` · `[BadRequest] - Este anúncio já tem este código de variação` · `[BadRequest] - Anúncio tem preço manual setado. Remover antes de atualizar o preço a nível de variação` · `[BadRequest] - Problema ao criar variação em anúncio`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "offer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "NoInvoke", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 4314,\n \"IDSkuHub\": \"string\",\n \"PricingSet\": 4221.2515525212675,\n \"HubSkuOrder\": 1078,\n \"Comments\": \"string\",\n \"HubSkuListingTypeId\": \"gold_special\",\n \"HubSkuShippingFree\": true,\n \"EcommerceModal\": \"string\",\n \"IDCommercialCondition\": 3784,\n \"HubSkuSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "768d591a-e09a-4c28-803c-5fe05d575fd2", "name": "Detalha variação do anúncio — Hub Anúncios", "request": { "name": "Detalha variação do anúncio — Hub Anúncios", "description": { "content": "Retorna o detalhe de uma variação (item) do anúncio: SKU vinculado, preços calculados, estoque, ficha técnica e imagens da variação. A resposta é um array com a variação correspondente.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8043a583-c70b-4efb-b4c8-854b23d12f74", "name": "Variação do anúncio (array com um objeto; vazio se não existir).", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubAdvertisement\": 3956,\n \"IDHubProduct\": 1757,\n \"IDSku\": 4252,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 7128,\n \"IDTypeSku\": 5598,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 1427.8922738461208,\n \"QtyToSell\": 9988.755605204347,\n \"QtySafetyStock\": 5012,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 3961,\n \"PricingSet\": 349.85483659083275,\n \"PricingCheck\": 3028.5165823691273,\n \"PricingSell\": 2970.7456596149664,\n \"PricingList\": 5565.474366033507,\n \"OriginalPrice\": 8275.172990050276,\n \"PriceMultiplyValue\": 6888.795538331092,\n \"PriceAddValue\": 3689.983828931813,\n \"PriceRounding\": 861.8226560938025,\n \"CostAverage\": 2014.180439769493,\n \"CostLastPurchase\": 9528.12853099904,\n \"IDCommercialCondition\": 5577,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_pro\",\n \"HubSkuShippingFree\": true,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 1977.140407316853,\n \"IDHubUserProduct\": 3225,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 3058,\n \"IDImage\": 5630,\n \"ImageOrder\": 824,\n \"Url\": \"string\",\n \"ImageSize\": 8210,\n \"ImageWidth\": 8930,\n \"ImageHeight\": 4338,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6397\n },\n {\n \"IDHubSkuImage\": 3248,\n \"IDImage\": 307,\n \"ImageOrder\": 7943,\n \"Url\": \"string\",\n \"ImageSize\": 7082,\n \"ImageWidth\": 3515,\n \"ImageHeight\": 2826,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1517\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 6134.858655997737\n },\n {\n \"PurchaseExperienceValue\": 9720.937687917303\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 9837,\n \"IDHubProduct\": 2249,\n \"IDSku\": 4753,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4077,\n \"IDTypeSku\": 9723,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 796.4531379822271,\n \"QtyToSell\": 3590.5268538874725,\n \"QtySafetyStock\": 3996,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 2802,\n \"PricingSet\": 908.5513677256185,\n \"PricingCheck\": 5076.846627659431,\n \"PricingSell\": 2909.7123699790563,\n \"PricingList\": 2434.0466047380605,\n \"OriginalPrice\": 4692.594653925288,\n \"PriceMultiplyValue\": 420.07159035409194,\n \"PriceAddValue\": 8990.330052638095,\n \"PriceRounding\": 4645.7453104858405,\n \"CostAverage\": 1236.4258667253348,\n \"CostLastPurchase\": 2219.7826609104363,\n \"IDCommercialCondition\": 3132,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"bronze\",\n \"HubSkuShippingFree\": true,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 7641.351646930514,\n \"IDHubUserProduct\": 9723,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 4207,\n \"IDImage\": 8471,\n \"ImageOrder\": 7203,\n \"Url\": \"string\",\n \"ImageSize\": 7342,\n \"ImageWidth\": 7760,\n \"ImageHeight\": 3519,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6330\n },\n {\n \"IDHubSkuImage\": 178,\n \"IDImage\": 6177,\n \"ImageOrder\": 6604,\n \"Url\": \"string\",\n \"ImageSize\": 516,\n \"ImageWidth\": 3881,\n \"ImageHeight\": 2942,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 8833\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 3232.253301317465\n },\n {\n \"PurchaseExperienceValue\": 9558.613823860584\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "075b7ccf-31cd-4282-a700-60696e4bcba1", "name": "Atualiza variação do anúncio — Hub Anúncios", "request": { "name": "Atualiza variação do anúncio — Hub Anúncios", "description": { "content": "Atualiza uma variação (item) do anúncio (atualização parcial). Quando a atualização automática de preço está ativa e o canal aceita preço, alterar o preço manual (`PricingSet`) dispara o envio ao canal.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSku\": 9776,\n \"IDSkuHub\": \"string\",\n \"PricingSet\": 5729.224032200688,\n \"HubSkuOrder\": 5365,\n \"Comments\": \"string\",\n \"HubSkuListingTypeId\": \"silver\",\n \"HubSkuShippingFree\": false,\n \"EcommerceModal\": \"string\",\n \"IDCommercialCondition\": 2122,\n \"HubSkuSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDImage\": 7729,\n \"ImageOrder\": 9675\n },\n {\n \"IDImage\": 7958,\n \"ImageOrder\": 4178\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3fb307db-c8a3-4585-b8e5-6c94a056d38b", "name": "Anúncio atualizado (mesma estrutura do GET por id) ou `\"sucesso\"` quando `NoInvoke=1`.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 7624,\n \"IDSkuHub\": \"string\",\n \"PricingSet\": 4305.61027312389,\n \"HubSkuOrder\": 3784,\n \"Comments\": \"string\",\n \"HubSkuListingTypeId\": \"free\",\n \"HubSkuShippingFree\": false,\n \"EcommerceModal\": \"string\",\n \"IDCommercialCondition\": 2325,\n \"HubSkuSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDImage\": 4045,\n \"ImageOrder\": 8621\n },\n {\n \"IDImage\": 1112,\n \"ImageOrder\": 3150\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProduct\": 6722,\n \"IDProduct\": 5153,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 7804,\n \"IDTypeSku\": 3883,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 8987,\n \"IDTypeCompanyIntegration\": 7778,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 9138,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 8621,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 7870,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"free\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 2088,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 8592,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 5585.899769001375,\n \"TotalVisits\": 9987,\n \"SoldQuantity\": 622,\n \"Rating\": 948.1160572763914,\n \"PurchaseExperienceValue\": 2165.81957488571,\n \"PriceListSet\": 7314.756335335935,\n \"PriceSellSet\": 9837.865156218635,\n \"NetPricingSet\": 9070.177039980832,\n \"NetPricingEligible\": false,\n \"CatalogListing\": false,\n \"CatalogEligible\": false,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1518.9630880793636,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": true,\n \"AutopartsUniversalCompatibilityAllowed\": 1873,\n \"AutopartsPendingCompatibility\": true,\n \"AutopartsRequiredCompatibility\": true,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 4142,\n \"HubUserProductEligible\": true,\n \"HubProductQuantityPricingAllowed\": 6021,\n \"IDHubProductQuestionAnswerTemplate\": 2427,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1997-10-29T08:01:56.486Z\",\n \"RecordTimestamp\": \"2021-10-25T12:40:01.369Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 6348,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 7693,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 3151,\n \"IDImage\": 7223,\n \"ImageOrder\": 252,\n \"Url\": \"string\",\n \"ImageSize\": 5038,\n \"ImageWidth\": 5415,\n \"ImageHeight\": 547,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 6731,\n \"IDImage\": 7488,\n \"ImageOrder\": 3891,\n \"Url\": \"string\",\n \"ImageSize\": 1108,\n \"ImageWidth\": 2975,\n \"ImageHeight\": 5864,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 3299.322767849924\n },\n {\n \"PurchaseExperienceValue\": 2885.7176474231474\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 4490,\n \"IDHubProduct\": 3206,\n \"Quantity\": 7469,\n \"Price\": 6378.371705440877,\n \"IDHubProductQuantityPricingB2C\": 7686,\n \"MinPurchaseUnit\": 2199,\n \"DiscountPercentage\": 4936.589873941663\n },\n {\n \"IDHubProductQuantityPricing\": 7540,\n \"IDHubProduct\": 6120,\n \"Quantity\": 6515,\n \"Price\": 1459.6751626183036,\n \"IDHubProductQuantityPricingB2C\": 7330,\n \"MinPurchaseUnit\": 5718,\n \"DiscountPercentage\": 5664.302687033145\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 8083,\n \"IDHubProduct\": 6594,\n \"IDSku\": 9671,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 263,\n \"IDTypeSku\": 5025,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 9227.30220559089,\n \"QtyToSell\": 662.5848040969151,\n \"QtySafetyStock\": 2412,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 8883,\n \"PricingSet\": 6358.04423954063,\n \"PricingCheck\": 3585.582746734275,\n \"PricingSell\": 490.7125961605852,\n \"PricingList\": 2818.309114085824,\n \"OriginalPrice\": 6113.42953091397,\n \"PriceMultiplyValue\": 4897.970807810388,\n \"PriceAddValue\": 6629.852913827843,\n \"PriceRounding\": 6970.738491624901,\n \"CostAverage\": 3545.2691971491836,\n \"CostLastPurchase\": 2792.1836385718057,\n \"IDCommercialCondition\": 7009,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_premium\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 6938.82597420934,\n \"IDHubUserProduct\": 5149,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 7231,\n \"IDImage\": 5399,\n \"ImageOrder\": 3371,\n \"Url\": \"string\",\n \"ImageSize\": 8498,\n \"ImageWidth\": 4180,\n \"ImageHeight\": 5149,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1002\n },\n {\n \"IDHubSkuImage\": 9600,\n \"IDImage\": 4407,\n \"ImageOrder\": 1343,\n \"Url\": \"string\",\n \"ImageSize\": 1539,\n \"ImageWidth\": 1338,\n \"ImageHeight\": 9957,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 8133\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 2541.456114826892\n },\n {\n \"PurchaseExperienceValue\": 4451.432723962598\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 3766,\n \"IDHubProduct\": 3269,\n \"IDSku\": 239,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 2386,\n \"IDTypeSku\": 5211,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 8305.772420037325,\n \"QtyToSell\": 9859.332994451772,\n \"QtySafetyStock\": 250,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 7028,\n \"PricingSet\": 1205.0267431290495,\n \"PricingCheck\": 5065.755964928109,\n \"PricingSell\": 8345.650552903327,\n \"PricingList\": 1955.3885404546656,\n \"OriginalPrice\": 6489.33055296764,\n \"PriceMultiplyValue\": 5714.585890662312,\n \"PriceAddValue\": 5743.597788144843,\n \"PriceRounding\": 1142.131514094804,\n \"CostAverage\": 9017.884765173116,\n \"CostLastPurchase\": 9080.455488157908,\n \"IDCommercialCondition\": 6952,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_pro\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 9670.86473472076,\n \"IDHubUserProduct\": 8799,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5856,\n \"IDImage\": 3143,\n \"ImageOrder\": 1731,\n \"Url\": \"string\",\n \"ImageSize\": 2627,\n \"ImageWidth\": 6255,\n \"ImageHeight\": 9167,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6011\n },\n {\n \"IDHubSkuImage\": 6011,\n \"IDImage\": 7269,\n \"ImageOrder\": 766,\n \"Url\": \"string\",\n \"ImageSize\": 1676,\n \"ImageWidth\": 7294,\n \"ImageHeight\": 519,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9597\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 155.79477236615568\n },\n {\n \"PurchaseExperienceValue\": 2269.085704839695\n }\n ]\n }\n ]\n },\n {\n \"IDHubProduct\": 3728,\n \"IDProduct\": 79,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 226,\n \"IDTypeSku\": 996,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 733,\n \"IDTypeCompanyIntegration\": 2180,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 6436,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 3023,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 3023,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"silver\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"not_specified\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 7258,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 9133,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 3332.485006572603,\n \"TotalVisits\": 4443,\n \"SoldQuantity\": 9481,\n \"Rating\": 2063.560557228825,\n \"PurchaseExperienceValue\": 4442.729235241598,\n \"PriceListSet\": 3720.666182042782,\n \"PriceSellSet\": 3342.6181017831814,\n \"NetPricingSet\": 9604.809789202804,\n \"NetPricingEligible\": true,\n \"CatalogListing\": false,\n \"CatalogEligible\": true,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1884.9368040799197,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": false,\n \"AutopartsUniversalCompatibilityAllowed\": 1953,\n \"AutopartsPendingCompatibility\": false,\n \"AutopartsRequiredCompatibility\": false,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 9086,\n \"HubUserProductEligible\": false,\n \"HubProductQuantityPricingAllowed\": 1081,\n \"IDHubProductQuestionAnswerTemplate\": 3992,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1996-04-14T01:10:20.246Z\",\n \"RecordTimestamp\": \"1964-06-08T11:58:16.156Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 7880,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 905,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 316,\n \"IDImage\": 4754,\n \"ImageOrder\": 2841,\n \"Url\": \"string\",\n \"ImageSize\": 8175,\n \"ImageWidth\": 5243,\n \"ImageHeight\": 5919,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 8188,\n \"IDImage\": 8803,\n \"ImageOrder\": 8382,\n \"Url\": \"string\",\n \"ImageSize\": 5947,\n \"ImageWidth\": 5898,\n \"ImageHeight\": 633,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 9163.952598621985\n },\n {\n \"PurchaseExperienceValue\": 475.19981328132843\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 3043,\n \"IDHubProduct\": 5431,\n \"Quantity\": 1133,\n \"Price\": 6549.394272760114,\n \"IDHubProductQuantityPricingB2C\": 8068,\n \"MinPurchaseUnit\": 836,\n \"DiscountPercentage\": 7135.182514893832\n },\n {\n \"IDHubProductQuantityPricing\": 1528,\n \"IDHubProduct\": 5702,\n \"Quantity\": 2401,\n \"Price\": 2127.469918080678,\n \"IDHubProductQuantityPricingB2C\": 4557,\n \"MinPurchaseUnit\": 4504,\n \"DiscountPercentage\": 6698.532715617873\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 9123,\n \"IDHubProduct\": 3352,\n \"IDSku\": 3528,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4131,\n \"IDTypeSku\": 955,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 6583.913207316927,\n \"QtyToSell\": 3292.2472290965056,\n \"QtySafetyStock\": 792,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 2613,\n \"PricingSet\": 6096.146377080289,\n \"PricingCheck\": 5105.615865648392,\n \"PricingSell\": 8733.867167826205,\n \"PricingList\": 2334.2365102811777,\n \"OriginalPrice\": 3118.748562369289,\n \"PriceMultiplyValue\": 9312.455985049704,\n \"PriceAddValue\": 2888.5039216805962,\n \"PriceRounding\": 1171.2702204143,\n \"CostAverage\": 6915.43083274061,\n \"CostLastPurchase\": 3166.429662952712,\n \"IDCommercialCondition\": 7457,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"bronze\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 7167.382857735305,\n \"IDHubUserProduct\": 6147,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 2331,\n \"IDImage\": 8461,\n \"ImageOrder\": 1622,\n \"Url\": \"string\",\n \"ImageSize\": 1765,\n \"ImageWidth\": 8075,\n \"ImageHeight\": 5586,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9760\n },\n {\n \"IDHubSkuImage\": 6060,\n \"IDImage\": 2933,\n \"ImageOrder\": 7791,\n \"Url\": \"string\",\n \"ImageSize\": 7520,\n \"ImageWidth\": 3532,\n \"ImageHeight\": 9369,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 5803\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 715.4080617469294\n },\n {\n \"PurchaseExperienceValue\": 8850.96958932822\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 9920,\n \"IDHubProduct\": 7655,\n \"IDSku\": 55,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4614,\n \"IDTypeSku\": 852,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 3301.8476527908615,\n \"QtyToSell\": 5975.0714203374855,\n \"QtySafetyStock\": 8552,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 5082,\n \"PricingSet\": 6141.175576289617,\n \"PricingCheck\": 6883.859558810354,\n \"PricingSell\": 688.0953300553405,\n \"PricingList\": 5218.128716056327,\n \"OriginalPrice\": 131.7210335203889,\n \"PriceMultiplyValue\": 5614.365045722964,\n \"PriceAddValue\": 3582.055545424081,\n \"PriceRounding\": 5371.231782843133,\n \"CostAverage\": 1867.3295724299544,\n \"CostLastPurchase\": 795.2424191921614,\n \"IDCommercialCondition\": 5885,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 20.099136661850814,\n \"IDHubUserProduct\": 7178,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5952,\n \"IDImage\": 3173,\n \"ImageOrder\": 4080,\n \"Url\": \"string\",\n \"ImageSize\": 5646,\n \"ImageWidth\": 2175,\n \"ImageHeight\": 5757,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 4468\n },\n {\n \"IDHubSkuImage\": 9683,\n \"IDImage\": 6622,\n \"ImageOrder\": 2564,\n \"Url\": \"string\",\n \"ImageSize\": 4163,\n \"ImageWidth\": 4542,\n \"ImageHeight\": 4262,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 877\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 6417.869787343764\n },\n {\n \"PurchaseExperienceValue\": 678.802946538033\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5914b079-454f-4375-85b0-1a62741a2a33", "name": "`[BadRequest] - Anúncio não existe` · `[BadRequest] - Sku não existe` · `[BadRequest] - Já existe uma variação com este código` · `[BadRequest] - Anúncio tem preço manual setado. Remover antes de atualizar o preço a nível de variação`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 7624,\n \"IDSkuHub\": \"string\",\n \"PricingSet\": 4305.61027312389,\n \"HubSkuOrder\": 3784,\n \"Comments\": \"string\",\n \"HubSkuListingTypeId\": \"free\",\n \"HubSkuShippingFree\": false,\n \"EcommerceModal\": \"string\",\n \"IDCommercialCondition\": 2325,\n \"HubSkuSpecification\": [\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n },\n {\n \"IDStockKeepingUnitSpecificationsFieldId\": \"string\",\n \"FieldName\": \"string\",\n \"FieldValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDImage\": 4045,\n \"ImageOrder\": 8621\n },\n {\n \"IDImage\": 1112,\n \"ImageOrder\": 3150\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d729dc0-0866-45b1-8f50-bdd1de5ef1f8", "name": "Remove variação do anúncio — Hub Anúncios", "request": { "name": "Remove variação do anúncio — Hub Anúncios", "description": { "content": "Remove uma variação (item) do anúncio e comunica a remoção ao canal de forma assíncrona.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c5a23419-c2f2-4387-9e63-6b4a53f8ef9d", "name": "Anúncio atualizado (mesma estrutura do GET por id).", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProduct\": 6722,\n \"IDProduct\": 5153,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 7804,\n \"IDTypeSku\": 3883,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 8987,\n \"IDTypeCompanyIntegration\": 7778,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 9138,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 8621,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 7870,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"free\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"me1\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 2088,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 8592,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 5585.899769001375,\n \"TotalVisits\": 9987,\n \"SoldQuantity\": 622,\n \"Rating\": 948.1160572763914,\n \"PurchaseExperienceValue\": 2165.81957488571,\n \"PriceListSet\": 7314.756335335935,\n \"PriceSellSet\": 9837.865156218635,\n \"NetPricingSet\": 9070.177039980832,\n \"NetPricingEligible\": false,\n \"CatalogListing\": false,\n \"CatalogEligible\": false,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1518.9630880793636,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": true,\n \"AutopartsUniversalCompatibilityAllowed\": 1873,\n \"AutopartsPendingCompatibility\": true,\n \"AutopartsRequiredCompatibility\": true,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 4142,\n \"HubUserProductEligible\": true,\n \"HubProductQuantityPricingAllowed\": 6021,\n \"IDHubProductQuestionAnswerTemplate\": 2427,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1997-10-29T08:01:56.486Z\",\n \"RecordTimestamp\": \"2021-10-25T12:40:01.369Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 6348,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 7693,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 3151,\n \"IDImage\": 7223,\n \"ImageOrder\": 252,\n \"Url\": \"string\",\n \"ImageSize\": 5038,\n \"ImageWidth\": 5415,\n \"ImageHeight\": 547,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 6731,\n \"IDImage\": 7488,\n \"ImageOrder\": 3891,\n \"Url\": \"string\",\n \"ImageSize\": 1108,\n \"ImageWidth\": 2975,\n \"ImageHeight\": 5864,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 3299.322767849924\n },\n {\n \"PurchaseExperienceValue\": 2885.7176474231474\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 4490,\n \"IDHubProduct\": 3206,\n \"Quantity\": 7469,\n \"Price\": 6378.371705440877,\n \"IDHubProductQuantityPricingB2C\": 7686,\n \"MinPurchaseUnit\": 2199,\n \"DiscountPercentage\": 4936.589873941663\n },\n {\n \"IDHubProductQuantityPricing\": 7540,\n \"IDHubProduct\": 6120,\n \"Quantity\": 6515,\n \"Price\": 1459.6751626183036,\n \"IDHubProductQuantityPricingB2C\": 7330,\n \"MinPurchaseUnit\": 5718,\n \"DiscountPercentage\": 5664.302687033145\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 8083,\n \"IDHubProduct\": 6594,\n \"IDSku\": 9671,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 263,\n \"IDTypeSku\": 5025,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 9227.30220559089,\n \"QtyToSell\": 662.5848040969151,\n \"QtySafetyStock\": 2412,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 8883,\n \"PricingSet\": 6358.04423954063,\n \"PricingCheck\": 3585.582746734275,\n \"PricingSell\": 490.7125961605852,\n \"PricingList\": 2818.309114085824,\n \"OriginalPrice\": 6113.42953091397,\n \"PriceMultiplyValue\": 4897.970807810388,\n \"PriceAddValue\": 6629.852913827843,\n \"PriceRounding\": 6970.738491624901,\n \"CostAverage\": 3545.2691971491836,\n \"CostLastPurchase\": 2792.1836385718057,\n \"IDCommercialCondition\": 7009,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_premium\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 6938.82597420934,\n \"IDHubUserProduct\": 5149,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 7231,\n \"IDImage\": 5399,\n \"ImageOrder\": 3371,\n \"Url\": \"string\",\n \"ImageSize\": 8498,\n \"ImageWidth\": 4180,\n \"ImageHeight\": 5149,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 1002\n },\n {\n \"IDHubSkuImage\": 9600,\n \"IDImage\": 4407,\n \"ImageOrder\": 1343,\n \"Url\": \"string\",\n \"ImageSize\": 1539,\n \"ImageWidth\": 1338,\n \"ImageHeight\": 9957,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 8133\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 2541.456114826892\n },\n {\n \"PurchaseExperienceValue\": 4451.432723962598\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 3766,\n \"IDHubProduct\": 3269,\n \"IDSku\": 239,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 2386,\n \"IDTypeSku\": 5211,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 8305.772420037325,\n \"QtyToSell\": 9859.332994451772,\n \"QtySafetyStock\": 250,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 7028,\n \"PricingSet\": 1205.0267431290495,\n \"PricingCheck\": 5065.755964928109,\n \"PricingSell\": 8345.650552903327,\n \"PricingList\": 1955.3885404546656,\n \"OriginalPrice\": 6489.33055296764,\n \"PriceMultiplyValue\": 5714.585890662312,\n \"PriceAddValue\": 5743.597788144843,\n \"PriceRounding\": 1142.131514094804,\n \"CostAverage\": 9017.884765173116,\n \"CostLastPurchase\": 9080.455488157908,\n \"IDCommercialCondition\": 6952,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold_pro\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 9670.86473472076,\n \"IDHubUserProduct\": 8799,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5856,\n \"IDImage\": 3143,\n \"ImageOrder\": 1731,\n \"Url\": \"string\",\n \"ImageSize\": 2627,\n \"ImageWidth\": 6255,\n \"ImageHeight\": 9167,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 6011\n },\n {\n \"IDHubSkuImage\": 6011,\n \"IDImage\": 7269,\n \"ImageOrder\": 766,\n \"Url\": \"string\",\n \"ImageSize\": 1676,\n \"ImageWidth\": 7294,\n \"ImageHeight\": 519,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9597\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 155.79477236615568\n },\n {\n \"PurchaseExperienceValue\": 2269.085704839695\n }\n ]\n }\n ]\n },\n {\n \"IDHubProduct\": 3728,\n \"IDProduct\": 79,\n \"IDProductHub\": \"string\",\n \"AccountName\": \"string\",\n \"HubProductName\": \"string\",\n \"EcommerceTitle\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"IDBrand\": 226,\n \"IDTypeSku\": 996,\n \"TypeProduct\": \"string\",\n \"HubEcommerceDescription\": \"string\",\n \"EcommerceDescription\": \"string\",\n \"Comments\": \"string\",\n \"IDCompanyIntegration\": 733,\n \"IDTypeCompanyIntegration\": 2180,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"LogoUrl\": \"string\",\n \"PathName\": \"string\",\n \"CategoryId\": \"string\",\n \"IDCategory\": 6436,\n \"CategoryPath\": \"string\",\n \"AdvertisementStatus\": 3023,\n \"StatusHubSku\": \"string\",\n \"HubProductSubStatus\": 3023,\n \"Substatus\": \"string\",\n \"ReviewReason\": \"string\",\n \"ReviewRemedy\": \"string\",\n \"AdvertisementUrl\": \"string\",\n \"ListingTypeId\": \"silver\",\n \"ListingTypeDescription\": \"string\",\n \"Condition\": \"string\",\n \"ShippingMode\": \"not_specified\",\n \"ShippingModeDescription\": \"string\",\n \"ShippingFree\": \"string\",\n \"ShippingLocalPickUp\": \"string\",\n \"ShippingLogisticType\": \"string\",\n \"ShippingTags\": \"string\",\n \"WarrantyType\": \"string\",\n \"WarrantyTime\": 7258,\n \"WarrantyTimeType\": \"string\",\n \"LeadTimeDays\": 9133,\n \"OfficialStore\": \"string\",\n \"ShowWithoutStock\": \"string\",\n \"Visible\": \"string\",\n \"Health\": 3332.485006572603,\n \"TotalVisits\": 4443,\n \"SoldQuantity\": 9481,\n \"Rating\": 2063.560557228825,\n \"PurchaseExperienceValue\": 4442.729235241598,\n \"PriceListSet\": 3720.666182042782,\n \"PriceSellSet\": 3342.6181017831814,\n \"NetPricingSet\": 9604.809789202804,\n \"NetPricingEligible\": true,\n \"CatalogListing\": false,\n \"CatalogEligible\": true,\n \"CatalogProductId\": \"string\",\n \"CatalogStatus\": \"string\",\n \"CatalogPriceToWin\": 1884.9368040799197,\n \"CatalogOpportunity\": \"string\",\n \"AutopartsException\": false,\n \"AutopartsUniversalCompatibility\": false,\n \"AutopartsUniversalCompatibilityAllowed\": 1953,\n \"AutopartsPendingCompatibility\": false,\n \"AutopartsRequiredCompatibility\": false,\n \"UserProductListing\": \"string\",\n \"UserProductEnabled\": 9086,\n \"HubUserProductEligible\": false,\n \"HubProductQuantityPricingAllowed\": 1081,\n \"IDHubProductQuestionAnswerTemplate\": 3992,\n \"AnswerTitle\": \"string\",\n \"AnswerTemplate\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"CreatedTimestamp\": \"1996-04-14T01:10:20.246Z\",\n \"RecordTimestamp\": \"1964-06-08T11:58:16.156Z\",\n \"HubProductSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\",\n \"SpecificationCustomValue\": \"string\"\n }\n ],\n \"HubProductSalesPolicy\": [\n {\n \"IDTypeSkuSalesPolicy\": 7880,\n \"SalesPolicy\": \"string\"\n },\n {\n \"IDTypeSkuSalesPolicy\": 905,\n \"SalesPolicy\": \"string\"\n }\n ],\n \"HubProductImage\": [\n {\n \"IDHubProductImage\": 316,\n \"IDImage\": 4754,\n \"ImageOrder\": 2841,\n \"Url\": \"string\",\n \"ImageSize\": 8175,\n \"ImageWidth\": 5243,\n \"ImageHeight\": 5919,\n \"ImageName\": \"string\"\n },\n {\n \"IDHubProductImage\": 8188,\n \"IDImage\": 8803,\n \"ImageOrder\": 8382,\n \"Url\": \"string\",\n \"ImageSize\": 5947,\n \"ImageWidth\": 5898,\n \"ImageHeight\": 633,\n \"ImageName\": \"string\"\n }\n ],\n \"HealthAction\": [\n {\n \"TypeHubProductHealthDescription\": \"string\"\n },\n {\n \"TypeHubProductHealthDescription\": \"string\"\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 9163.952598621985\n },\n {\n \"PurchaseExperienceValue\": 475.19981328132843\n }\n ],\n \"HubProductQuantityPricing\": [\n {\n \"IDHubProductQuantityPricing\": 3043,\n \"IDHubProduct\": 5431,\n \"Quantity\": 1133,\n \"Price\": 6549.394272760114,\n \"IDHubProductQuantityPricingB2C\": 8068,\n \"MinPurchaseUnit\": 836,\n \"DiscountPercentage\": 7135.182514893832\n },\n {\n \"IDHubProductQuantityPricing\": 1528,\n \"IDHubProduct\": 5702,\n \"Quantity\": 2401,\n \"Price\": 2127.469918080678,\n \"IDHubProductQuantityPricingB2C\": 4557,\n \"MinPurchaseUnit\": 4504,\n \"DiscountPercentage\": 6698.532715617873\n }\n ],\n \"HubSku\": [\n {\n \"IDHubAdvertisement\": 9123,\n \"IDHubProduct\": 3352,\n \"IDSku\": 3528,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4131,\n \"IDTypeSku\": 955,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 6583.913207316927,\n \"QtyToSell\": 3292.2472290965056,\n \"QtySafetyStock\": 792,\n \"InfiniteInventory\": true,\n \"SoldQuantity\": 2613,\n \"PricingSet\": 6096.146377080289,\n \"PricingCheck\": 5105.615865648392,\n \"PricingSell\": 8733.867167826205,\n \"PricingList\": 2334.2365102811777,\n \"OriginalPrice\": 3118.748562369289,\n \"PriceMultiplyValue\": 9312.455985049704,\n \"PriceAddValue\": 2888.5039216805962,\n \"PriceRounding\": 1171.2702204143,\n \"CostAverage\": 6915.43083274061,\n \"CostLastPurchase\": 3166.429662952712,\n \"IDCommercialCondition\": 7457,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"bronze\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 7167.382857735305,\n \"IDHubUserProduct\": 6147,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 2331,\n \"IDImage\": 8461,\n \"ImageOrder\": 1622,\n \"Url\": \"string\",\n \"ImageSize\": 1765,\n \"ImageWidth\": 8075,\n \"ImageHeight\": 5586,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 9760\n },\n {\n \"IDHubSkuImage\": 6060,\n \"IDImage\": 2933,\n \"ImageOrder\": 7791,\n \"Url\": \"string\",\n \"ImageSize\": 7520,\n \"ImageWidth\": 3532,\n \"ImageHeight\": 9369,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 5803\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 715.4080617469294\n },\n {\n \"PurchaseExperienceValue\": 8850.96958932822\n }\n ]\n },\n {\n \"IDHubAdvertisement\": 9920,\n \"IDHubProduct\": 7655,\n \"IDSku\": 55,\n \"IDSkuHub\": \"string\",\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"AccountName\": \"string\",\n \"ProductVariation\": \"string\",\n \"TypeProductVariationValue\": \"string\",\n \"HubSkuOrder\": 4614,\n \"IDTypeSku\": 852,\n \"TypeProduct\": \"string\",\n \"QtyAvailable\": 3301.8476527908615,\n \"QtyToSell\": 5975.0714203374855,\n \"QtySafetyStock\": 8552,\n \"InfiniteInventory\": false,\n \"SoldQuantity\": 5082,\n \"PricingSet\": 6141.175576289617,\n \"PricingCheck\": 6883.859558810354,\n \"PricingSell\": 688.0953300553405,\n \"PricingList\": 5218.128716056327,\n \"OriginalPrice\": 131.7210335203889,\n \"PriceMultiplyValue\": 5614.365045722964,\n \"PriceAddValue\": 3582.055545424081,\n \"PriceRounding\": 5371.231782843133,\n \"CostAverage\": 1867.3295724299544,\n \"CostLastPurchase\": 795.2424191921614,\n \"IDCommercialCondition\": 5885,\n \"CommercialCondition\": \"string\",\n \"EcommerceModal\": \"string\",\n \"HubSkuListingTypeId\": \"gold\",\n \"HubSkuShippingFree\": false,\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\",\n \"PurchaseExperienceValue\": 20.099136661850814,\n \"IDHubUserProduct\": 7178,\n \"HubSkuSpecification\": [\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n },\n {\n \"IDSpecification\": \"string\",\n \"SpecificationName\": \"string\",\n \"SpecificationValue\": \"string\",\n \"IDSpecificationValue\": \"string\"\n }\n ],\n \"HubSkuImage\": [\n {\n \"IDHubSkuImage\": 5952,\n \"IDImage\": 3173,\n \"ImageOrder\": 4080,\n \"Url\": \"string\",\n \"ImageSize\": 5646,\n \"ImageWidth\": 2175,\n \"ImageHeight\": 5757,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 4468\n },\n {\n \"IDHubSkuImage\": 9683,\n \"IDImage\": 6622,\n \"ImageOrder\": 2564,\n \"Url\": \"string\",\n \"ImageSize\": 4163,\n \"ImageWidth\": 4542,\n \"ImageHeight\": 4262,\n \"ImageName\": \"string\",\n \"IDHubAdvertisement\": 877\n }\n ],\n \"PurchaseExperience\": [\n {\n \"PurchaseExperienceValue\": 6417.869787343764\n },\n {\n \"PurchaseExperienceValue\": 678.802946538033\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16b17d76-701d-4c0c-9eb1-e1d28e6e9435", "name": "`[BadRequest] - Variação não existe` · `[BadRequest] - Erro ao deletar`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "offer", ":idoffer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idoffer", "description": "(Required) Identificador da variação (`IDHubAdvertisement`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a172d2d4-9806-45ad-a2ad-73e3e4ec928b", "name": "Adiciona preço por quantidade — Hub Anúncios", "request": { "name": "Adiciona preço por quantidade — Hub Anúncios", "description": { "content": "Adiciona uma faixa de preço por quantidade (desconto por volume) ao anúncio. Recurso do Mercado Livre. O campo `Type` do corpo escolhe o público: ausente ou `B2B` grava preço absoluto por faixa (até 5 faixas, cada quantidade uma única vez); `B2C` grava percentual de desconto para o consumidor final (até 2 faixas, apenas quantidades 2 e 4, somente em anúncios do domínio AUTOMOTIVE_TIRES, com desconto crescente conforme a quantidade).", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Quantity\": 9212,\n \"Price\": 2123.9372996326765,\n \"Type\": \"B2B\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6d2b3d76-1cdc-4fc1-a382-f219fd1f598b", "name": "Faixas de preço por quantidade do anúncio (todas).", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Quantity\": 9212,\n \"Price\": 2123.9372996326765,\n \"Type\": \"B2B\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductQuantityPricing\": 4829,\n \"IDHubProduct\": 7780,\n \"Quantity\": 8652,\n \"Price\": 6635.36964756754,\n \"IDHubProductQuantityPricingB2C\": 3586,\n \"MinPurchaseUnit\": 2159,\n \"DiscountPercentage\": 5003.737589418296\n },\n {\n \"IDHubProductQuantityPricing\": 7993,\n \"IDHubProduct\": 2798,\n \"Quantity\": 236,\n \"Price\": 5043.125266678417,\n \"IDHubProductQuantityPricingB2C\": 595,\n \"MinPurchaseUnit\": 1531,\n \"DiscountPercentage\": 3773.1957554555274\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9dc2140-c64f-4161-aec5-a07cf26416ae", "name": "`[BadRequest] - Anúncio não existe` · `[BadRequest] - Quantidade precisa ser maior que zero` · `[BadRequest] - já existe preço para essa quantidade no anúncio` · `[BadRequest] - Anúncio não pode ter mais de 5 preços por quantidade` · `[BadRequest] - Quantidade mínima precisa ser 2 ou 4` · `[BadRequest] - Desconto precisa ser maior que zero e menor que 100` · `[BadRequest] - já existe desconto para essa quantidade no anúncio` · `[BadRequest] - Anúncio não pode ter mais de 2 faixas de preço por quantidade B2C` · `[BadRequest] - O desconto de {N} unidades precisa ser maior que o de {N} unidades`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Quantity\": 9212,\n \"Price\": 2123.9372996326765,\n \"Type\": \"B2B\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4c28289-38d2-4049-940b-f4da6f299b04", "name": "Atualiza preço por quantidade — Hub Anúncios", "request": { "name": "Atualiza preço por quantidade — Hub Anúncios", "description": { "content": "Atualiza uma faixa de preço por quantidade do anúncio. O `Type` do corpo escolhe o público e determina a qual recurso pertence o identificador do caminho.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing", ":idhubproductquantitypricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquantitypricing", "description": "(Required) Identificador da faixa de preço por quantidade (B2B ou B2C, conforme o `Type` enviado no corpo)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Quantity\": 9212,\n \"Price\": 2123.9372996326765,\n \"Type\": \"B2B\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "289e02e4-01aa-4dc2-a08f-2a8fa7c3da68", "name": "Faixas de preço por quantidade do anúncio (todas).", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing", ":idhubproductquantitypricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquantitypricing", "description": "(Required) Identificador da faixa de preço por quantidade (B2B ou B2C, conforme o `Type` enviado no corpo)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Quantity\": 9212,\n \"Price\": 2123.9372996326765,\n \"Type\": \"B2B\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubProductQuantityPricing\": 4829,\n \"IDHubProduct\": 7780,\n \"Quantity\": 8652,\n \"Price\": 6635.36964756754,\n \"IDHubProductQuantityPricingB2C\": 3586,\n \"MinPurchaseUnit\": 2159,\n \"DiscountPercentage\": 5003.737589418296\n },\n {\n \"IDHubProductQuantityPricing\": 7993,\n \"IDHubProduct\": 2798,\n \"Quantity\": 236,\n \"Price\": 5043.125266678417,\n \"IDHubProductQuantityPricingB2C\": 595,\n \"MinPurchaseUnit\": 1531,\n \"DiscountPercentage\": 3773.1957554555274\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2df6639d-73bb-45a6-9414-8a84f34e1dd5", "name": "`[BadRequest] - Preço por quantidade do anúncio não existe` · `[BadRequest] - Quantidade precisa ser maior que zero` · `[BadRequest] - já existe preço para essa quantidade no anúncio` · `[BadRequest] - Preço por quantidade B2C do anúncio não existe` · `[BadRequest] - Quantidade mínima precisa ser 2 ou 4` · `[BadRequest] - Desconto precisa ser maior que zero e menor que 100` · `[BadRequest] - O desconto de {N} unidades precisa ser maior que o de {N} unidades`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing", ":idhubproductquantitypricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquantitypricing", "description": "(Required) Identificador da faixa de preço por quantidade (B2B ou B2C, conforme o `Type` enviado no corpo)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Quantity\": 9212,\n \"Price\": 2123.9372996326765,\n \"Type\": \"B2B\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71020535-0a8f-4312-85c0-cda3689e3551", "name": "Remove preço por quantidade — Hub Anúncios", "request": { "name": "Remove preço por quantidade — Hub Anúncios", "description": { "content": "Remove uma faixa de preço por quantidade do anúncio. O canal só é atualizado na próxima sincronização de preço por quantidade.", "type": "text/plain" }, "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing", ":idhubproductquantitypricing" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "B2C", "description": "`B2C` remove uma faixa de desconto por quantidade para o consumidor final. Ausente, remove uma faixa de preço por quantidade B2B." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquantitypricing", "description": "(Required) Identificador da faixa de preço por quantidade (B2B ou B2C, conforme o parâmetro `Type`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "106b9129-0a05-46e2-8b08-e2bbe3048bd4", "name": "Faixa removida.", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing", ":idhubproductquantitypricing" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "B2C" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquantitypricing", "description": "(Required) Identificador da faixa de preço por quantidade (B2B ou B2C, conforme o parâmetro `Type`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beb1306e-8104-4f12-be97-2d9cd1f866f6", "name": "`[BadRequest] - Preço por quantidade do anúncio não existe`", "originalRequest": { "url": { "path": [ "hub", "product", ":idhubproduct", "quantity-pricing", ":idhubproductquantitypricing" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "B2C" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubproduct", "description": "(Required) Identificador interno do anúncio." }, { "disabled": false, "type": "any", "value": "1603", "key": "idhubproductquantitypricing", "description": "(Required) Identificador da faixa de preço por quantidade (B2B ou B2C, conforme o parâmetro `Type`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b814ff16-1e99-4fd7-9d66-8ec04e4ad368", "name": "Hub — Categorias", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ad9c3021-4cc9-43fb-a72a-90da35fcbda3", "name": "Lista mapeamentos — Hub Categorias", "request": { "name": "Lista mapeamentos — Hub Categorias", "description": { "content": "Lista os mapeamentos da empresa autenticada. Sem paginação.", "type": "text/plain" }, "url": { "path": [ "hub", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelo identificador da integração da empresa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bd4b59c6-504d-4d13-b41b-9ae1cabc5e8e", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "category" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCategorias\": 404,\n \"IDCompanyIntegration\": 4245,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1687,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 7246,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n },\n {\n \"IDHubCategorias\": 8169,\n \"IDCompanyIntegration\": 9485,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7177,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 3941,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb52fd75-892d-41b5-b4d7-730d8d797c3f", "name": "Cria mapeamento — Hub Categorias", "request": { "name": "Cria mapeamento — Hub Categorias", "description": { "content": "Cria um novo mapeamento. Retorna a lista completa atualizada (re-invoca o List).", "type": "text/plain" }, "url": { "path": [ "hub", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9708,\n \"IDCategoryTo\": 7915,\n \"IDCategoryFrom\": \"string\",\n \"CategoryFromTree\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "487670ea-48b3-4955-a5c3-f6857455a76b", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9708,\n \"IDCategoryTo\": 7915,\n \"IDCategoryFrom\": \"string\",\n \"CategoryFromTree\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCategorias\": 404,\n \"IDCompanyIntegration\": 4245,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1687,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 7246,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n },\n {\n \"IDHubCategorias\": 8169,\n \"IDCompanyIntegration\": 9485,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7177,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 3941,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edd001f3-829f-4fb0-b383-4a2f74e4e6d2", "name": "Mensagens `[BadRequest]`:\n- `Categoria não cadastrada`\n- `Integração não cadastrada`", "originalRequest": { "url": { "path": [ "hub", "category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9708,\n \"IDCategoryTo\": 7915,\n \"IDCategoryFrom\": \"string\",\n \"CategoryFromTree\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3e7f868-28d9-4c96-b542-665861f90449", "name": "Edita mapeamento — Hub Categorias", "request": { "name": "Edita mapeamento — Hub Categorias", "description": { "content": "Edita o mapeamento. Retorna a lista atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "category", ":idhubcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9708,\n \"IDCategoryTo\": 7915,\n \"IDCategoryFrom\": \"string\",\n \"CategoryFromTree\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b8772e90-4f85-49e3-8954-2bf107fcca24", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "category", ":idhubcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9708,\n \"IDCategoryTo\": 7915,\n \"IDCategoryFrom\": \"string\",\n \"CategoryFromTree\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCategorias\": 404,\n \"IDCompanyIntegration\": 4245,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1687,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 7246,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n },\n {\n \"IDHubCategorias\": 8169,\n \"IDCompanyIntegration\": 9485,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7177,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 3941,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ef4ae0-fd0a-45ca-b861-3f8d2f7c564e", "name": "Mensagens `[BadRequest]`:\n- `Categoria não cadastrada`\n- `Integração não cadastrada`\n- `Categoria hub não existe`\n- `Já existe de/para de categoria para mesma categoria e integração`\n- `Erro ao inserir de/para de categoria`", "originalRequest": { "url": { "path": [ "hub", "category", ":idhubcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9708,\n \"IDCategoryTo\": 7915,\n \"IDCategoryFrom\": \"string\",\n \"CategoryFromTree\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0de19d0-55ef-407c-80f9-3bb1c56c4f57", "name": "Remove mapeamento — Hub Categorias", "request": { "name": "Remove mapeamento — Hub Categorias", "description": { "content": "Remove o mapeamento de categoria do canal. Bloqueado quando existe de/para de variação amarrado a essa categoria — remova as variações antes. A resposta é a lista de mapeamentos já atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "category", ":idhubcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "67db7330-22d0-4983-8e69-ab5f239914be", "name": "Lista atualizada após remoção.", "originalRequest": { "url": { "path": [ "hub", "category", ":idhubcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCategorias\": 404,\n \"IDCompanyIntegration\": 4245,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1687,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 7246,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n },\n {\n \"IDHubCategorias\": 8169,\n \"IDCompanyIntegration\": 9485,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7177,\n \"IDCategoryFrom\": \"string\",\n \"IDCategoryTo\": 3941,\n \"AccountName\": \"string\",\n \"CategoryFromTree\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93d315e8-6783-43c4-9c62-ecb8805809a6", "name": "Mensagens `[BadRequest]`:\n- `IDHubCategory não existe`\n- `Existe de/para de variação para essa categoria e a mesma não pode ser excluída`", "originalRequest": { "url": { "path": [ "hub", "category", ":idhubcategory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afca4185-040b-4a54-a015-928b23f20843", "name": "Reprocessa mapeamento (sincroniza com o canal)", "request": { "name": "Reprocessa mapeamento (sincroniza com o canal)", "description": { "content": "Sincroniza com o canal de vendas a categoria interna mapeada, criando ou atualizando lá a categoria correspondente com nome, título, descrição, palavras-chave e posição na hierarquia. A chamada é síncrona e a resposta devolvida é a que o canal retornou. Disponível apenas para os tipos de integração que oferecem o recurso Sincronizar Categoria e apenas quando esse recurso está ativo na integração da empresa. Não requer corpo na requisição.", "type": "text/plain" }, "url": { "path": [ "hub", "category", ":idhubcategory", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "5f2995e9-2bb2-4506-a231-9215dcb294a9", "name": "Resposta devolvida pelo canal de vendas. O formato varia conforme o canal.", "originalRequest": { "url": { "path": [ "hub", "category", ":idhubcategory", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34bd9e7a-f348-4952-b8e2-bb20e4a94ed8", "name": "Mensagens `[BadRequest]`:\n- `Integração não tem recurso` — o tipo de integração não oferece o recurso Sincronizar Categoria, a categoria informada não pertence à empresa, ou o canal não reconhece a rota.\n- `configuração não está ativa` — recurso desligado na integração da empresa.\n- `categoria não encontrada`\n- `categoria pai não cadastrada no canal` — a categoria pai precisa estar mapeada no canal antes da filha.\n\nOutras mensagens específicas do canal podem ser propagadas.", "originalRequest": { "url": { "path": [ "hub", "category", ":idhubcategory", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcategory", "description": "(Required) Identificador da categoria no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9e2c561a-a377-4eb3-8515-426d7f59114f", "name": "Hub — DE-PARA Adquirentes", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "29efb129-efed-4779-84a2-e8a3aec1f46a", "name": "Lista mapeamentos — DE-PARA Adquirentes", "request": { "name": "Lista mapeamentos — DE-PARA Adquirentes", "description": { "content": "Retorna todos os DE-PARA de adquirente cadastrados, ordenados pela integração.", "type": "text/plain" }, "url": { "path": [ "hub", "acquirer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDAcquirerFrom", "value": "string", "description": "Filtra pelo identificador da adquirente no canal." }, { "disabled": false, "key": "IDAcquirerTo", "value": "1603", "description": "Filtra pela adquirente cadastrada no idworks (`CompanyIntegration` do tipo adquirente)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3523a3ff-aaa7-40a9-a4c5-1bb74bdbd8c0", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "acquirer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDAcquirerFrom", "value": "string" }, { "key": "IDAcquirerTo", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubAcquirer\": 3389,\n \"AccountName\": \"string\",\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 5795,\n \"IDCompanyIntegration\": 1531,\n \"RecordTimestamp\": \"1995-05-11T02:53:34.610Z\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 6399,\n \"CompanyIntegrationAcquirer\": \"string\"\n },\n {\n \"IDHubAcquirer\": 488,\n \"AccountName\": \"string\",\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3574,\n \"IDCompanyIntegration\": 5448,\n \"RecordTimestamp\": \"2002-12-24T02:18:29.711Z\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 4206,\n \"CompanyIntegrationAcquirer\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1794159-acdc-451e-89a1-e523d3249704", "name": "Cria mapeamento — DE-PARA Adquirentes", "request": { "name": "Cria mapeamento — DE-PARA Adquirentes", "description": { "content": "Cria um DE-PARA e devolve a lista atualizada (re-invoca o List). O sistema rejeita duplicidade exata (mesma integração, mesma adquirente do canal e mesma adquirente interna).", "type": "text/plain" }, "url": { "path": [ "hub", "acquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6274,\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3456\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e3e58da-b4bd-45d2-a3f1-e9eb9bbb7ebd", "name": "Lista atualizada após criação.", "originalRequest": { "url": { "path": [ "hub", "acquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6274,\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3456\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubAcquirer\": 3389,\n \"AccountName\": \"string\",\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 5795,\n \"IDCompanyIntegration\": 1531,\n \"RecordTimestamp\": \"1995-05-11T02:53:34.610Z\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 6399,\n \"CompanyIntegrationAcquirer\": \"string\"\n },\n {\n \"IDHubAcquirer\": 488,\n \"AccountName\": \"string\",\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3574,\n \"IDCompanyIntegration\": 5448,\n \"RecordTimestamp\": \"2002-12-24T02:18:29.711Z\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 4206,\n \"CompanyIntegrationAcquirer\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fa6a9e3-23b0-4acb-a4fa-b20b0b4327f0", "name": "Mensagens `[BadRequest]`:\n- `Integração não cadastrada`\n- `Integração adquirente não cadastrada`\n- `Já existe um de/para igual criado`", "originalRequest": { "url": { "path": [ "hub", "acquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6274,\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07e08771-f7e9-4eed-ad16-1698c68b13f3", "name": "Atualiza mapeamento — DE-PARA Adquirentes", "request": { "name": "Atualiza mapeamento — DE-PARA Adquirentes", "description": { "content": "Atualiza um DE-PARA e devolve a lista atualizada. Mesmo body do POST. O sistema rejeita duplicidade contra outros registros existentes.", "type": "text/plain" }, "url": { "path": [ "hub", "acquirer", ":idhubacquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubacquirer", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6274,\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3456\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0909718c-ffe7-4a4e-92ba-a54b106a40cc", "name": "Lista atualizada após edição.", "originalRequest": { "url": { "path": [ "hub", "acquirer", ":idhubacquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubacquirer", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6274,\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3456\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubAcquirer\": 3389,\n \"AccountName\": \"string\",\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 5795,\n \"IDCompanyIntegration\": 1531,\n \"RecordTimestamp\": \"1995-05-11T02:53:34.610Z\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 6399,\n \"CompanyIntegrationAcquirer\": \"string\"\n },\n {\n \"IDHubAcquirer\": 488,\n \"AccountName\": \"string\",\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3574,\n \"IDCompanyIntegration\": 5448,\n \"RecordTimestamp\": \"2002-12-24T02:18:29.711Z\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 4206,\n \"CompanyIntegrationAcquirer\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1e4331a-1c45-4470-8c51-d52e727887e8", "name": "Mensagens `[BadRequest]`:\n- `De/Para adquirente não existe`\n- `Integração adquirente não cadastrada`\n- `Já existe um de/para igual criado`", "originalRequest": { "url": { "path": [ "hub", "acquirer", ":idhubacquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubacquirer", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6274,\n \"IDAcquirerFrom\": \"string\",\n \"IDAcquirerTo\": 3456\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25345f72-b5dd-47d3-853e-d4bb801adf1e", "name": "Remove mapeamento — DE-PARA Adquirentes", "request": { "name": "Remove mapeamento — DE-PARA Adquirentes", "description": { "content": "Apaga o DE-PARA.", "type": "text/plain" }, "url": { "path": [ "hub", "acquirer", ":idhubacquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubacquirer", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "be461cfb-cc2c-4cd2-bee8-61d74c0c6420", "name": "Texto literal `sucesso` quando a remoção é concluída.", "originalRequest": { "url": { "path": [ "hub", "acquirer", ":idhubacquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubacquirer", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf587398-1374-4a1c-a8da-6469f756448f", "name": "`[BadRequest] - De/Para adquirente não existe`.", "originalRequest": { "url": { "path": [ "hub", "acquirer", ":idhubacquirer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubacquirer", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7d6e06e0-972b-470d-841a-01fe1158ec9a", "name": "Hub — DE-PARA Transportadora", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "98bb0698-fef2-46ba-8f08-d3a6b64da3e5", "name": "Lista mapeamentos — DE-PARA Transportadora", "request": { "name": "Lista mapeamentos — DE-PARA Transportadora", "description": { "content": "Retorna todos os DE-PARA cadastrados, ordenados por integração e nome.", "type": "text/plain" }, "url": { "path": [ "hub", "carrier" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelos DE-PARA de uma integração específica." }, { "disabled": false, "key": "IDCarrierFrom", "value": "string", "description": "Filtra pelo identificador da transportadora no canal." }, { "disabled": false, "key": "IDCarrierTo", "value": "1603", "description": "Filtra pela transportadora interna mapeada." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7436bfc8-139d-4921-a797-84bad8085356", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "carrier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDCarrierFrom", "value": "string" }, { "key": "IDCarrierTo", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCarrier\": 9943,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 8920,\n \"RecordTimestamp\": \"1959-07-10T06:31:04.985Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 4470,\n \"NfeModFrete\": 4371,\n \"IDStatusOrder\": 636,\n \"CarrierAuctionByModal\": 8234,\n \"IDCarrierModal\": 4547,\n \"CarrierAuctionByModalOrderPreference\": 8982,\n \"IDStockKeepingUnitWarehouse\": 2774,\n \"IDTypeCarrierAuction\": 2526,\n \"IDTypeCarrierAuctionTiebreaker\": 5959,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7708,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubCarrier\": 3815,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 733,\n \"RecordTimestamp\": \"2023-08-28T18:41:31.226Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 9590,\n \"NfeModFrete\": 4602,\n \"IDStatusOrder\": 6707,\n \"CarrierAuctionByModal\": 3116,\n \"IDCarrierModal\": 3980,\n \"CarrierAuctionByModalOrderPreference\": 2403,\n \"IDStockKeepingUnitWarehouse\": 9972,\n \"IDTypeCarrierAuction\": 9534,\n \"IDTypeCarrierAuctionTiebreaker\": 4838,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 2724,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "787690f8-b4ed-43e3-a948-192118194ff0", "name": "Cria mapeamento — DE-PARA Transportadora", "request": { "name": "Cria mapeamento — DE-PARA Transportadora", "description": { "content": "Cria um DE-PARA de transportadora e devolve a lista completa atualizada. Quando `CarrierAuctionByModal=1`, o sistema força `IDCarrierTo` para `null` — a transportadora final é escolhida em tempo de roteirização pelo leilão entre as transportadoras do modal indicado em `IDCarrierModal`. Não é permitido cadastrar dois DE-PARA com a mesma combinação de `IDCompanyIntegration`, `IDCarrierFrom` e `IDCarrierTo`; a checagem só roda quando `IDCarrierTo` é informado, então mapeamentos com leilão por modal não caem nessa restrição.", "type": "text/plain" }, "url": { "path": [ "hub", "carrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 5566,\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 6412,\n \"NfeModFrete\": 0,\n \"IDStatusOrder\": 1624,\n \"CarrierAuctionByModal\": 1,\n \"CarrierAuctionByModalOrderPreference\": 1,\n \"IDCarrierModal\": 8468,\n \"IDStockKeepingUnitWarehouse\": 1539,\n \"IDTypeCarrierAuction\": 2,\n \"IDTypeCarrierAuctionTiebreaker\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "68526a8b-8d0a-4a6b-8ab4-39bbdfac3653", "name": "Lista atualizada após a criação.", "originalRequest": { "url": { "path": [ "hub", "carrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 5566,\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 6412,\n \"NfeModFrete\": 0,\n \"IDStatusOrder\": 1624,\n \"CarrierAuctionByModal\": 1,\n \"CarrierAuctionByModalOrderPreference\": 1,\n \"IDCarrierModal\": 8468,\n \"IDStockKeepingUnitWarehouse\": 1539,\n \"IDTypeCarrierAuction\": 2,\n \"IDTypeCarrierAuctionTiebreaker\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCarrier\": 9943,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 8920,\n \"RecordTimestamp\": \"1959-07-10T06:31:04.985Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 4470,\n \"NfeModFrete\": 4371,\n \"IDStatusOrder\": 636,\n \"CarrierAuctionByModal\": 8234,\n \"IDCarrierModal\": 4547,\n \"CarrierAuctionByModalOrderPreference\": 8982,\n \"IDStockKeepingUnitWarehouse\": 2774,\n \"IDTypeCarrierAuction\": 2526,\n \"IDTypeCarrierAuctionTiebreaker\": 5959,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7708,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubCarrier\": 3815,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 733,\n \"RecordTimestamp\": \"2023-08-28T18:41:31.226Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 9590,\n \"NfeModFrete\": 4602,\n \"IDStatusOrder\": 6707,\n \"CarrierAuctionByModal\": 3116,\n \"IDCarrierModal\": 3980,\n \"CarrierAuctionByModalOrderPreference\": 2403,\n \"IDStockKeepingUnitWarehouse\": 9972,\n \"IDTypeCarrierAuction\": 9534,\n \"IDTypeCarrierAuctionTiebreaker\": 4838,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 2724,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d5fb1f5-1a03-4668-8601-710665b70220", "name": "Mensagens `[BadRequest]`:\n- `Integração não cadastrada`\n- `Transportadora não cadastrada`\n- `Status pedido não existe`\n- `Modal não existe`\n- `Armazém não existe`\n- `DE-PARA já existe para mesma integração com mesmo código(canal) e transportadora.` — já existe mapeamento com a mesma combinação de `IDCompanyIntegration`, `IDCarrierFrom` e `IDCarrierTo`.", "originalRequest": { "url": { "path": [ "hub", "carrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 5566,\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 6412,\n \"NfeModFrete\": 0,\n \"IDStatusOrder\": 1624,\n \"CarrierAuctionByModal\": 1,\n \"CarrierAuctionByModalOrderPreference\": 1,\n \"IDCarrierModal\": 8468,\n \"IDStockKeepingUnitWarehouse\": 1539,\n \"IDTypeCarrierAuction\": 2,\n \"IDTypeCarrierAuctionTiebreaker\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "432e0d29-ad20-4b7f-9698-bd288378fa79", "name": "Atualiza mapeamento — DE-PARA Transportadora", "request": { "name": "Atualiza mapeamento — DE-PARA Transportadora", "description": { "content": "Substitui um DE-PARA existente e devolve a lista completa atualizada. **Substituição completa**: todos os campos do mapeamento são reescritos a cada chamada, então omitir um campo apaga o valor atual. Mesmas validações do POST, incluindo a de duplicidade — que aqui só é executada quando `IDCompanyIntegration`, `IDCarrierFrom` e `IDCarrierTo` vêm todos preenchidos, e que **não exclui o próprio registro em edição**, de modo que reenviar a mesma combinação desses três campos que já está gravada é rejeitada.", "type": "text/plain" }, "url": { "path": [ "hub", "carrier", ":idhubcarrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcarrier", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 8701,\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 1246,\n \"NfeModFrete\": 4,\n \"IDStatusOrder\": 2052,\n \"CarrierAuctionByModal\": 1,\n \"CarrierAuctionByModalOrderPreference\": 2,\n \"IDCarrierModal\": 8567,\n \"IDStockKeepingUnitWarehouse\": 3680,\n \"IDTypeCarrierAuction\": 1,\n \"IDTypeCarrierAuctionTiebreaker\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d4e19d1f-e972-4bb5-b409-82886955a44b", "name": "Lista completa de mapeamentos após a edição. Atenção: a lista só é devolvida quando a gravação altera ao menos um campo — se o corpo enviado for idêntico ao que já está gravado, a chamada não produz resposta e o cliente vê um tempo de espera esgotado, não um `200` vazio.", "originalRequest": { "url": { "path": [ "hub", "carrier", ":idhubcarrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcarrier", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 8701,\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 1246,\n \"NfeModFrete\": 4,\n \"IDStatusOrder\": 2052,\n \"CarrierAuctionByModal\": 1,\n \"CarrierAuctionByModalOrderPreference\": 2,\n \"IDCarrierModal\": 8567,\n \"IDStockKeepingUnitWarehouse\": 3680,\n \"IDTypeCarrierAuction\": 1,\n \"IDTypeCarrierAuctionTiebreaker\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCarrier\": 9943,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 8920,\n \"RecordTimestamp\": \"1959-07-10T06:31:04.985Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 4470,\n \"NfeModFrete\": 4371,\n \"IDStatusOrder\": 636,\n \"CarrierAuctionByModal\": 8234,\n \"IDCarrierModal\": 4547,\n \"CarrierAuctionByModalOrderPreference\": 8982,\n \"IDStockKeepingUnitWarehouse\": 2774,\n \"IDTypeCarrierAuction\": 2526,\n \"IDTypeCarrierAuctionTiebreaker\": 5959,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7708,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubCarrier\": 3815,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 733,\n \"RecordTimestamp\": \"2023-08-28T18:41:31.226Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 9590,\n \"NfeModFrete\": 4602,\n \"IDStatusOrder\": 6707,\n \"CarrierAuctionByModal\": 3116,\n \"IDCarrierModal\": 3980,\n \"CarrierAuctionByModalOrderPreference\": 2403,\n \"IDStockKeepingUnitWarehouse\": 9972,\n \"IDTypeCarrierAuction\": 9534,\n \"IDTypeCarrierAuctionTiebreaker\": 4838,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 2724,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d47b3a3-789d-46d1-97c6-4214040b8a33", "name": "Mensagens `[BadRequest]`:\n- `de/para transportadora não existe`\n- `Integração não cadastrada`\n- `Transportadora não cadastrada`\n- `Status pedido não existe`\n- `Modal não existe`\n- `Armazém não existe`\n- `DE-PARA já existe para mesma integração com mesmo código(canal) e transportadora.`", "originalRequest": { "url": { "path": [ "hub", "carrier", ":idhubcarrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcarrier", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 8701,\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 1246,\n \"NfeModFrete\": 4,\n \"IDStatusOrder\": 2052,\n \"CarrierAuctionByModal\": 1,\n \"CarrierAuctionByModalOrderPreference\": 2,\n \"IDCarrierModal\": 8567,\n \"IDStockKeepingUnitWarehouse\": 3680,\n \"IDTypeCarrierAuction\": 1,\n \"IDTypeCarrierAuctionTiebreaker\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5081155-f5a6-457c-95c7-cdee11e2501b", "name": "Remove mapeamento — DE-PARA Transportadora", "request": { "name": "Remove mapeamento — DE-PARA Transportadora", "description": { "content": "Apaga o DE-PARA e devolve a lista completa atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "carrier", ":idhubcarrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcarrier", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "11f5b297-c4a0-413f-ba9e-bee48c77cef1", "name": "Lista atualizada após remoção.", "originalRequest": { "url": { "path": [ "hub", "carrier", ":idhubcarrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcarrier", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubCarrier\": 9943,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 8920,\n \"RecordTimestamp\": \"1959-07-10T06:31:04.985Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 4470,\n \"NfeModFrete\": 4371,\n \"IDStatusOrder\": 636,\n \"CarrierAuctionByModal\": 8234,\n \"IDCarrierModal\": 4547,\n \"CarrierAuctionByModalOrderPreference\": 8982,\n \"IDStockKeepingUnitWarehouse\": 2774,\n \"IDTypeCarrierAuction\": 2526,\n \"IDTypeCarrierAuctionTiebreaker\": 5959,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7708,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubCarrier\": 3815,\n \"AccountName\": \"string\",\n \"IDCarrierFrom\": \"string\",\n \"IDCarrierTo\": 733,\n \"RecordTimestamp\": \"2023-08-28T18:41:31.226Z\",\n \"OrderOnHold\": 0,\n \"IDCompanyIntegration\": 9590,\n \"NfeModFrete\": 4602,\n \"IDStatusOrder\": 6707,\n \"CarrierAuctionByModal\": 3116,\n \"IDCarrierModal\": 3980,\n \"CarrierAuctionByModalOrderPreference\": 2403,\n \"IDStockKeepingUnitWarehouse\": 9972,\n \"IDTypeCarrierAuction\": 9534,\n \"IDTypeCarrierAuctionTiebreaker\": 4838,\n \"SupplierNameCorporateName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 2724,\n \"CompanyIntegration\": \"string\",\n \"NfModFreteDescription\": \"string\",\n \"StatusOrder\": \"string\",\n \"CarrierModal\": \"string\",\n \"CarrierAuctionByModalOrderPreferenceDescription\": \"string\",\n \"WarehouseName\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6833ed4a-5c12-417b-9c32-ac8717d6baad", "name": "`[BadRequest] - IDHubCarrier não existe`.", "originalRequest": { "url": { "path": [ "hub", "carrier", ":idhubcarrier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubcarrier", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "952ebe48-354b-4c81-bfde-d6543a95a620", "name": "Cotação de frete — leilão entre transportadoras", "request": { "name": "Cotação de frete — leilão entre transportadoras", "description": { "content": "Dispara o motor de cotação de frete (leilão) entre as transportadoras cadastradas. `GET` e `POST` da mesma rota têm o mesmo comportamento. Retorna a lista de transportadoras com `ShippingShowValue`, `TotalShowDaysTime`, `Attended` e os componentes de preço (ICMS, GRIS, advalorem, pedágio etc.).", "type": "text/plain" }, "url": { "path": [ "hub", "carrier", "auction" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Quando informado, identifica a integração de origem da cotação (canal externo)." }, { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "1603", "description": "Tipo de integração — usado para entregar o response no formato esperado pelo canal (Tray, Meli, Convertize, etc.)." }, { "disabled": false, "key": "debug", "value": "1", "description": "Quando `1`, imprime o trace de cada regra avaliada." }, { "disabled": false, "key": "online", "value": "1", "description": "Quando `1`, persiste a cotação temporariamente sob a chave `CarrierQuotation:` (permitindo respostas subsequentes via `If-None-Match`). Default `0`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "eae49b2e-9fcc-49cd-8fc5-ade0ead874f0", "name": "Resultado da cotação.", "originalRequest": { "url": { "path": [ "hub", "carrier", "auction" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "debug", "value": "1" }, { "key": "online", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10b42b3e-10fc-4ced-afa2-bca703f6d9a4", "name": "Resposta condicional — o `If-None-Match` enviado ainda é válido para o canal e a cotação anterior não mudou.", "originalRequest": { "url": { "path": [ "hub", "carrier", "auction" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "debug", "value": "1" }, { "key": "online", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Modified", "code": 304, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "926b3955-fe33-41c5-a9c4-e4972d49858c", "name": "Erros de negócio. Exemplos: `Empresa não localizada`, `Precisa enviar corpo`, `Precisa enviar o CEP destino`, `Peso precisa ser maior que zero`, `CEP destino XXXXX não existe`, `Dados para cotação não enviados`.", "originalRequest": { "url": { "path": [ "hub", "carrier", "auction" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "debug", "value": "1" }, { "key": "online", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73766c5f-d1cc-4548-a0f8-03bba50c0110", "name": "Cotação de frete — leilão entre transportadoras", "request": { "name": "Cotação de frete — leilão entre transportadoras", "description": { "content": "Mesma função de `GET /hub/carrier/auction`, porém recebe os dados da cotação no corpo da requisição. O corpo tem ao menos `ShippingPostalCode` (CEP destino) e um array `Quotations[]` com `Weight`, `Height`, `Length`, `Width`, `ValueInvoice` por volume; aceita também `OriginPostalCode`, `Description`, `IDOrder`, `IDCompanyIntegration`, `IDSkuHub`, `IDSkuCompany`, `IDTypeCompanyIntegration`, `RecordUserCreated`.", "type": "text/plain" }, "url": { "path": [ "hub", "carrier", "auction" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelo identificador da integração da empresa." }, { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "1603", "description": "Filtra pelo tipo de integração da empresa." }, { "disabled": false, "key": "debug", "value": "1", "description": "Quando `1`, inclui informações adicionais de depuração na resposta." }, { "disabled": false, "key": "online", "value": "1", "description": "Quando `1`, restringe a integrações ou canais online." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ShippingPostalCode\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"ValueInvoice\": 34.667061490660785,\n \"IDOrder\": 1864,\n \"Description\": \"string\",\n \"RecordUserCreated\": 172,\n \"Quotations\": [\n {\n \"Weight\": 6025.974079652295,\n \"Height\": 2383.4240573233956,\n \"Length\": 9178.103084383,\n \"Width\": 3351.012440843488,\n \"ValueInvoice\": 9324.71503063762\n },\n {\n \"Weight\": 8038.46688496854,\n \"Height\": 8116.700836854092,\n \"Length\": 692.3294916658884,\n \"Width\": 7308.757600296532,\n \"ValueInvoice\": 7655.324486758474\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5d13563-9172-4e3b-8dde-4c4cfdfccd35", "name": "Resultado da cotação.", "originalRequest": { "url": { "path": [ "hub", "carrier", "auction" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "debug", "value": "1" }, { "key": "online", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingPostalCode\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"ValueInvoice\": 8580.212555350197,\n \"IDOrder\": 7872,\n \"Description\": \"string\",\n \"RecordUserCreated\": 3193,\n \"Quotations\": [\n {\n \"Weight\": 8770.566828415678,\n \"Height\": 4481.998306685706,\n \"Length\": 8211.594880816278,\n \"Width\": 6639.040645790255,\n \"ValueInvoice\": 4486.12984392692\n },\n {\n \"Weight\": 5338.328962416002,\n \"Height\": 3862.2643764812415,\n \"Length\": 2807.6304459212165,\n \"Width\": 9741.52479703984,\n \"ValueInvoice\": 9200.09913642087\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5792eab6-4db4-4a2b-ac42-421a0634a82e", "name": "Erros de negócio: `Precisa enviar corpo`, `Precisa enviar o CEP destino`, `Peso precisa ser maior que zero`, `CEP destino XXXXX não existe`, `Empresa não localizada`, `Dados para cotação não enviados`.", "originalRequest": { "url": { "path": [ "hub", "carrier", "auction" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "debug", "value": "1" }, { "key": "online", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ShippingPostalCode\": \"string\",\n \"OriginPostalCode\": \"string\",\n \"ValueInvoice\": 8580.212555350197,\n \"IDOrder\": 7872,\n \"Description\": \"string\",\n \"RecordUserCreated\": 3193,\n \"Quotations\": [\n {\n \"Weight\": 8770.566828415678,\n \"Height\": 4481.998306685706,\n \"Length\": 8211.594880816278,\n \"Width\": 6639.040645790255,\n \"ValueInvoice\": 4486.12984392692\n },\n {\n \"Weight\": 5338.328962416002,\n \"Height\": 3862.2643764812415,\n \"Length\": 2807.6304459212165,\n \"Width\": 9741.52479703984,\n \"ValueInvoice\": 9200.09913642087\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e5bc259-2551-4acb-9798-b82557435c65", "name": "Cotação de frete a partir de uma integração específica", "request": { "name": "Cotação de frete a partir de uma integração específica", "description": { "content": "Mesma função das rotas `/hub/carrier/auction`, porém a integração de origem da cotação vem como parâmetro de path em vez de query.", "type": "text/plain" }, "url": { "path": [ "hub", "carrier", "auction", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idcompanyintegration", "description": "(Required) Integração de origem da cotação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "79350d23-50fc-4cac-a3f1-4d1107e308f6", "name": "Resultado da cotação.", "originalRequest": { "url": { "path": [ "hub", "carrier", "auction", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idcompanyintegration", "description": "(Required) Integração de origem da cotação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b49cfee-d71a-43fd-8cef-a568a9d6ffb9", "name": "Erros de negócio.", "originalRequest": { "url": { "path": [ "hub", "carrier", "auction", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idcompanyintegration", "description": "(Required) Integração de origem da cotação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ae333a64-e84e-42ec-8952-bcbcbf8a007b", "name": "Hub — DE-PARA Variações", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2ac7ae5a-d74d-4841-9093-177306bd9f17", "name": "Lista mapeamentos — DE-PARA Variações", "request": { "name": "Lista mapeamentos — DE-PARA Variações", "description": { "content": "Retorna os DE-PARA de variação cadastrados, ordenados por integração.", "type": "text/plain" }, "url": { "path": [ "hub", "variation" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pela integração." }, { "disabled": false, "key": "IDVariationTo", "value": "1603", "description": "Filtra pela variação interna (`IDTypeProductVariation`)." }, { "disabled": false, "key": "VariationName", "value": "string", "description": "Busca textual no nome da variação interna (`ProductVariation`) via `LIKE`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "863b3bfe-d6d1-442b-a9e6-3d42bc8095c7", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "variation" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDVariationTo", "value": "1603" }, { "key": "VariationName", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubVariation\": 6510,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1966-09-12T05:56:25.462Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 1048,\n \"IDCompanyIntegration\": 9926,\n \"IDHubCategory\": 8735,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 8979,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 2782,\n \"IDCategoryFrom\": \"string\"\n },\n {\n \"IDHubVariation\": 6566,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1989-08-01T23:45:37.860Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 7746,\n \"IDCompanyIntegration\": 7995,\n \"IDHubCategory\": 98,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 3268,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 6267,\n \"IDCategoryFrom\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "221b3c62-94e6-46a0-8133-15a1bc7af25e", "name": "Cria mapeamento — DE-PARA Variações", "request": { "name": "Cria mapeamento — DE-PARA Variações", "description": { "content": "Cria um DE-PARA e devolve a lista atualizada (re-invoca o List). O sistema valida unicidade do trio (variação interna, integração, DE-PARA de categoria).", "type": "text/plain" }, "url": { "path": [ "hub", "variation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3400,\n \"IDHubCategory\": 6963,\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 4606\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1684df79-fa98-47c4-88fb-74694776d549", "name": "Lista atualizada após criação.", "originalRequest": { "url": { "path": [ "hub", "variation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3400,\n \"IDHubCategory\": 6963,\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 4606\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubVariation\": 6510,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1966-09-12T05:56:25.462Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 1048,\n \"IDCompanyIntegration\": 9926,\n \"IDHubCategory\": 8735,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 8979,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 2782,\n \"IDCategoryFrom\": \"string\"\n },\n {\n \"IDHubVariation\": 6566,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1989-08-01T23:45:37.860Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 7746,\n \"IDCompanyIntegration\": 7995,\n \"IDHubCategory\": 98,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 3268,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 6267,\n \"IDCategoryFrom\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a9a3162-f315-4022-b703-cb31f07c8e71", "name": "Mensagens `[BadRequest]`:\n- `Integração não cadastrada`\n- `Variação não cadastrada`\n- `Hub Categoria não existe`\n- `Já existe um de/para igual criado`", "originalRequest": { "url": { "path": [ "hub", "variation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3400,\n \"IDHubCategory\": 6963,\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 4606\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54faab67-ae35-401a-94a7-a85b950c0e31", "name": "Atualiza mapeamento — DE-PARA Variações", "request": { "name": "Atualiza mapeamento — DE-PARA Variações", "description": { "content": "Atualiza um DE-PARA e devolve a lista atualizada. Mesmas validações do POST mais a verificação de existência do registro.", "type": "text/plain" }, "url": { "path": [ "hub", "variation", ":idhubvariation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubvariation", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3400,\n \"IDHubCategory\": 6963,\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 4606\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "940d1765-d5b1-4b2d-8273-fadab481d73d", "name": "Lista atualizada após edição.", "originalRequest": { "url": { "path": [ "hub", "variation", ":idhubvariation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubvariation", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3400,\n \"IDHubCategory\": 6963,\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 4606\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubVariation\": 6510,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1966-09-12T05:56:25.462Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 1048,\n \"IDCompanyIntegration\": 9926,\n \"IDHubCategory\": 8735,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 8979,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 2782,\n \"IDCategoryFrom\": \"string\"\n },\n {\n \"IDHubVariation\": 6566,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1989-08-01T23:45:37.860Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 7746,\n \"IDCompanyIntegration\": 7995,\n \"IDHubCategory\": 98,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 3268,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 6267,\n \"IDCategoryFrom\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa010f2a-6e2a-43ca-a968-92f2a0feacd7", "name": "Mensagens `[BadRequest]`:\n- `De/Para variação não existe`\n- `Variação não cadastrada`\n- `Hub Categoria não existe`\n- `Já existe um de/para igual criado`", "originalRequest": { "url": { "path": [ "hub", "variation", ":idhubvariation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubvariation", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3400,\n \"IDHubCategory\": 6963,\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 4606\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f920bd5-3a5d-46f9-964c-9e654564deb2", "name": "Remove mapeamento — DE-PARA Variações", "request": { "name": "Remove mapeamento — DE-PARA Variações", "description": { "content": "Apaga o DE-PARA e devolve a lista atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "variation", ":idhubvariation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubvariation", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "8acf39ba-38a4-49f0-b6b7-ddd05789df39", "name": "Lista atualizada após remoção.", "originalRequest": { "url": { "path": [ "hub", "variation", ":idhubvariation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubvariation", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubVariation\": 6510,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1966-09-12T05:56:25.462Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 1048,\n \"IDCompanyIntegration\": 9926,\n \"IDHubCategory\": 8735,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 8979,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 2782,\n \"IDCategoryFrom\": \"string\"\n },\n {\n \"IDHubVariation\": 6566,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1989-08-01T23:45:37.860Z\",\n \"IDVariationFrom\": \"string\",\n \"IDVariationTo\": 7746,\n \"IDCompanyIntegration\": 7995,\n \"IDHubCategory\": 98,\n \"VariationName\": \"string\",\n \"IDSalesChannel\": 3268,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"CategoryFromTree\": \"string\",\n \"IDTypeCompanyIntegration\": 6267,\n \"IDCategoryFrom\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5289e7c7-ac42-4d9a-baa2-e8b961f6ef8e", "name": "`[BadRequest] - IDHubVariation não existe`.", "originalRequest": { "url": { "path": [ "hub", "variation", ":idhubvariation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubvariation", "description": "(Required) Identificador do mapeamento." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9786db3c-2ee7-4aa3-8c50-9711e59fa8bb", "name": "Hub — Estoque", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "85726fdd-ab68-4a57-a302-319a57a5d7fd", "name": "Lista mapeamentos — Hub Estoque", "request": { "name": "Lista mapeamentos — Hub Estoque", "description": { "content": "Lista os mapeamentos da empresa autenticada. Sem paginação.", "type": "text/plain" }, "url": { "path": [ "hub", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelo identificador da integração da empresa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "580220bf-82af-434c-80a2-4d4c457d24d7", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubEstoque\": 4419,\n \"IDCompanyIntegration\": 445,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 24,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3675,\n \"AccountName\": \"string\",\n \"IDOrderType\": 4702,\n \"IDStatusOrder\": 7414,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubEstoque\": 8291,\n \"IDCompanyIntegration\": 2505,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7453,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3181,\n \"AccountName\": \"string\",\n \"IDOrderType\": 2317,\n \"IDStatusOrder\": 3761,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec83c78e-75dc-4e83-ab0a-212436bd518e", "name": "Cria mapeamento — Hub Estoque", "request": { "name": "Cria mapeamento — Hub Estoque", "description": { "content": "Cria um mapeamento DE/PARA entre o código de armazém do canal e um armazém interno. A combinação de armazém de origem, armazém de destino e integração precisa ser inédita. Retorna a lista completa e atualizada de mapeamentos da integração.", "type": "text/plain" }, "url": { "path": [ "hub", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6525,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 1179,\n \"IDOrderType\": 3188,\n \"IDStatusOrder\": 96\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8f3db0dc-4dc8-4931-ac00-24b407471bbd", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6525,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 1179,\n \"IDOrderType\": 3188,\n \"IDStatusOrder\": 96\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubEstoque\": 4419,\n \"IDCompanyIntegration\": 445,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 24,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3675,\n \"AccountName\": \"string\",\n \"IDOrderType\": 4702,\n \"IDStatusOrder\": 7414,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubEstoque\": 8291,\n \"IDCompanyIntegration\": 2505,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7453,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3181,\n \"AccountName\": \"string\",\n \"IDOrderType\": 2317,\n \"IDStatusOrder\": 3761,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4827adde-2240-410f-a3d1-f72300f6c5ce", "name": "Mensagens `[BadRequest]`:\n- `DE/PARA de armazém já existe`\n- `Tipo Pedido não cadastrado`\n- `Armazém não cadastrado`\n- `Integração não cadastrada`\n- `Status pedido não existe`", "originalRequest": { "url": { "path": [ "hub", "warehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6525,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 1179,\n \"IDOrderType\": 3188,\n \"IDStatusOrder\": 96\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "091fbb20-7c48-4687-a987-eb55b32ad9f4", "name": "Edita mapeamento — Hub Estoque", "request": { "name": "Edita mapeamento — Hub Estoque", "description": { "content": "Edita o mapeamento. Retorna a lista atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "warehouse", ":idhubwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubwarehouse", "description": "(Required) Identificador do depósito no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6525,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 1179,\n \"IDOrderType\": 3188,\n \"IDStatusOrder\": 96\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "359f9c2e-72a6-476e-97e5-c448f122bbd8", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "warehouse", ":idhubwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubwarehouse", "description": "(Required) Identificador do depósito no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6525,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 1179,\n \"IDOrderType\": 3188,\n \"IDStatusOrder\": 96\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubEstoque\": 4419,\n \"IDCompanyIntegration\": 445,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 24,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3675,\n \"AccountName\": \"string\",\n \"IDOrderType\": 4702,\n \"IDStatusOrder\": 7414,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubEstoque\": 8291,\n \"IDCompanyIntegration\": 2505,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7453,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3181,\n \"AccountName\": \"string\",\n \"IDOrderType\": 2317,\n \"IDStatusOrder\": 3761,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "429dc301-7791-4349-ae53-1ec64f608c9d", "name": "Mensagens `[BadRequest]`:\n- `Tipo Pedido não cadastrado`\n- `Armazém não cadastrada`\n- `Integração não cadastrada`\n- `De/para armazém não cadastrado`\n- `Status pedido não existe`", "originalRequest": { "url": { "path": [ "hub", "warehouse", ":idhubwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubwarehouse", "description": "(Required) Identificador do depósito no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6525,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 1179,\n \"IDOrderType\": 3188,\n \"IDStatusOrder\": 96\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2c824e9-544a-44b7-ad77-cab8cc1083e7", "name": "Remove mapeamento — Hub Estoque", "request": { "name": "Remove mapeamento — Hub Estoque", "description": { "content": "Apaga o mapeamento. A lista da integração é atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "warehouse", ":idhubwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubwarehouse", "description": "(Required) Identificador do depósito no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7a3b1522-8b28-4c7c-a9c7-869de6fa004a", "name": "Lista atualizada após remoção.", "originalRequest": { "url": { "path": [ "hub", "warehouse", ":idhubwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubwarehouse", "description": "(Required) Identificador do depósito no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubEstoque\": 4419,\n \"IDCompanyIntegration\": 445,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 24,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3675,\n \"AccountName\": \"string\",\n \"IDOrderType\": 4702,\n \"IDStatusOrder\": 7414,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n },\n {\n \"IDHubEstoque\": 8291,\n \"IDCompanyIntegration\": 2505,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 7453,\n \"IDStockKeepingUnitWarehouseFrom\": \"string\",\n \"IDStockKeepingUnitWarehouseTo\": 3181,\n \"AccountName\": \"string\",\n \"IDOrderType\": 2317,\n \"IDStatusOrder\": 3761,\n \"WarehouseName\": \"string\",\n \"Status\": 0,\n \"TypeOrder\": \"string\",\n \"StatusOrder\": \"string\",\n \"StatusColorCode\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93327476-342b-4d14-a360-9facecd2da68", "name": "Mensagens `[BadRequest]`:\n- `IDHubWarehouse não existe`", "originalRequest": { "url": { "path": [ "hub", "warehouse", ":idhubwarehouse" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubwarehouse", "description": "(Required) Identificador do depósito no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d9c8c9a2-8bcf-4aea-bb48-53a96ce4f4de", "name": "Hub — Marcas", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2dc78100-14b2-4e69-95d6-67c789f4d729", "name": "Lista mapeamentos — Hub Marcas", "request": { "name": "Lista mapeamentos — Hub Marcas", "description": { "content": "Lista os mapeamentos da empresa autenticada. Sem paginação.", "type": "text/plain" }, "url": { "path": [ "hub", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelo identificador da integração da empresa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "11c5f439-f26b-4efa-92f2-b29691f3271b", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubMarcas\": 3717,\n \"IDCompanyIntegration\": 4014,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 4580,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 7364,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubMarcas\": 6607,\n \"IDCompanyIntegration\": 9468,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 928,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 5299,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ee331e4-1250-4b65-9b7f-49c6c61745f7", "name": "Cria mapeamento — Hub Marcas", "request": { "name": "Cria mapeamento — Hub Marcas", "description": { "content": "Cria um novo mapeamento. Retorna a lista completa atualizada (re-invoca o List).", "type": "text/plain" }, "url": { "path": [ "hub", "brand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3593,\n \"IDBrandTo\": 3650,\n \"IDBrandFrom\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6bb2426e-b7d7-4762-8dbc-09f60dd5efdf", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "brand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3593,\n \"IDBrandTo\": 3650,\n \"IDBrandFrom\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubMarcas\": 3717,\n \"IDCompanyIntegration\": 4014,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 4580,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 7364,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubMarcas\": 6607,\n \"IDCompanyIntegration\": 9468,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 928,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 5299,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "813f801f-29e5-435d-94b7-44a6e0f12493", "name": "Mensagens `[BadRequest]`:\n- `Marca não cadastrada`\n- `Integração não cadastrada`", "originalRequest": { "url": { "path": [ "hub", "brand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3593,\n \"IDBrandTo\": 3650,\n \"IDBrandFrom\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2962ed2e-6b33-4a60-a602-f55ffee6aa59", "name": "Edita mapeamento — Hub Marcas", "request": { "name": "Edita mapeamento — Hub Marcas", "description": { "content": "Edita o mapeamento. Retorna a lista atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "brand", ":idhubbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3593,\n \"IDBrandTo\": 3650,\n \"IDBrandFrom\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "475aa609-6363-4677-a624-3f1b700f561d", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "brand", ":idhubbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3593,\n \"IDBrandTo\": 3650,\n \"IDBrandFrom\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubMarcas\": 3717,\n \"IDCompanyIntegration\": 4014,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 4580,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 7364,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubMarcas\": 6607,\n \"IDCompanyIntegration\": 9468,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 928,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 5299,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b301a7f8-239f-4aca-bcef-761ddd884412", "name": "Mensagens `[BadRequest]`:\n- `Marca não cadastrada`\n- `Integração não cadastrada`\n- `De/Para marca não existe`", "originalRequest": { "url": { "path": [ "hub", "brand", ":idhubbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 3593,\n \"IDBrandTo\": 3650,\n \"IDBrandFrom\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5349fe3e-5d8f-4f1b-8eb4-5beecf7994ac", "name": "Remove mapeamento — Hub Marcas", "request": { "name": "Remove mapeamento — Hub Marcas", "description": { "content": "Apaga o mapeamento.", "type": "text/plain" }, "url": { "path": [ "hub", "brand", ":idhubbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "576e0746-f54b-4550-b89c-7adb032e3ffc", "name": "Lista atualizada após remoção.", "originalRequest": { "url": { "path": [ "hub", "brand", ":idhubbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubMarcas\": 3717,\n \"IDCompanyIntegration\": 4014,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 4580,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 7364,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubMarcas\": 6607,\n \"IDCompanyIntegration\": 9468,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 928,\n \"IDBrandFrom\": \"string\",\n \"IDBrandTo\": 5299,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22530bac-5556-4088-8fac-1f62dce618de", "name": "Mensagens `[BadRequest]`:\n- `IDHubBrand não existe`", "originalRequest": { "url": { "path": [ "hub", "brand", ":idhubbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37948662-1c52-4612-afd1-fd5fdd3c479c", "name": "Reprocessa mapeamento (sincroniza com o canal)", "request": { "name": "Reprocessa mapeamento (sincroniza com o canal)", "description": { "content": "Envia os dados da marca cadastrada no hub para o canal de venda, criando ou atualizando lá a marca correspondente. Disponível apenas quando o tipo de integração da marca tem um recurso de marca cadastrado; caso contrário a chamada falha com a mensagem de recurso indisponível. A resposta devolve o retorno do próprio canal, sem formato fixo.", "type": "text/plain" }, "url": { "path": [ "hub", "brand", ":idhubbrand", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "428c6075-3ab6-4353-aa32-a67510fd3aa3", "name": "Sincronização concluída; corpo repassado pelo canal.", "originalRequest": { "url": { "path": [ "hub", "brand", ":idhubbrand", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c008fce7-c735-4346-9950-17392920150c", "name": "Mensagens `[BadRequest]`:\n- `Integração não tem recurso`", "originalRequest": { "url": { "path": [ "hub", "brand", ":idhubbrand", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0d9c8b6-1e92-4348-8156-de5cde4dfb5d", "name": "Falha repassada pelo canal de venda — o corpo traz a mensagem de erro devolvida pelo canal, sem prefixo padrão.", "originalRequest": { "url": { "path": [ "hub", "brand", ":idhubbrand", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubbrand", "description": "(Required) Identificador da marca no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d99c471a-bd8b-481d-a487-3aadc8ca7029", "name": "Hub — Notificações", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ecb4e082-1edd-4265-bbc8-9d8a81c543d2", "name": "Lista notificações de integração", "request": { "name": "Lista notificações de integração", "description": { "content": "Retorna o feed de problemas de integração detectados (pedidos com falha de importação, SKUs com erro de sincronização, etc.), com paginação fixa de 5.000 registros por página. Só lista tipos com `Show=1` (problemas que devem aparecer para o operador). Ordem por `IDHubNotification` crescente.", "type": "text/plain" }, "url": { "path": [ "hub", "notification" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "0", "description": "Página solicitada (0-indexada). Cada página tem 5.000 registros — o offset aplicado é `Page * 5000`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "375973c3-39dd-4f95-b717-9f019d72525e", "name": "Array de notificações.", "originalRequest": { "url": { "path": [ "hub", "notification" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubNotification\": 5449,\n \"RecordTimestamp\": \"1950-02-15T16:09:44.942Z\",\n \"IDTypeHubIntegrationProblem\": 2830,\n \"EmailStatus\": 5525,\n \"ID\": 3135,\n \"Message\": \"string\",\n \"IDCompany\": 3834,\n \"AccountName\": \"string\",\n \"TypeHubIntegrationProblem\": \"string\",\n \"Component\": \"string\",\n \"TypeHubIntegrationProblemCategory\": \"string\",\n \"Params\": \"string\"\n },\n {\n \"IDHubNotification\": 3494,\n \"RecordTimestamp\": \"1995-03-12T10:22:23.195Z\",\n \"IDTypeHubIntegrationProblem\": 9358,\n \"EmailStatus\": 8468,\n \"ID\": 5872,\n \"Message\": \"string\",\n \"IDCompany\": 8677,\n \"AccountName\": \"string\",\n \"TypeHubIntegrationProblem\": \"string\",\n \"Component\": \"string\",\n \"TypeHubIntegrationProblemCategory\": \"string\",\n \"Params\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d70ca6f8-3aa2-420d-82a1-9b3c38947a86", "name": "Marca notificação como resolvida (remove do feed)", "request": { "name": "Marca notificação como resolvida (remove do feed)", "description": { "content": "Apaga a notificação do feed da empresa. O sistema valida que a notificação pertence à empresa autenticada via `AccountName`.", "type": "text/plain" }, "url": { "path": [ "hub", "notification", ":idhubnotification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubnotification", "description": "(Required) Identificador da notificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "57546227-2b70-48ee-86a0-9802c855995d", "name": "Texto literal `sucesso` quando a remoção é concluída (também devolvido quando o id não existe — o `DELETE` é idempotente).", "originalRequest": { "url": { "path": [ "hub", "notification", ":idhubnotification" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubnotification", "description": "(Required) Identificador da notificação." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b47c9e8f-a0e8-49a6-bdae-e476a28e6493", "name": "Hub — Pagamento", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "070abb4c-0943-41ec-8f70-f5f4fed75a3a", "name": "Lista mapeamentos — Hub Pagamento", "request": { "name": "Lista mapeamentos — Hub Pagamento", "description": { "content": "Lista os mapeamentos da empresa autenticada. Sem paginação.", "type": "text/plain" }, "url": { "path": [ "hub", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra pelo identificador da integração da empresa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f848f2f0-dc75-4f55-b226-772e95a101c8", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "payment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubPagamento\": 7404,\n \"IDCompanyIntegration\": 6389,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 3997,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 9617,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubPagamento\": 9999,\n \"IDCompanyIntegration\": 6206,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 9265,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 3772,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53bda2d7-1ac3-48d9-9152-bdd0c792f451", "name": "Cria mapeamento — Hub Pagamento", "request": { "name": "Cria mapeamento — Hub Pagamento", "description": { "content": "Cria um novo mapeamento. Retorna a lista completa atualizada (re-invoca o List).", "type": "text/plain" }, "url": { "path": [ "hub", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6061,\n \"IDPaymentTo\": 189,\n \"IDPaymentFrom\": \"string\",\n \"Antifraud\": 4602\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "04228414-8ddc-4155-aa20-c84d09ec6216", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6061,\n \"IDPaymentTo\": 189,\n \"IDPaymentFrom\": \"string\",\n \"Antifraud\": 4602\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubPagamento\": 7404,\n \"IDCompanyIntegration\": 6389,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 3997,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 9617,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubPagamento\": 9999,\n \"IDCompanyIntegration\": 6206,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 9265,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 3772,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7407d6a0-6ded-44a7-b93c-6ad2f96941da", "name": "Mensagens `[BadRequest]`:\n- `De/para pagamento já existe`\n- `Pagamento não cadastrado`\n- `Integração não cadastrada`", "originalRequest": { "url": { "path": [ "hub", "payment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6061,\n \"IDPaymentTo\": 189,\n \"IDPaymentFrom\": \"string\",\n \"Antifraud\": 4602\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0cef442e-dcc6-4ff2-8155-59c694e344d1", "name": "Edita mapeamento — Hub Pagamento", "request": { "name": "Edita mapeamento — Hub Pagamento", "description": { "content": "Edita o mapeamento. Retorna a lista atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "payment", ":idhubpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubpayment", "description": "(Required) Identificador da forma de pagamento no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6061,\n \"IDPaymentTo\": 189,\n \"IDPaymentFrom\": \"string\",\n \"Antifraud\": 4602\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "febaaca9-b30f-43ca-8436-40b4b1c75ade", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "payment", ":idhubpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubpayment", "description": "(Required) Identificador da forma de pagamento no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6061,\n \"IDPaymentTo\": 189,\n \"IDPaymentFrom\": \"string\",\n \"Antifraud\": 4602\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubPagamento\": 7404,\n \"IDCompanyIntegration\": 6389,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 3997,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 9617,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubPagamento\": 9999,\n \"IDCompanyIntegration\": 6206,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 9265,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 3772,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99a13788-3a3d-4d52-9279-90832dd9d72f", "name": "Mensagens `[BadRequest]`:\n- `De/para pagamento já existe`\n- `Pagamento não cadastrada`\n- `Integração não cadastrada`\n- `Pagamento Hub não existe`", "originalRequest": { "url": { "path": [ "hub", "payment", ":idhubpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubpayment", "description": "(Required) Identificador da forma de pagamento no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 6061,\n \"IDPaymentTo\": 189,\n \"IDPaymentFrom\": \"string\",\n \"Antifraud\": 4602\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "798b4a39-a5ba-4b4e-83ed-036c8704f4df", "name": "Remove mapeamento — Hub Pagamento", "request": { "name": "Remove mapeamento — Hub Pagamento", "description": { "content": "Apaga o mapeamento.", "type": "text/plain" }, "url": { "path": [ "hub", "payment", ":idhubpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubpayment", "description": "(Required) Identificador da forma de pagamento no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "124eaa0a-80cb-47dc-8db6-b704c2dc06b3", "name": "Lista atualizada após remoção.", "originalRequest": { "url": { "path": [ "hub", "payment", ":idhubpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubpayment", "description": "(Required) Identificador da forma de pagamento no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubPagamento\": 7404,\n \"IDCompanyIntegration\": 6389,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 3997,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 9617,\n \"AccountName\": \"string\"\n },\n {\n \"IDHubPagamento\": 9999,\n \"IDCompanyIntegration\": 6206,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 9265,\n \"IDPaymentFrom\": \"string\",\n \"IDPaymentTo\": 3772,\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8deaa0e9-5c75-4b9c-90c4-f7bb43c07151", "name": "Mensagens `[BadRequest]`:\n- `Pagamento Hub não existe`", "originalRequest": { "url": { "path": [ "hub", "payment", ":idhubpayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubpayment", "description": "(Required) Identificador da forma de pagamento no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4556ae5c-05dd-4605-8c37-8c05f9d13604", "name": "Hub — Pedidos", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c061020d-d2cc-456e-9a87-c5aadeff15c9", "name": "Lista reclamações abertas pelos compradores", "request": { "name": "Lista reclamações abertas pelos compradores", "description": { "content": "Lista as reclamações sincronizadas dos canais, da mais recente para a mais antiga, em páginas de até 2000 registros. Cada linha traz estágio, tipo, motivo e motivo de resolução vindos do canal — as listas auxiliares estão em `/type/hub/order/claim/{reason,stage,type,resolution-reason}`. Os pares de data `DateFrom`/`DateTo` e `DueDateFrom`/`DueDateTo` só filtram quando os dois extremos são enviados; sozinho, cada um é ignorado. O código `ClaimAffectsReputation` NÃO é booleano: `1` = NÃO afeta, `2` = AFETA, `3` = não se aplica, `0` = o canal respondeu sem informar e `null` = a consulta de reputação ao canal falhou. Prefira `ClaimAffectsReputationDescription`, que já vem com o texto resolvido — `Não afeta reputação`, `Afeta reputação` ou `Não se aplica` — e vem `null` nos dois estados indeterminados (`0` e `null`); ler o código como verdadeiro/falso inverte o resultado.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "claim" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "0", "description": "Página da listagem, começando em `0`. Cada página traz até 2000 reclamações." }, { "disabled": false, "key": "ClaimStatus", "value": "1", "description": "Situação da reclamação: `0` aberta, `1` fechada." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Restringe a uma integração (instância de canal) específica da empresa." }, { "disabled": false, "key": "IDOrder", "value": "1603", "description": "Identificador do pedido idworks vinculado à reclamação." }, { "disabled": false, "key": "OrderFrom", "value": "string", "description": "Código do pedido no canal. Correspondência exata, não parcial." }, { "disabled": false, "key": "IDHubOrderClaimExternal", "value": "string", "description": "Número da reclamação no canal. Correspondência exata." }, { "disabled": false, "key": "ActionResponsible", "value": "0", "description": "De quem o canal cobra a próxima ação: `0` comprador, `1` vendedor, `3` mediador." }, { "disabled": false, "key": "IDTypeHubOrderClaimType", "value": "8", "description": "Tipo da reclamação: `1` Reclamação, `2` Devolução, `3` Reclamação Full, `4` Cancelamento por demora no envio, `5` Cancelamento pelo vendedor, `6` Cancelamento pelo comprador, `7` Mudança de produto, `8` Cancelamento de serviço." }, { "disabled": false, "key": "IDTypeHubOrderClaimStage", "value": "3", "description": "Estágio da reclamação: `1` Reclamação, `2` Disputa, `3` Recontato, `4` NA, `5` Obsoleto." }, { "disabled": false, "key": "IDTypeHubOrderClaimReason", "value": "1603", "description": "Motivo informado pelo comprador. Os valores válidos vêm de `/type/hub/order/claim/reason` — a lista é extensa e cresce conforme o canal envia motivos novos, por isso não há conjunto fixo." }, { "disabled": false, "key": "IDTypeHubOrderClaimResolutionReason", "value": "15", "description": "Motivo do encerramento da reclamação. Descrições em `/type/hub/order/claim/resolution-reason`." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial de abertura da reclamação (inclusive). Só tem efeito quando `DateTo` também é enviado." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final de abertura da reclamação. O dia informado entra inteiro, até 23:59:59. Só tem efeito quando `DateFrom` também é enviado." }, { "disabled": false, "key": "DueDateFrom", "value": "1980-02-08", "description": "Data inicial do prazo de resposta da reclamação (inclusive). Só tem efeito quando `DueDateTo` também é enviado." }, { "disabled": false, "key": "DueDateTo", "value": "1980-02-08", "description": "Data final do prazo de resposta. O dia informado entra inteiro, até 23:59:59. Só tem efeito quando `DueDateFrom` também é enviado." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "94cbcc12-7869-46bb-913d-ac4aaddd6b48", "name": "Array plano de reclamações, da mais recente para a mais antiga — não há envelope de paginação nem total de registros. Só entram na lista as reclamações cujo tipo, motivo e estágio já estão cadastrados para aquele tipo de canal; o motivo de resolução é opcional.", "originalRequest": { "url": { "path": [ "hub", "order", "claim" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "0" }, { "key": "ClaimStatus", "value": "1" }, { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDOrder", "value": "1603" }, { "key": "OrderFrom", "value": "string" }, { "key": "IDHubOrderClaimExternal", "value": "string" }, { "key": "ActionResponsible", "value": "0" }, { "key": "IDTypeHubOrderClaimType", "value": "8" }, { "key": "IDTypeHubOrderClaimStage", "value": "3" }, { "key": "IDTypeHubOrderClaimReason", "value": "1603" }, { "key": "IDTypeHubOrderClaimResolutionReason", "value": "15" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "DueDateFrom", "value": "1980-02-08" }, { "key": "DueDateTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfc2d07c-b71f-4ed9-adc5-6903c2c3b8bf", "name": "Detalhe da reclamação (chat + ações disponíveis)", "request": { "name": "Detalhe da reclamação (chat + ações disponíveis)", "description": { "content": "Detalhe completo da reclamação: mensagens trocadas em `ClaimsMessages`, anexos, itens do pedido em `SKUs`, dados do comprador e as ações que o canal permite no estágio atual, em `AvailableActions`. Cada ação traz o código a enviar em `Type` no endpoint de ação, se é obrigatória e, conforme o caso, as ofertas de reembolso parcial, os motivos de reprovação de devolução ou os campos exigidos para registrar a evidência de envio. Quando `ClaimStatus` é `1` (fechada) `AvailableActions` vem vazio, e o preenchimento só ocorre em reclamações do Mercado Livre. Diferente do detalhe do pedido, aqui a reclamação não vem aninhada: os campos da reclamação, `AvailableActions`, `AutopartsProductDetail` e `IDHubProductAutoparts` ficam na raiz do objeto. Ao final de `ClaimsMessages` o sistema acrescenta uma mensagem sintética de abertura — `Sender` `2`, texto `Reclamação aberta n.º `, com sufixo ` | Não afeta reputação`, ` | Afeta reputação` ou ` | Reputação não se aplica` quando o canal informou — que não existe no canal e não tem identificador próprio. O código `ClaimAffectsReputation` NÃO é booleano: `1` = NÃO afeta, `2` = AFETA, `3` = não se aplica, `0` = o canal respondeu sem informar e `null` = a consulta de reputação ao canal falhou — ler como verdadeiro/falso inverte o resultado. A resposta é um array: reclamação inexistente ou de outra empresa devolve `200` com array vazio.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "908b514b-19ff-49f2-8fee-0e2960a44658", "name": "Detalhe da reclamação. A resposta é um array com no máximo um objeto; reclamação inexistente ou de outra empresa devolve `[]`. Esta resposta traz o código `ClaimAffectsReputation` sem o texto resolvido — o campo `ClaimAffectsReputationDescription` existe apenas na listagem `GET /hub/order/claim`.", "originalRequest": { "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubOrderClaim\": 126,\n \"IDHubOrderClaimExternal\": \"string\",\n \"ClaimStatus\": 8261,\n \"ClaimCreationDate\": \"2017-01-30T12:48:59.906Z\",\n \"IDTypeHubOrderClaimType\": 6,\n \"TypeHubOrderClaimTypeName\": \"string\",\n \"IDTypeHubOrderClaimStage\": 4,\n \"TypeHubOrderClaimStageName\": \"string\",\n \"IDTypeHubOrderClaimReason\": 5646,\n \"TypeHubOrderClaimReason\": \"string\",\n \"IDTypeHubOrderClaimResolutionReason\": 3779,\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\",\n \"ClaimTimestampLastUpdated\": \"2014-09-21T20:12:57.184Z\",\n \"ClaimResolutionDate\": \"2022-07-21T02:22:14.706Z\",\n \"IDProductHub\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 59,\n \"DueDate\": \"1976-03-13T20:21:24.694Z\",\n \"ActionResponsible\": \"string\",\n \"ClaimTitle\": \"string\",\n \"ClaimDescription\": \"string\",\n \"ClaimProblem\": \"string\",\n \"AvailableActions\": [\n {\n \"Mandatory\": 2776,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 8072.511721558704,\n \"Percentage\": 3819.2836601009803\n },\n {\n \"Amount\": 4731.299726725749,\n \"Percentage\": 7406.151759021446\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 7905\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 8246\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 7711\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 8825\n }\n ]\n }\n ]\n },\n {\n \"Mandatory\": 9746,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 6067.9296573610045,\n \"Percentage\": 3992.1009141996456\n },\n {\n \"Amount\": 6304.08674876225,\n \"Percentage\": 2173.9258604332567\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 8028\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 2508\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6750\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6187\n }\n ]\n }\n ]\n }\n ],\n \"ClaimAffectsReputation\": 1,\n \"IDIntegration\": 5191,\n \"OrderId\": \"string\",\n \"IDOrder\": 7362,\n \"Order\": \"string\",\n \"Status\": \"string\",\n \"CreationTimestamp\": \"1978-05-11T17:33:13.037Z\",\n \"RecordTimestamp\": \"2010-01-25T15:02:59.699Z\",\n \"ConsumerFirstName\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerDocument\": \"string\",\n \"IDConsumer\": 2314,\n \"ShippingId\": \"string\",\n \"ShippingCourierId\": \"string\",\n \"ShippingEstimateDate\": \"1966-09-25T07:18:36.500Z\",\n \"ShippingEstimateHandlingLimitDate\": \"1957-04-22T19:13:38.294Z\",\n \"AccountName\": \"string\",\n \"IDCompanyIntegration\": 5387,\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 531,\n \"IDSalesChannel\": 5789,\n \"SalesChannelLogoUrl\": \"string\",\n \"SalesChannelOrderLink\": \"string\",\n \"IDOrderReturn\": 7482,\n \"ActionResponsibleDescription\": \"string\",\n \"ClaimsMessages\": [\n {\n \"IDHubOrderClaimMessage\": 7744,\n \"IDHubOrderClaim\": 5332,\n \"Sender\": 4399,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"1948-05-27T19:31:46.520Z\",\n \"ReadTimestamp\": \"2001-12-01T06:48:12.704Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDHubOrderClaimMessage\": 2851,\n \"IDHubOrderClaim\": 7942,\n \"Sender\": 4337,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"2014-02-19T17:02:10.598Z\",\n \"ReadTimestamp\": \"1950-02-06T13:14:43.105Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"SKUs\": [\n {\n \"IDSku\": 4918,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 489.3653283503707,\n \"PriceSelling\": 3050.069612115729,\n \"ValueDiscount\": 5037.0604866943295,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9145,\n \"MainImageURL\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 6294\n },\n {\n \"IDSku\": 3015,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 5138.773235258443,\n \"PriceSelling\": 9904.20007090406,\n \"ValueDiscount\": 1369.6837871711255,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 4637,\n \"MainImageURL\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 5594\n }\n ]\n },\n {\n \"IDHubOrderClaim\": 4238,\n \"IDHubOrderClaimExternal\": \"string\",\n \"ClaimStatus\": 78,\n \"ClaimCreationDate\": \"1985-05-22T10:59:52.070Z\",\n \"IDTypeHubOrderClaimType\": 6,\n \"TypeHubOrderClaimTypeName\": \"string\",\n \"IDTypeHubOrderClaimStage\": 2,\n \"TypeHubOrderClaimStageName\": \"string\",\n \"IDTypeHubOrderClaimReason\": 8059,\n \"TypeHubOrderClaimReason\": \"string\",\n \"IDTypeHubOrderClaimResolutionReason\": 5456,\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\",\n \"ClaimTimestampLastUpdated\": \"1976-09-19T16:24:05.190Z\",\n \"ClaimResolutionDate\": \"1969-09-09T20:18:12.737Z\",\n \"IDProductHub\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 7008,\n \"DueDate\": \"1998-09-10T16:08:15.132Z\",\n \"ActionResponsible\": \"string\",\n \"ClaimTitle\": \"string\",\n \"ClaimDescription\": \"string\",\n \"ClaimProblem\": \"string\",\n \"AvailableActions\": [\n {\n \"Mandatory\": 8753,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 3132.432083709136,\n \"Percentage\": 3261.3696407759685\n },\n {\n \"Amount\": 4886.023267282229,\n \"Percentage\": 9412.606544189846\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9662\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 450\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9573\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6466\n }\n ]\n }\n ]\n },\n {\n \"Mandatory\": 7122,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 5754.107455729793,\n \"Percentage\": 8864.465872989036\n },\n {\n \"Amount\": 7812.696224895546,\n \"Percentage\": 851.7245508092186\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9056\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 8617\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 7029\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 7752\n }\n ]\n }\n ]\n }\n ],\n \"ClaimAffectsReputation\": 2,\n \"IDIntegration\": 9540,\n \"OrderId\": \"string\",\n \"IDOrder\": 2493,\n \"Order\": \"string\",\n \"Status\": \"string\",\n \"CreationTimestamp\": \"1953-08-17T05:01:54.694Z\",\n \"RecordTimestamp\": \"1965-12-11T02:46:46.041Z\",\n \"ConsumerFirstName\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerDocument\": \"string\",\n \"IDConsumer\": 1901,\n \"ShippingId\": \"string\",\n \"ShippingCourierId\": \"string\",\n \"ShippingEstimateDate\": \"2008-03-21T02:28:58.613Z\",\n \"ShippingEstimateHandlingLimitDate\": \"1948-09-29T10:47:17.702Z\",\n \"AccountName\": \"string\",\n \"IDCompanyIntegration\": 9595,\n \"CompanyIntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1157,\n \"IDSalesChannel\": 7396,\n \"SalesChannelLogoUrl\": \"string\",\n \"SalesChannelOrderLink\": \"string\",\n \"IDOrderReturn\": 9699,\n \"ActionResponsibleDescription\": \"string\",\n \"ClaimsMessages\": [\n {\n \"IDHubOrderClaimMessage\": 5852,\n \"IDHubOrderClaim\": 4856,\n \"Sender\": 2906,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"1990-07-15T20:30:05.316Z\",\n \"ReadTimestamp\": \"2026-04-27T01:48:25.976Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDHubOrderClaimMessage\": 4895,\n \"IDHubOrderClaim\": 5289,\n \"Sender\": 6152,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"1949-11-22T17:19:39.477Z\",\n \"ReadTimestamp\": \"1979-08-17T17:43:51.543Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"SKUs\": [\n {\n \"IDSku\": 8758,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 2993.626745619824,\n \"PriceSelling\": 3486.3287705366506,\n \"ValueDiscount\": 7669.599700871765,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 1294,\n \"MainImageURL\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 5964\n },\n {\n \"IDSku\": 590,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 3202.6432210817225,\n \"PriceSelling\": 9301.497659716593,\n \"ValueDiscount\": 6470.8877911888685,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 9097,\n \"MainImageURL\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 2412\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b1f88d8-5089-437e-b394-b4f5eb323c8d", "name": "Executa uma ação na reclamação", "request": { "name": "Executa uma ação na reclamação", "description": { "content": "Executa uma das ações listadas em `AvailableActions` pelo detalhe da reclamação. O código da ação vai em `Type` na query e o corpo muda conforme a ação. Para anexar arquivos, envie antes cada um no endpoint de anexo da reclamação e repasse em `Attachments` os `FileUUID` recebidos. `Type=AvailableActions` não executa nada: apenas consulta no canal a lista de ações disponíveis no momento e a devolve. Omitir `Type` equivale a enviar um código inválido e a chamada é recusada. Disponível apenas para reclamações do Mercado Livre. Nas demais ações, ao final devolve a linha de staging já atualizada com o novo estado da reclamação.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim", "action" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "send_message_to_mediator", "description": "(Required) Código da ação a executar (ver `AvailableActions[].Type` no detalhe da reclamação). `AvailableActions` não executa nada: apenas consulta a lista de ações disponíveis no momento." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Text\": \"string\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ],\n \"Percentage\": 4480.9817938104125,\n \"Reason\": \"string\",\n \"EstimatedShippingDate\": \"string\",\n \"ShippingMethod\": \"mail\",\n \"ShippingDate\": \"1988-09-23\",\n \"SupplierNameCorporateName\": \"string\",\n \"DestinationAgency\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingReceiverDocument\": \"string\",\n \"ShippingReceiverEmail\": \"string\",\n \"ShippingId\": \"string\",\n \"DeliveredDate\": \"1988-09-21\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "630e95e8-5ba6-4cb3-9556-fbdaf7c7b084", "name": "Com `Type` diferente de `AvailableActions`: o pedido recarregado no mesmo formato de `GET /hub/order/{idintegration}` — um array de `HubOrderDetailItem` já com a reclamação atualizada.\n\nCom `Type=AvailableActions`: um array de objetos `{ Mandatory, IDTypeHubOrderClaimActionExternalId, TypeHubOrderClaimActionDescription }`, sem os campos extras (`PartialRefundOffers`, `ReturnFailReasons`, `OptionsList`).", "originalRequest": { "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim", "action" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "send_message_to_mediator" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Text\": \"string\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ],\n \"Percentage\": 1780.2484177557321,\n \"Reason\": \"string\",\n \"EstimatedShippingDate\": \"string\",\n \"ShippingMethod\": \"personal_delivery\",\n \"ShippingDate\": \"2015-08-19\",\n \"SupplierNameCorporateName\": \"string\",\n \"DestinationAgency\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingReceiverDocument\": \"string\",\n \"ShippingReceiverEmail\": \"string\",\n \"ShippingId\": \"string\",\n \"DeliveredDate\": \"1961-01-14\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0e52190-5622-4048-b261-9763d8ad59a1", "name": "Mensagens (prefixo `[BadRequest]`):\n- `Pedido não encontrado no hub` — reclamação inexistente ou de outra empresa.\n- `Integração não tem envio de mensagem` — a integração informada não é de canal de vendas (por exemplo, integrações de transportadora ou de adquirente).\n- `Integração não tem consulta de status` — o canal de vendas existe, mas não trata reclamações; hoje apenas o Mercado Livre trata.\n\nRecusas do canal, repassadas com o mesmo prefixo:\n- `Recurso de reclamação não existe` — `Type` omitido ou sem correspondência com nenhuma ação suportada.\n- `Necessário enviar a mensagem, campo 'Text'` — em `send_message_to_complainant`, `send_message_to_mediator`, `send_message_to_respondent` e `send_attachments`.\n- `Necessário enviar o campo 'Text' e 'Reason'` — em `return_review_fail`.\n- `Necessário enviar a mensagem, campo 'Percentage'` — em `allow_partial_refund`.\n- `Necessário enviar a mensagem, campo 'EstimatedShippingDate'` — em `send_potential_shipping`.\n- `Necessário enviar o campo 'EstimatedShippingDate'` — em `add_shipping_evidence` e `send_tracking_number`.", "originalRequest": { "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim", "action" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "send_message_to_mediator" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Text\": \"string\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ],\n \"Percentage\": 1780.2484177557321,\n \"Reason\": \"string\",\n \"EstimatedShippingDate\": \"string\",\n \"ShippingMethod\": \"personal_delivery\",\n \"ShippingDate\": \"2015-08-19\",\n \"SupplierNameCorporateName\": \"string\",\n \"DestinationAgency\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"ShippingReceiverDocument\": \"string\",\n \"ShippingReceiverEmail\": \"string\",\n \"ShippingId\": \"string\",\n \"DeliveredDate\": \"1961-01-14\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53a685a4-1060-43e6-a9be-617c6c9ddb85", "name": "Faz upload de arquivo para anexar a uma ação", "request": { "name": "Faz upload de arquivo para anexar a uma ação", "description": { "content": "Sobe um arquivo (foto, PDF, vídeo curto) e devolve um `FileUUID` para usar em uma ação subsequente (`return_review_fail`, `send_attachments`, etc.). Quando o motivo da recusa é SRF2/SRF4 (return_review_fail), o anexo é obrigatório — sistema aceita query `?Return=1`.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim", "action", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Return", "value": "1", "description": "Quando `1`, restringe a registros de devolução." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "Arquivo anexado à ação da reclamação (imagem ou documento), enviado como multipart." } ] } }, "response": [ { "id": "f5380060-70fe-4715-aea2-692851e7a057", "name": "Retorna `FileUUID` para o anexo.", "originalRequest": { "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim", "action", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Return", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo anexado à ação da reclamação (imagem ou documento), enviado como multipart.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c8ff896-ab7f-46c9-87f7-8277a680e1e9", "name": "Falha ao enviar o anexo. Mensagens conhecidas:\n- `[BadRequest] - Arquivo não enviado` — a requisição chegou sem arquivo.\n- `[BadRequest] - Arquivo inválido`\n- `[BadRequest] - Erro ao salvar arquivo`\n- `[BadRequest] - erro ao enviar arquivo para mercado livre. Verificar extensão e tamanho do arquivo`\n- `[BadRequest] - Integração não tem recurso de enviar anexo` — o canal de venda não aceita anexo em mensagem.\n- `[BadRequest] - Pedido integração não localizada`\n- `[BadRequest] - Access_token não encontrado` — a integração não está autenticada.\n\nO texto vem em `errorMessage`.", "originalRequest": { "url": { "path": [ "hub", "order", "claim", ":idhuborderclaim", "action", "file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Return", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhuborderclaim", "description": "(Required) Identificador da reclamação de pedido no hub." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo anexado à ação da reclamação (imagem ou documento), enviado como multipart.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13e91b5e-7b19-417b-a72e-fad87fd9345f", "name": "Detalhe de uma linha de staging", "request": { "name": "Detalhe de uma linha de staging", "description": { "content": "Detalhe completo da linha de staging: campos do canal, itens, pagamentos, mensagens do comprador e reclamações. A resposta é um array — linha inexistente ou de outra empresa devolve `200` com array vazio. A consulta também sincroniza a marcação de leitura das mensagens recebidas do comprador que ainda constavam como não lidas. Em cada item de `Claims`, o código `ClaimAffectsReputation` NÃO é booleano: `1` = NÃO afeta, `2` = AFETA, `3` = não se aplica, `0` = o canal respondeu sem informar e `null` = a consulta de reputação ao canal falhou — ler como verdadeiro/falso inverte o resultado.", "type": "text/plain" }, "url": { "path": [ "hub", "order", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "84659cfb-b52f-42c1-8173-4e49e7f8304d", "name": "Detalhe do pedido, sempre como array de um elemento. Pedido inexistente ou de outra empresa devolve `200` com array vazio.\n\nO detalhe acrescenta `IDConsumer`, `SalesChannelLogoUrl`, `Messages`, `Claims`, `ClaimsMessages` e `Index`, e não devolve os campos exclusivos da listagem (`Origin`, `IDStatusOrder`, `StatusOrder`, `StatusColorCode`, `IDStatusInvoice`, `StatusInvoice`). Os itens em `SKUs` trazem `Comments` e `MainImageURL` e não trazem `ProductDetail`. `SalesChannelOrderLink` é montado para Mercado Livre, SkyHub e Olist; para Vtex ele só aparece na listagem `GET /orders/hub`.\n\nO campo `ClaimAffectsReputation` das reclamações NÃO é booleano: `1` = NÃO afeta a reputação, `2` = AFETA, `3` = não se aplica, `0` = o canal respondeu sem informar o campo e `null` = a consulta ao canal falhou — lê-lo como verdadeiro/falso inverte o resultado.", "originalRequest": { "url": { "path": [ "hub", "order", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDIntegration\": 2366,\n \"AccountName\": \"string\",\n \"IDCompanyIntegration\": 5433,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 5854,\n \"IDSalesChannel\": 3320,\n \"OrderId\": \"string\",\n \"PackId\": \"string\",\n \"IDOrder\": 3081,\n \"Order\": \"string\",\n \"Status\": \"string\",\n \"HubOrderStatus\": \"string\",\n \"CreateOrder\": null,\n \"CreateOrderDescription\": \"Sim\",\n \"CreationTimestamp\": \"2008-03-14T07:07:41.490Z\",\n \"RecordTimestamp\": \"1976-06-29T11:47:47.777Z\",\n \"ConsumerFirstName\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerDocument\": \"string\",\n \"QuantityItems\": 7565.57226607302,\n \"QuantityPayments\": 7057,\n \"TotalItemsValue\": 7996.718045511609,\n \"TotalDiscountValue\": 4034.058355364181,\n \"TotalShippingValue\": 4641.303326766688,\n \"TotalInterestValue\": 3507.2143647960784,\n \"TotalOrderValue\": 8157.1336097642825,\n \"IDWarehouseHub\": \"string\",\n \"ShippingId\": \"string\",\n \"ShippingCourierId\": \"string\",\n \"ShippingEstimateDate\": \"1984-06-03\",\n \"ShippingEstimateHandlingLimitDate\": \"1952-04-29T22:20:11.118Z\",\n \"Coupon\": \"string\",\n \"UtmCampaign\": \"string\",\n \"UtmMedium\": \"string\",\n \"UtmSource\": \"string\",\n \"UtmiCampaign\": \"string\",\n \"UtmiPage\": \"string\",\n \"UtmiPart\": \"string\",\n \"SalesChannelOrderLink\": \"http://rnVPrSqEHZURwAOdc.pwhS3nKuy-Na7YigGnIySTE-KzcCPMQXmln5US4h2BHld-jIBi4ENTjK\",\n \"Payments\": [\n {\n \"Acquirer\": \"string\",\n \"Connector\": \"string\",\n \"Installments\": 1593,\n \"PaymentSystem\": \"string\",\n \"PaymentSystemName\": \"string\",\n \"TransactionIdentifier\": \"string\",\n \"InterestValue\": 6126.621383804149,\n \"Value\": 2235.6181678546404\n },\n {\n \"Acquirer\": \"string\",\n \"Connector\": \"string\",\n \"Installments\": 6846,\n \"PaymentSystem\": \"string\",\n \"PaymentSystemName\": \"string\",\n \"TransactionIdentifier\": \"string\",\n \"InterestValue\": 6105.633680273463,\n \"Value\": 8632.452205008347\n }\n ],\n \"IDConsumer\": 650,\n \"SalesChannelLogoUrl\": \"https://wUdSdVrKzdsmoYhOfBPalg.xzqjEdNV2DrQ\",\n \"SKUs\": [\n {\n \"IDSku\": 7900,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 6689.439076463069,\n \"PriceSelling\": 6535.282197197994,\n \"ValueDiscount\": 712.3341849071841,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 7757,\n \"IDIntegrationProducts\": \"string\",\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\"\n },\n {\n \"IDSku\": 8872,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 2985.904804310473,\n \"PriceSelling\": 7731.087808342787,\n \"ValueDiscount\": 76.96092208205884,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 3493,\n \"IDIntegrationProducts\": \"string\",\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\"\n }\n ],\n \"Messages\": [\n {\n \"IDHubOrderMessage\": 1498,\n \"IDHubOrderMessageExternal\": \"string\",\n \"IDIntegration\": 5989,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"1970-10-05T21:55:53.972Z\",\n \"ReadTimestamp\": \"2019-09-01T20:47:40.424Z\",\n \"Seller\": 9613,\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDHubOrderMessage\": 8384,\n \"IDHubOrderMessageExternal\": \"string\",\n \"IDIntegration\": 8167,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"2004-12-08T20:00:02.556Z\",\n \"ReadTimestamp\": \"1973-11-23T20:11:22.496Z\",\n \"Seller\": 2287,\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Claims\": [\n {\n \"IDHubOrderClaim\": 4786,\n \"IDHubOrderClaimExternal\": \"string\",\n \"ClaimStatus\": 5712,\n \"ClaimCreationDate\": \"1952-02-26T18:04:00.634Z\",\n \"IDTypeHubOrderClaimType\": 1,\n \"TypeHubOrderClaimTypeName\": \"string\",\n \"IDTypeHubOrderClaimStage\": 2,\n \"TypeHubOrderClaimStageName\": \"string\",\n \"IDTypeHubOrderClaimReason\": 8163,\n \"TypeHubOrderClaimReason\": \"string\",\n \"IDTypeHubOrderClaimResolutionReason\": 7077,\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\",\n \"ClaimTimestampLastUpdated\": \"1984-06-08T01:50:10.415Z\",\n \"ClaimResolutionDate\": \"1964-09-22T15:49:27.597Z\",\n \"IDProductHub\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 4102,\n \"DueDate\": \"2004-04-01T03:13:01.619Z\",\n \"ActionResponsible\": \"string\",\n \"ClaimTitle\": \"string\",\n \"ClaimDescription\": \"string\",\n \"ClaimProblem\": \"string\",\n \"AvailableActions\": [\n {\n \"Mandatory\": 235,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 1402.8993457688998,\n \"Percentage\": 9276.907319966074\n },\n {\n \"Amount\": 4848.5236890253655,\n \"Percentage\": 5098.620836431242\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9448\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 1281\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 191\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 918\n }\n ]\n }\n ]\n },\n {\n \"Mandatory\": 3662,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 7265.0695679166665,\n \"Percentage\": 7467.111314552306\n },\n {\n \"Amount\": 1374.2531372101175,\n \"Percentage\": 8380.861209777282\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 251\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 4643\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6729\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 2148\n }\n ]\n }\n ]\n }\n ],\n \"ClaimAffectsReputation\": 0\n },\n {\n \"IDHubOrderClaim\": 3916,\n \"IDHubOrderClaimExternal\": \"string\",\n \"ClaimStatus\": 9032,\n \"ClaimCreationDate\": \"1957-08-12T18:24:50.959Z\",\n \"IDTypeHubOrderClaimType\": 3,\n \"TypeHubOrderClaimTypeName\": \"string\",\n \"IDTypeHubOrderClaimStage\": 2,\n \"TypeHubOrderClaimStageName\": \"string\",\n \"IDTypeHubOrderClaimReason\": 9024,\n \"TypeHubOrderClaimReason\": \"string\",\n \"IDTypeHubOrderClaimResolutionReason\": 2179,\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\",\n \"ClaimTimestampLastUpdated\": \"1972-05-18T15:19:22.518Z\",\n \"ClaimResolutionDate\": \"1974-01-26T23:12:55.517Z\",\n \"IDProductHub\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 3426,\n \"DueDate\": \"1981-02-03T06:25:49.784Z\",\n \"ActionResponsible\": \"string\",\n \"ClaimTitle\": \"string\",\n \"ClaimDescription\": \"string\",\n \"ClaimProblem\": \"string\",\n \"AvailableActions\": [\n {\n \"Mandatory\": 3147,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 5236.772488171657,\n \"Percentage\": 8334.082037856517\n },\n {\n \"Amount\": 9196.276899157256,\n \"Percentage\": 4350.103326083401\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 2527\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9786\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 8096\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6376\n }\n ]\n }\n ]\n },\n {\n \"Mandatory\": 390,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 7527.440063748396,\n \"Percentage\": 1793.4459565173788\n },\n {\n \"Amount\": 3104.3577840519674,\n \"Percentage\": 84.081884866265\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 2849\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 3855\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 4416\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 8248\n }\n ]\n }\n ]\n }\n ],\n \"ClaimAffectsReputation\": 2\n }\n ],\n \"ClaimsMessages\": [\n {\n \"IDHubOrderClaimMessage\": 8849,\n \"IDHubOrderClaim\": 2135,\n \"Sender\": 3204,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"2015-11-30T15:06:41.954Z\",\n \"ReadTimestamp\": \"1961-02-05T16:57:16.096Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDHubOrderClaimMessage\": 1298,\n \"IDHubOrderClaim\": 3012,\n \"Sender\": 5421,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"2019-11-23T23:27:04.617Z\",\n \"ReadTimestamp\": \"2003-01-12T05:10:10.606Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Index\": 9190\n },\n {\n \"IDIntegration\": 3101,\n \"AccountName\": \"string\",\n \"IDCompanyIntegration\": 4956,\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"CompanyIntegration\": \"string\",\n \"IDTypeCompanyIntegration\": 8940,\n \"IDSalesChannel\": 3565,\n \"OrderId\": \"string\",\n \"PackId\": \"string\",\n \"IDOrder\": 9264,\n \"Order\": \"string\",\n \"Status\": \"string\",\n \"HubOrderStatus\": \"string\",\n \"CreateOrder\": 0,\n \"CreateOrderDescription\": \"Sim\",\n \"CreationTimestamp\": \"2015-07-21T16:59:29.403Z\",\n \"RecordTimestamp\": \"1986-02-22T23:27:31.193Z\",\n \"ConsumerFirstName\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerDocument\": \"string\",\n \"QuantityItems\": 9374.601942080359,\n \"QuantityPayments\": 3980,\n \"TotalItemsValue\": 955.9330934217081,\n \"TotalDiscountValue\": 9920.601926239999,\n \"TotalShippingValue\": 3766.223004348246,\n \"TotalInterestValue\": 5517.684465945005,\n \"TotalOrderValue\": 9142.824259828514,\n \"IDWarehouseHub\": \"string\",\n \"ShippingId\": \"string\",\n \"ShippingCourierId\": \"string\",\n \"ShippingEstimateDate\": \"2018-07-16\",\n \"ShippingEstimateHandlingLimitDate\": \"1958-12-22T10:51:24.252Z\",\n \"Coupon\": \"string\",\n \"UtmCampaign\": \"string\",\n \"UtmMedium\": \"string\",\n \"UtmSource\": \"string\",\n \"UtmiCampaign\": \"string\",\n \"UtmiPage\": \"string\",\n \"UtmiPart\": \"string\",\n \"SalesChannelOrderLink\": \"http://XpD.ugycvIJqaj64DMhs,UHr8Iwegd03UsuvMXTMPxGwtsXPZEdfh\",\n \"Payments\": [\n {\n \"Acquirer\": \"string\",\n \"Connector\": \"string\",\n \"Installments\": 3743,\n \"PaymentSystem\": \"string\",\n \"PaymentSystemName\": \"string\",\n \"TransactionIdentifier\": \"string\",\n \"InterestValue\": 6557.96100606636,\n \"Value\": 8584.437445371363\n },\n {\n \"Acquirer\": \"string\",\n \"Connector\": \"string\",\n \"Installments\": 2119,\n \"PaymentSystem\": \"string\",\n \"PaymentSystemName\": \"string\",\n \"TransactionIdentifier\": \"string\",\n \"InterestValue\": 1523.4880675416562,\n \"Value\": 3811.3346939567896\n }\n ],\n \"IDConsumer\": 5713,\n \"SalesChannelLogoUrl\": \"https://EEeHuJ.hyFn2XYQCkA7mqeb.F2fdsl4wwr2oy3SEv27rrGKDaewVprCAvzs3vCdE2M5B1yFwK-oUUCfpF.\",\n \"SKUs\": [\n {\n \"IDSku\": 14,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 1169.8397758528345,\n \"PriceSelling\": 8903.566962450945,\n \"ValueDiscount\": 1830.6277418804373,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 585,\n \"IDIntegrationProducts\": \"string\",\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\"\n },\n {\n \"IDSku\": 1779,\n \"IDSkuHub\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Quantity\": 5337.543120480193,\n \"PriceSelling\": 7801.24785277665,\n \"ValueDiscount\": 8977.169618807291,\n \"IDWarehouseHub\": \"string\",\n \"IDProductHub\": \"string\",\n \"IDHubProduct\": 3746,\n \"IDIntegrationProducts\": \"string\",\n \"Comments\": \"string\",\n \"MainImageURL\": \"string\"\n }\n ],\n \"Messages\": [\n {\n \"IDHubOrderMessage\": 3220,\n \"IDHubOrderMessageExternal\": \"string\",\n \"IDIntegration\": 8210,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"2011-12-07T05:13:35.061Z\",\n \"ReadTimestamp\": \"2002-02-18T22:08:21.988Z\",\n \"Seller\": 8336,\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDHubOrderMessage\": 9417,\n \"IDHubOrderMessageExternal\": \"string\",\n \"IDIntegration\": 9899,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"2024-09-10T04:48:46.058Z\",\n \"ReadTimestamp\": \"2003-02-27T08:48:52.893Z\",\n \"Seller\": 8933,\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Claims\": [\n {\n \"IDHubOrderClaim\": 3458,\n \"IDHubOrderClaimExternal\": \"string\",\n \"ClaimStatus\": 2866,\n \"ClaimCreationDate\": \"1975-04-08T05:43:19.098Z\",\n \"IDTypeHubOrderClaimType\": 4,\n \"TypeHubOrderClaimTypeName\": \"string\",\n \"IDTypeHubOrderClaimStage\": 1,\n \"TypeHubOrderClaimStageName\": \"string\",\n \"IDTypeHubOrderClaimReason\": 9869,\n \"TypeHubOrderClaimReason\": \"string\",\n \"IDTypeHubOrderClaimResolutionReason\": 431,\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\",\n \"ClaimTimestampLastUpdated\": \"2013-03-17T18:02:23.811Z\",\n \"ClaimResolutionDate\": \"2010-07-01T07:01:13.922Z\",\n \"IDProductHub\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 3830,\n \"DueDate\": \"2007-08-12T07:52:07.199Z\",\n \"ActionResponsible\": \"string\",\n \"ClaimTitle\": \"string\",\n \"ClaimDescription\": \"string\",\n \"ClaimProblem\": \"string\",\n \"AvailableActions\": [\n {\n \"Mandatory\": 4724,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 5530.622885910355,\n \"Percentage\": 3958.587548831778\n },\n {\n \"Amount\": 822.1353453900338,\n \"Percentage\": 8513.312868621642\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9810\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 4737\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 2361\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 7658\n }\n ]\n }\n ]\n },\n {\n \"Mandatory\": 3517,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 527.5385619120243,\n \"Percentage\": 4915.396850073867\n },\n {\n \"Amount\": 3515.6582272623814,\n \"Percentage\": 9894.73257536148\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 1206\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9322\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 3926\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 3100\n }\n ]\n }\n ]\n }\n ],\n \"ClaimAffectsReputation\": 0\n },\n {\n \"IDHubOrderClaim\": 8665,\n \"IDHubOrderClaimExternal\": \"string\",\n \"ClaimStatus\": 1391,\n \"ClaimCreationDate\": \"1987-03-11T10:02:09.348Z\",\n \"IDTypeHubOrderClaimType\": 2,\n \"TypeHubOrderClaimTypeName\": \"string\",\n \"IDTypeHubOrderClaimStage\": 2,\n \"TypeHubOrderClaimStageName\": \"string\",\n \"IDTypeHubOrderClaimReason\": 2120,\n \"TypeHubOrderClaimReason\": \"string\",\n \"IDTypeHubOrderClaimResolutionReason\": 41,\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\",\n \"ClaimTimestampLastUpdated\": \"1990-09-25T16:06:47.454Z\",\n \"ClaimResolutionDate\": \"2003-01-18T00:49:21.459Z\",\n \"IDProductHub\": \"string\",\n \"AutopartsProductId\": \"string\",\n \"AutopartsProductDetail\": \"string\",\n \"IDHubProductAutoparts\": 3918,\n \"DueDate\": \"1969-08-04T23:37:29.010Z\",\n \"ActionResponsible\": \"string\",\n \"ClaimTitle\": \"string\",\n \"ClaimDescription\": \"string\",\n \"ClaimProblem\": \"string\",\n \"AvailableActions\": [\n {\n \"Mandatory\": 830,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 8560.255003401227,\n \"Percentage\": 5523.901943815934\n },\n {\n \"Amount\": 2619.8572065036064,\n \"Percentage\": 2305.8321221407473\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 3665\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6229\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6796\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 2783\n }\n ]\n }\n ]\n },\n {\n \"Mandatory\": 8103,\n \"IDTypeHubOrderClaimActionExternalId\": \"string\",\n \"TypeHubOrderClaimActionDescription\": \"string\",\n \"PartialRefundOffers\": [\n {\n \"Amount\": 415.26801966515814,\n \"Percentage\": 4268.435102541279\n },\n {\n \"Amount\": 3071.933954975983,\n \"Percentage\": 5625.014677730478\n }\n ],\n \"ReturnFailReasons\": [\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n },\n {\n \"Reason\": \"string\",\n \"ReasonName\": \"string\"\n }\n ],\n \"OptionsList\": [\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 5767\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 6547\n }\n ]\n },\n {\n \"ShippingMethod\": \"string\",\n \"ShippingMethodLabel\": \"string\",\n \"FieldList\": [\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 1315\n },\n {\n \"Field\": \"string\",\n \"FieldName\": \"string\",\n \"FieldType\": \"string\",\n \"FieldRequired\": 9982\n }\n ]\n }\n ]\n }\n ],\n \"ClaimAffectsReputation\": 3\n }\n ],\n \"ClaimsMessages\": [\n {\n \"IDHubOrderClaimMessage\": 2485,\n \"IDHubOrderClaim\": 4337,\n \"Sender\": 9260,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"1956-06-02T04:16:35.539Z\",\n \"ReadTimestamp\": \"1953-10-29T08:31:44.461Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"IDHubOrderClaimMessage\": 7429,\n \"IDHubOrderClaim\": 5897,\n \"Sender\": 6383,\n \"Message\": \"string\",\n \"MessageTimestamp\": \"2022-12-25T15:20:32.493Z\",\n \"ReadTimestamp\": \"1997-03-31T15:32:22.960Z\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"Index\": 8493\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb71ee88-0f57-4548-b192-6898ec40d238", "name": "Falha ao preparar os links dos anexos das mensagens e reclamações. Mensagem: `[BadRequest] - Falha ao gerar o link dos anexos: `.", "originalRequest": { "url": { "path": [ "hub", "order", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1670eec-3a67-4a6f-b0a8-1b4aba5d166b", "name": "Remove uma linha de staging", "request": { "name": "Remove uma linha de staging", "description": { "content": "Permitido apenas quando `IDOrder` está vazio (linha ainda não virou pedido idworks). Linhas com `IDOrder` preenchido devem ser canceladas pela tela de Pedidos (que reverte estoque, contas a receber, etc.).", "type": "text/plain" }, "url": { "path": [ "hub", "order", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "2ce5f92b-04f0-40fd-9e10-4baa9d90510f", "name": "Removido.", "originalRequest": { "url": { "path": [ "hub", "order", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b122e1b-186e-441e-ba8b-3c05a0bb02e0", "name": "Cria pedido idworks a partir de linha de staging", "request": { "name": "Cria pedido idworks a partir de linha de staging", "description": { "content": "serviço de integração que transforma a linha de staging em pedido efetivo no idworks: cria cliente, endereço, itens (SKUs vinculados), pagamentos (tipo via Hub Pagamento), frete (transportadora via Hub Carriers), aplica armazém + tipo de pedido (via Hub Estoque) e UTM tracking. Após sucesso, o campo `IDOrder` da linha fica preenchido.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "create", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "method": "POST", "auth": null }, "response": [ { "id": "e83e16b6-eb4d-400f-bf33-42c3bd878b60", "name": "Pedido idworks criado.", "originalRequest": { "url": { "path": [ "hub", "order", "create", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fdd173f-4683-4971-b795-ea059387473e", "name": "Reprocessar — re-pull do canal", "request": { "name": "Reprocessar — re-pull do canal", "description": { "content": "Refaz a consulta ao canal a partir do código origem e regrava a linha de staging com os dados frescos — itens, valores, frete, dados do comprador e status. Vale apenas para linhas que ainda não geraram pedido idworks: quando o pedido já existe, a chamada é recusada. Se, depois da atualização, o canal indicar pagamento aprovado e todos os itens e pedidos do mesmo envio já tiverem sido importados, o pedido idworks é criado nesse momento, inclusive com o disparo das mensagens automáticas configuradas para os itens. Em pacotes com vários pedidos, a linha fica aguardando os demais e a chamada é recusada até que todos cheguem. Em caso de sucesso a resposta normalmente vem com corpo vazio; no caminho de criação alguns canais devolvem um texto curto de acompanhamento.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "update", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "98a811e0-033c-4e75-adae-4a0405ee77fd", "name": "Reprocessamento disparado. Normalmente a resposta vem sem corpo; no caminho que cria o pedido, pode vir um texto curto de acompanhamento.", "originalRequest": { "url": { "path": [ "hub", "order", "update", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3aeeec8-0ccc-4fc8-ba65-3d55aadc8447", "name": "Mensagens (prefixo `[BadRequest]`):\n- `Order Not Found` — o pedido de origem informado não existe para a empresa autenticada (mensagem em inglês, ao contrário dos endpoints vizinhos).\n- `Integração não tem atualização` — o canal não implementa o reprocessamento, inclusive quando o canal responde que o recurso não existe.\n\nRecusas de negócio devolvidas pelo canal, repassadas com o mesmo prefixo:\n- `pedido já foi criado` — a mais frequente: o pedido de origem já gerou um pedido no idworks.\n- `canal de venda diferente de Mercado Livre`\n- `ID do pedido inválido`\n- `Documento (CPF/CNPJ) é obrigatório e não está disponível no JSON`\n- `Pacote não está pronto, retentar em alguns minutos`\n- `Pedido sem entrega definida`\n- `precisa aguardar a importação dos outros pedidos que estão no mesmo pacote: {pacote}`", "originalRequest": { "url": { "path": [ "hub", "order", "update", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53b3470a-b93c-4d4a-8c6c-f761c6e3dd2e", "name": "Atualiza SKU vinculado a item da linha", "request": { "name": "Atualiza SKU vinculado a item da linha", "description": { "content": "Edita o vínculo SKU local ↔ produto do canal em um item da linha de staging. Usado pela expansão da linha quando um item está sem SKU mapeado.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "update", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSku\": 7006,\n \"IDIntegrationProducts\": 8774\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "28c03852-b062-4d4c-b791-7006859444fe", "name": "Atualizado.", "originalRequest": { "url": { "path": [ "hub", "order", "update", ":idintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 7006,\n \"IDIntegrationProducts\": 8774\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89bb28e6-9553-4473-a5f4-df34aeb94928", "name": "Consulta status atualizado do pedido no canal", "request": { "name": "Consulta status atualizado do pedido no canal", "description": { "content": "Consulta o status do pedido diretamente no canal e sincroniza a linha de staging com o resultado — útil quando a atualização periódica não trouxe a mudança. Quando o canal devolve o pedido como pago, o valor sincronizado e retornado passa a ser o status do envio (`ready_to_ship`, `shipped`, `delivered`…), permanecendo `paid` enquanto o envio ainda estiver pendente. Além de atualizar o status, marca o pedido idworks como entregue quando o canal já registrou a entrega. No cancelamento a ação depende da origem do estoque: pedidos atendidos pelo armazém do canal (full) são reprocessados pelo fluxo de pedido full, e os demais são cancelados no idworks quando a integração está configurada para cancelamento automático.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "status", ":idorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idorder", "description": "(Required) Identificador do pedido." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c91058a8-c0f3-45d9-a76a-70e4fccecd37", "name": "Código de status do pedido no canal, devolvido como texto puro (ex.: `paid`, `shipped`, `delivered`, `cancelled`, `ready_to_ship`). Em pedidos já pagos o valor devolvido é o status do envio, e não `paid`.", "originalRequest": { "url": { "path": [ "hub", "order", "status", ":idorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idorder", "description": "(Required) Identificador do pedido." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cac2926-858a-4dd8-9f91-85fd95e2b694", "name": "Mensagens `[BadRequest]`: `Pedido não encontrado no hub` — o pedido não tem registro de integração na empresa autenticada; `Integração não tem consulta de status` — o canal não implementa a consulta (também quando o canal responde 404). Erros de negócio devolvidos pelo canal chegam com o prefixo `[BadRequest]` já aplicado.", "originalRequest": { "url": { "path": [ "hub", "order", "status", ":idorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idorder", "description": "(Required) Identificador do pedido." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f806edbc-3c75-4da3-a933-9783b1708611", "name": "Envia NF do pedido para o canal", "request": { "name": "Envia NF do pedido para o canal", "description": { "content": "Envia ao canal o documento fiscal do pedido faturado — vários canais exigem isso para o pedido seguir para Enviado. O parâmetro `Type` troca a ação disparada: marcar como enviado, marcar como entregue, atualizar as tarifas e o valor líquido do canal ou reprocessar o fluxo de pedido full. Omitido, envia a NF. Em caso de sucesso a resposta normalmente vem com corpo vazio, mas em algumas situações o canal devolve um aviso curto em texto puro — por exemplo `Pedido ja enviado` ou `status já está pronto para imprimir` — ainda com `200`. A chamada aguarda a resposta do canal por tempo limitado; esgotado esse prazo a API responde `200` com corpo vazio sem que a ação tenha sido confirmada, então confirme o resultado consultando o pedido.", "type": "text/plain" }, "url": { "path": [ "hub", "order", "invoice", ":idorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "4", "description": "Ação a disparar no canal: `1` marca o pedido como enviado, `2` marca como entregue, `3` atualiza as tarifas, o frete do canal e o valor líquido recebido, `4` reprocessa o fluxo de pedido full. Omitido, envia a NF ao canal." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idorder", "description": "(Required) Identificador do pedido." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "80d075ef-e9c9-4c28-8dd9-26d3dc184b74", "name": "Ação executada. Normalmente a resposta vem sem corpo; em alguns casos o canal devolve um aviso curto em texto puro. Quando a espera pela resposta do canal ultrapassa 20 segundos, a resposta também é `200` com corpo vazio, sem indicar a falha.", "originalRequest": { "url": { "path": [ "hub", "order", "invoice", ":idorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "4" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idorder", "description": "(Required) Identificador do pedido." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85d7f0d9-b5b0-47f8-b395-6563f70b7cc8", "name": "Mensagens (prefixo `[BadRequest]`):\n- `Pedido não encontrado no hub` — pedido sem linha correspondente no hub da empresa autenticada.\n- `Integração não tem envio de NF` — canal sem o recurso, inclusive quando o canal não reconhece a rota.\n\nRecusas de negócio do canal são repassadas com o mesmo prefixo:\n- `Pedido não encontrado` — o canal não localizou o pedido informado.\n- `Nota fiscal não emitida` — a NF ainda não está autorizada, tanto no envio da NF quanto em `Type=1`; em pedidos de entrega ultrarrápida do Mercado Livre a mensagem ganha o lembrete de que a NF precisa ser emitida e enviada dentro do prazo de 25 minutos.\n- `canal de venda diferente de Mercado Livre` (no envio da NF) ou `canal de venda diferente de Meli` (em `Type=1`) — o pedido não pertence ao canal esperado pela rotina.\n- `Transportadora é diferente de me1 e não pode ser atualizado o status` — em `Type=1`, quando o pedido não usa o modo de envio `me1`.", "originalRequest": { "url": { "path": [ "hub", "order", "invoice", ":idorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "4" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idorder", "description": "(Required) Identificador do pedido." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43480b24-70fb-4d8c-b355-3bda8811e26f", "name": "Envia mensagem ao comprador pelo canal", "request": { "name": "Envia mensagem ao comprador pelo canal", "description": { "content": "Envia uma mensagem ao comprador pelo canal. Disponível apenas para o Mercado Livre — nos demais canais a chamada é recusada, exceto na Amazon, onde a rota existe mas ainda não envia nada e responde com sucesso sem efeito. Atenção: quando a linha de staging já tem uma reclamação vinculada, a chamada é redirecionada para o fluxo de ações da reclamação e `Type` precisa ser um dos códigos de ação de reclamação — o valor padrão `send_message` é recusado nesse caso; use `POST /hub/order/claim/{idhuborderclaim}/action`. Quando a linha já tem pedido idworks, o envio fica registrado no histórico de eventos do pedido, inclusive quando o canal recusa. Ao final devolve a linha de staging já atualizada com a nova mensagem. Privilégio `PrivilegeHubOrderMessageSend`.", "type": "text/plain" }, "url": { "path": [ "hub", "order", ":idintegration", "action" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "string", "description": "Filtra por tipo. A semântica depende do endpoint." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Text\": \"string\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7eee819f-0eaf-4455-b3ce-082ee989545e", "name": "Mensagem enviada. Devolve o pedido recarregado no mesmo formato de `GET /hub/order/{idintegration}` — um array de `HubOrderDetailItem` já com a nova mensagem em `Messages`.", "originalRequest": { "url": { "path": [ "hub", "order", ":idintegration", "action" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Text\": \"string\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d37b90c-23b1-413f-bfb8-da2acc2d59de", "name": "Mensagens (prefixo `[BadRequest]`):\n- `Pedido não encontrado no hub` — linha do pedido no hub inexistente ou de outra empresa.\n- `Integração não tem envio de mensagem` — a integração não é de canal de vendas (transportadora, adquirente e afins não enviam mensagem ao comprador).\n- `Integração não tem consulta de status` — o canal de vendas não implementa o envio de mensagem; é a recusa da maioria dos canais.\n\nRecusas do canal, repassadas com o mesmo prefixo:\n- `Mensagem está vazia` — falta `Text`.\n- `Precisar enviar body/payload na requisição` — não há corpo.\n- `Recurso de reclamação não existe` — o pedido tem reclamação e o `Type` enviado não é um código de ação de reclamação válido.", "originalRequest": { "url": { "path": [ "hub", "order", ":idintegration", "action" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Text\": \"string\",\n \"Attachments\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "582cd8ee-87fa-458d-b3f3-fc29c8f04c74", "name": "Anexo de arquivo em mensagem do pedido", "request": { "name": "Anexo de arquivo em mensagem do pedido", "description": { "content": "Faz upload de arquivo para anexar a uma mensagem do pedido.", "type": "text/plain" }, "url": { "path": [ "hub", "order", ":idintegration", "action", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "Arquivo anexado à ação do pedido no canal (imagem ou documento), enviado como multipart." } ] } }, "response": [ { "id": "797ab5a0-9709-4f3b-848d-47b677051e62", "name": "Arquivo anexado.", "originalRequest": { "url": { "path": [ "hub", "order", ":idintegration", "action", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo anexado à ação do pedido no canal (imagem ou documento), enviado como multipart.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0c94f919-4cfa-4c4c-8d7d-07d1de489cfa", "name": "Falha ao enviar o anexo. Mensagens conhecidas:\n- `[BadRequest] - Arquivo não enviado` — a requisição chegou sem arquivo.\n- `[BadRequest] - Arquivo inválido`\n- `[BadRequest] - Erro ao salvar arquivo`\n- `[BadRequest] - erro ao enviar arquivo para mercado livre. Verificar extensão e tamanho do arquivo`\n- `[BadRequest] - Integração não tem recurso de enviar anexo` — o canal de venda não aceita anexo em mensagem.\n- `[BadRequest] - Pedido integração não localizada`\n- `[BadRequest] - Access_token não encontrado` — a integração não está autenticada.\n\nO texto vem em `errorMessage`.", "originalRequest": { "url": { "path": [ "hub", "order", ":idintegration", "action", "file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idintegration", "description": "(Required) Identificador único da linha de staging." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo anexado à ação do pedido no canal (imagem ou documento), enviado como multipart.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "12a71b56-f351-4263-9f7d-f71f22719d03", "name": "Hub — Política Comercial", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "107724ce-2f7e-401a-9820-e09742c36345", "name": "Lista mapeamentos DE-PARA", "request": { "name": "Lista mapeamentos DE-PARA", "description": { "content": "Lista todos os mapeamentos da empresa autenticada. Sem paginação. Ordenação por `IntegrationName, CompanyIntegrationName`.", "type": "text/plain" }, "url": { "path": [ "hub", "sales-policy" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDSalesPolicyTo", "value": "1603", "description": "Filtra por política comercial interna." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Filtra por canal de venda." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f289ecd6-a05a-4dca-a98b-70bfbd3dbb9a", "name": "Array de mapeamentos.", "originalRequest": { "url": { "path": [ "hub", "sales-policy" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDSalesPolicyTo", "value": "1603" }, { "key": "IDCompanyIntegration", "value": "1603" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubSalesPolicy\": 2186,\n \"IDCompanyIntegration\": 9044,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1158,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 9514,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 3118,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDHubSalesPolicy\": 7606,\n \"IDCompanyIntegration\": 4091,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1513,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 5042,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 7989,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b73a6f48-76b9-4f3d-87a6-9729ffba6628", "name": "Cria mapeamento DE-PARA", "request": { "name": "Cria mapeamento DE-PARA", "description": { "content": "Cria um novo mapeamento. **Sem checagem de unicidade** — duplicatas com mesma combinação podem coexistir. Validações:\n\n- Integração precisa existir e pertencer à empresa autenticada.\n- Política comercial interna precisa existir e pertencer à empresa.\n- Tipo de pedido (se informado) precisa existir e pertencer à empresa.\n- Vtex (`IDTypeCompanyIntegration = 23`): `IDSalesPolicyFrom` obrigatório.\n- Mercado Livre (`IDTypeCompanyIntegration = 10`): `ShippingFree` é aceito e armazenado.\n- Outras integrações: `ShippingFree` é **forçado a `null`** pelo servidor (mesmo se enviado no body).\n\nResposta: a lista completa atualizada.", "type": "text/plain" }, "url": { "path": [ "hub", "sales-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9386,\n \"IDSalesPolicyTo\": 1094,\n \"IDSalesPolicyFrom\": \"string\",\n \"ShippingFree\": 0,\n \"IDOrderType\": 579\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f2bac16f-2de4-4fc4-99ad-b28cb99c4b9a", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "sales-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9386,\n \"IDSalesPolicyTo\": 1094,\n \"IDSalesPolicyFrom\": \"string\",\n \"ShippingFree\": 0,\n \"IDOrderType\": 579\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubSalesPolicy\": 2186,\n \"IDCompanyIntegration\": 9044,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1158,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 9514,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 3118,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDHubSalesPolicy\": 7606,\n \"IDCompanyIntegration\": 4091,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1513,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 5042,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 7989,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adf2bb77-f1b7-4856-becb-1bfc2f2ceba7", "name": "Mensagens `[BadRequest]`:\n- `Integração não cadastrada`\n- `Campo política integração é obrigatório para integração Vtex`\n- `Politica comercial não cadastrada`\n- `Tipo pedido não existe`", "originalRequest": { "url": { "path": [ "hub", "sales-policy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9386,\n \"IDSalesPolicyTo\": 1094,\n \"IDSalesPolicyFrom\": \"string\",\n \"ShippingFree\": 0,\n \"IDOrderType\": 579\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50a9f58f-4480-4ff8-a064-d531ba5a7519", "name": "Edita mapeamento DE-PARA", "request": { "name": "Edita mapeamento DE-PARA", "description": { "content": "Edita um mapeamento existente. Mesmas validações do Post:\n\n- Registro precisa existir e pertencer à empresa (referência em `CompanyIntegration`).\n- Regras de obrigatoriedade por integração (Vtex exige `IDSalesPolicyFrom`).\n- `ShippingFree` forçado a `null` quando não-Meli.\n- Quando `ShippingFree` não vem no body, mantém o valor anterior.\n\nResposta: lista completa atualizada (`hubSalesPolicyList` re-invocado).", "type": "text/plain" }, "url": { "path": [ "hub", "sales-policy", ":idhubsalespolicy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubsalespolicy", "description": "(Required) Identificador do mapeamento (`IDHubSalesPolicy`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9386,\n \"IDSalesPolicyTo\": 1094,\n \"IDSalesPolicyFrom\": \"string\",\n \"ShippingFree\": 0,\n \"IDOrderType\": 579\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "62d8e484-9478-4c0f-95b2-97bdee146f1a", "name": "Lista atualizada.", "originalRequest": { "url": { "path": [ "hub", "sales-policy", ":idhubsalespolicy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubsalespolicy", "description": "(Required) Identificador do mapeamento (`IDHubSalesPolicy`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9386,\n \"IDSalesPolicyTo\": 1094,\n \"IDSalesPolicyFrom\": \"string\",\n \"ShippingFree\": 0,\n \"IDOrderType\": 579\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubSalesPolicy\": 2186,\n \"IDCompanyIntegration\": 9044,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1158,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 9514,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 3118,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDHubSalesPolicy\": 7606,\n \"IDCompanyIntegration\": 4091,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1513,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 5042,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 7989,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cee5a5f4-d1a3-40fd-8c98-1bd7d1855b48", "name": "Mensagens `[BadRequest]` (Post +):\n- `Hub Politica Comercial não existe`", "originalRequest": { "url": { "path": [ "hub", "sales-policy", ":idhubsalespolicy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubsalespolicy", "description": "(Required) Identificador do mapeamento (`IDHubSalesPolicy`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDCompanyIntegration\": 9386,\n \"IDSalesPolicyTo\": 1094,\n \"IDSalesPolicyFrom\": \"string\",\n \"ShippingFree\": 0,\n \"IDOrderType\": 579\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc16a819-3fd4-4749-8353-816bc3fb37a8", "name": "Remove mapeamento DE-PARA", "request": { "name": "Remove mapeamento DE-PARA", "description": { "content": "Apaga o mapeamento. Sem restrições — qualquer mapeamento pode ser removido a qualquer momento. As validações reversas vivem em outras telas (`OrderTypeOrderDelete`, `companySalesPolicyDelete`).", "type": "text/plain" }, "url": { "path": [ "hub", "sales-policy", ":idhubsalespolicy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubsalespolicy", "description": "(Required) Identificador do mapeamento (`IDHubSalesPolicy`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "2dc14b7a-1375-494f-9706-06d7513d6a4f", "name": "Lista atualizada após remoção.", "originalRequest": { "url": { "path": [ "hub", "sales-policy", ":idhubsalespolicy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubsalespolicy", "description": "(Required) Identificador do mapeamento (`IDHubSalesPolicy`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDHubSalesPolicy\": 2186,\n \"IDCompanyIntegration\": 9044,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1158,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 9514,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 3118,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n },\n {\n \"IDHubSalesPolicy\": 7606,\n \"IDCompanyIntegration\": 4091,\n \"CompanyIntegration\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"IDTypeCompanyIntegration\": 1513,\n \"IDSalesPolicyFrom\": \"string\",\n \"IDSalesPolicyTo\": 5042,\n \"CompanySalesPolicy\": \"string\",\n \"ShippingFree\": 1,\n \"IDOrderType\": 7989,\n \"TypeOrder\": \"string\",\n \"AccountName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b18f7bdf-2c1b-4031-aa87-9b23478e4b93", "name": "`[BadRequest] - Hub Politica Comercial não existe`.", "originalRequest": { "url": { "path": [ "hub", "sales-policy", ":idhubsalespolicy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idhubsalespolicy", "description": "(Required) Identificador do mapeamento (`IDHubSalesPolicy`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6bd30363-4dc2-41ac-a978-cccaff296f12", "name": "Hub — Recursos", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4cdf6413-5795-434f-b149-0954c4097190", "name": "Callback de autenticação OAuth do canal", "request": { "name": "Callback de autenticação OAuth do canal", "description": { "content": "Endpoint de **callback** chamado pelos canais de venda após o usuário autorizar o idworks. Resolve a integração a partir de `state`/`reference`/`IDCompanyIntegration` (ou de credenciais específicas em `code`/`store`) e despacha para o fluxo de autenticação do tipo de integração — Bling, Cielo, Mercado Livre, Shopee, Olist, Amazon, Shopify, Mercado Pago, Tray, Magalu, Melhor Envio, Shein, Nuvemshop, TikTok, R3Express, Temu, Integra. Cada provedor tem seu próprio formato de corpo e resposta (HTML de redirect, JSON).", "type": "text/plain" }, "url": { "path": [ "hub", "resource", "auth" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Integração da empresa para a qual o callback se aplica. Quando ausente, o sistema tenta resolver via `state`, `reference`, `store` ou credenciais do canal." }, { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "1603", "description": "Tipo de integração. Usado para rotear o callback (ex.: `IDTYPECOMPANYINTEGRATION_INTEGRA`, `IDTYPECOMPANYINTEGRATION_NUVEMSHOP`)." }, { "disabled": false, "key": "state", "value": "string", "description": "Token de estado OAuth (`Token`) usado para correlacionar o callback com a integração originalmente disparada." }, { "disabled": false, "key": "reference", "value": "string", "description": "Alias de `state` para provedores que repassam o token como `reference`." }, { "disabled": false, "key": "code", "value": "string", "description": "Código de autorização devolvido pelo canal — usado nos fluxos OAuth padrão para trocar por token." }, { "disabled": false, "key": "store", "value": "string", "description": "Identificador da loja no canal (`store_id`) — usado pelo Tray para localizar a integração." }, { "disabled": false, "key": "an", "value": "string", "description": "Subdomínio da conta — usado quando não há `requestContext` (chamadas externas diretas)." }, { "disabled": false, "key": "shop_id", "value": "string", "description": "Identificador da loja no Shopee, repassado no callback de autorizacao do canal." }, { "disabled": false, "key": "main_account_id", "value": "string", "description": "Identificador da conta principal no Shopee, repassado no callback quando a loja pertence a uma conta principal." }, { "disabled": false, "key": "selling_partner_id", "value": "string", "description": "Identificador do vendedor (selling partner) devolvido pela Amazon no callback de autorizacao." }, { "disabled": false, "key": "spapi_oauth_code", "value": "string", "description": "Codigo de autorizacao OAuth da Amazon SP-API, usado no lugar de code no callback da Amazon." }, { "disabled": false, "key": "api_address", "value": "string", "description": "Endereco base da API da loja, repassado pela Tray no callback do canal." }, { "disabled": false, "key": "url", "value": "string", "description": "URL da loja, repassada pela Tray no callback do canal." }, { "disabled": false, "key": "tempToken", "value": "string", "description": "Token temporario de autorizacao devolvido pela Shein no callback, trocado em seguida por token de acesso." }, { "disabled": false, "key": "token", "value": "string", "description": "Token de autorizacao devolvido pela R3Express no callback." }, { "disabled": false, "key": "shop", "value": "string", "description": "Dominio da loja Shopify devolvido no callback de instalacao do aplicativo." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3f678166-cce0-4a7b-8eff-c4b2b86adb6b", "name": "Resposta específica do canal — HTML de redirect, JSON com tokens ou texto plano.", "originalRequest": { "url": { "path": [ "hub", "resource", "auth" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "state", "value": "string" }, { "key": "reference", "value": "string" }, { "key": "code", "value": "string" }, { "key": "store", "value": "string" }, { "key": "an", "value": "string" }, { "key": "shop_id", "value": "string" }, { "key": "main_account_id", "value": "string" }, { "key": "selling_partner_id", "value": "string" }, { "key": "spapi_oauth_code", "value": "string" }, { "key": "api_address", "value": "string" }, { "key": "url", "value": "string" }, { "key": "tempToken", "value": "string" }, { "key": "token", "value": "string" }, { "key": "shop", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b2870830-2153-45fe-8b8f-0ae2f52192d3", "name": "Erros de negócio:\n- `Precisa a query string IDCompanyIntegration ou state`\n- `Integração não encontrada. Verificar se a integração já esta cadastrada na idworks e os dados preenchidos (clicar na engrenagem)`\n- `Integração não tem autenticação por URL`", "originalRequest": { "url": { "path": [ "hub", "resource", "auth" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "IDTypeCompanyIntegration", "value": "1603" }, { "key": "state", "value": "string" }, { "key": "reference", "value": "string" }, { "key": "code", "value": "string" }, { "key": "store", "value": "string" }, { "key": "an", "value": "string" }, { "key": "shop_id", "value": "string" }, { "key": "main_account_id", "value": "string" }, { "key": "selling_partner_id", "value": "string" }, { "key": "spapi_oauth_code", "value": "string" }, { "key": "api_address", "value": "string" }, { "key": "url", "value": "string" }, { "key": "tempToken", "value": "string" }, { "key": "token", "value": "string" }, { "key": "shop", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "516197bf-92a0-414c-94dc-02ac6f4f64eb", "name": "Lista recursos disponíveis do tipo de integração", "request": { "name": "Lista recursos disponíveis do tipo de integração", "description": { "content": "Retorna os recursos (`TypeSalesChannelResource`) cadastrados para o tipo de integração e o `ResourceType` indicado. Para `ResourceType=Autoparts`, o sistema ainda valida que a categoria `CategoryId` está na lista de categorias suportadas — se não estiver, devolve `[]` em vez da lista completa.", "type": "text/plain" }, "url": { "path": [ "hub", "resource", ":idtypecompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ResourceType", "value": "string", "description": "(Required) Tipo de recurso a listar (ex.: `Autoparts`, `Category`, `CategoryAttribute`, `SkuCondition`, `TypeOffer`, `ModeShipping`, `OfficialStore`)." }, { "disabled": false, "key": "CategoryId", "value": "string", "description": "Identificador de categoria do canal. Obrigatório quando `ResourceType=Autoparts` para filtrar pela lista oficial do canal." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idtypecompanyintegration", "description": "(Required) Tipo de integração (canal)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "becf82ec-ffda-444b-b2ae-0ba7ccfa2e51", "name": "Array de recursos disponíveis (vazio quando nenhum recurso casa com o filtro, ou quando a categoria não suporta `Autoparts`).", "originalRequest": { "url": { "path": [ "hub", "resource", ":idtypecompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ResourceType", "value": "string" }, { "key": "CategoryId", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idtypecompanyintegration", "description": "(Required) Tipo de integração (canal)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeSalesChannelResource\": 9360,\n \"ResourceType\": \"string\",\n \"Resource\": \"string\",\n \"ResourceDescription\": \"string\",\n \"ResourceName\": \"string\",\n \"ResourceUrl\": \"string\",\n \"ResourceOrder\": 1000,\n \"ResourceKey\": \"string\",\n \"Confirm\": 1436,\n \"IDTypeCompanyIntegration\": 4889,\n \"RateLimit\": 1,\n \"Cache\": 0,\n \"IntegrationName\": \"string\"\n },\n {\n \"IDTypeSalesChannelResource\": 6011,\n \"ResourceType\": \"string\",\n \"Resource\": \"string\",\n \"ResourceDescription\": \"string\",\n \"ResourceName\": \"string\",\n \"ResourceUrl\": \"string\",\n \"ResourceOrder\": 4818,\n \"ResourceKey\": \"string\",\n \"Confirm\": 5574,\n \"IDTypeCompanyIntegration\": 4511,\n \"RateLimit\": 1,\n \"Cache\": 0,\n \"IntegrationName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da4c07bc-74bb-4f14-8e89-a8df8286957d", "name": "Consulta valores do recurso no canal", "request": { "name": "Consulta valores do recurso no canal", "description": { "content": "Atua como proxy para o serviço que consulta o canal de venda. Resolve o recurso indicado em `IDTypeSalesChannelResource` e repassa ao canal o conjunto de parâmetros relevante para aquele recurso (categoria, marca, gênero, grade de tamanho, dados do anúncio, custos, restrições por veículo, etiqueta/coleta, etc.). O reaproveitamento da resposta é definido pelo cadastro do recurso, não por parâmetro do cliente: sempre consultar o canal; reaproveitar a última resposta guardada e, quando não houver, consultar o canal e guardar por 3 dias; ou apenas ler a resposta já guardada por outro processo. Respostas que não sejam um objeto JSON nunca são guardadas para reaproveitamento.", "type": "text/plain" }, "url": { "path": [ "hub", "resource", ":idtypecompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeSalesChannelResource", "value": "1603", "description": "(Required) Identificador do recurso do canal a consultar, obtido em `GET /hub/resource/{idtypecompanyintegration}`. Quando não é informado ou não corresponde a um recurso do tipo de integração indicado, a chamada falha com `Integração não encontrada`." }, { "disabled": false, "key": "IDHubProduct", "value": "1603", "description": "Produto Hub interno a que a consulta se refere (quando o recurso depende do produto)." }, { "disabled": false, "key": "IDHubAdvertisement", "value": "1603", "description": "Anúncio Hub interno (quando aplicável)." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "1603", "description": "Integração específica da empresa a usar como credencial no canal." }, { "disabled": false, "key": "CategoryId", "value": "string", "description": "Identificador da categoria no canal — chave da lista para vários `ResourceType`." }, { "disabled": false, "key": "CategoryName", "value": "string", "description": "Nome da categoria no canal." }, { "disabled": false, "key": "CatalogDomain", "value": "string", "description": "Domínio de catálogo (Mercado Livre)." }, { "disabled": false, "key": "Brand", "value": "string", "description": "Marca." }, { "disabled": false, "key": "Gender", "value": "string", "description": "Gênero (vestuário)." }, { "disabled": false, "key": "SizeChart", "value": "string", "description": "Identificador da grade de tamanho." }, { "disabled": false, "key": "GenderId", "value": "string", "description": "Identificador do gênero no canal." }, { "disabled": false, "key": "GridExternalId", "value": "string", "description": "Identificador externo da grade." }, { "disabled": false, "key": "IDHubProductSizeChart", "value": "1603", "description": "Grade de tamanho do produto Hub." }, { "disabled": false, "key": "ProfitMargin", "value": "478.75460817372374", "description": "Margem de lucro (cálculos de preço sugerido)." }, { "disabled": false, "key": "FixedProfit", "value": "478.75460817372374", "description": "Lucro fixo (cálculos de preço sugerido)." }, { "disabled": false, "key": "OtherExpenses", "value": "478.75460817372374", "description": "Outras despesas (cálculos de preço sugerido)." }, { "disabled": false, "key": "Cost", "value": "478.75460817372374", "description": "Custo do produto (cálculos de preço sugerido)." }, { "disabled": false, "key": "Name", "value": "string", "description": "Nome do produto/anúncio para sugestões." }, { "disabled": false, "key": "Type", "value": "string", "description": "Tipo (filtro genérico — depende do recurso)." }, { "disabled": false, "key": "BrandId", "value": "string", "description": "Identificador da marca no canal (autopeças)." }, { "disabled": false, "key": "ModelId", "value": "string", "description": "Identificador do modelo (autopeças)." }, { "disabled": false, "key": "YearId", "value": "string", "description": "Ano (autopeças)." }, { "disabled": false, "key": "Filter", "value": "string", "description": "Filtro textual (autopeças)." }, { "disabled": false, "key": "PowerId", "value": "string", "description": "Potência (autopeças)." }, { "disabled": false, "key": "ShortVersionId", "value": "string", "description": "Versão curta (autopeças)." }, { "disabled": false, "key": "EngineId", "value": "string", "description": "Motor (autopeças)." }, { "disabled": false, "key": "FuelId", "value": "string", "description": "Combustível (autopeças)." }, { "disabled": false, "key": "BodyTypeId", "value": "string", "description": "Carroceria (autopeças)." }, { "disabled": false, "key": "TransmissionId", "value": "string", "description": "Transmissão (autopeças)." }, { "disabled": false, "key": "GearId", "value": "string", "description": "Câmbio (autopeças)." }, { "disabled": false, "key": "DoorsId", "value": "string", "description": "Quantidade de portas (autopeças)." }, { "disabled": false, "key": "SteeringId", "value": "string", "description": "Direção (autopeças)." }, { "disabled": false, "key": "TractionId", "value": "string", "description": "Tração (autopeças)." }, { "disabled": false, "key": "ValvesId", "value": "string", "description": "Quantidade de válvulas (autopeças)." }, { "disabled": false, "key": "Version", "value": "string", "description": "Versão (autopeças)." }, { "disabled": false, "key": "Quantity", "value": "478.75460817372374", "description": "Quantidade (recursos que dependem da quantidade — `ModeShipping`)." }, { "disabled": false, "key": "State", "value": "string", "description": "UF (frete por região)." }, { "disabled": false, "key": "BuyerId", "value": "string", "description": "Comprador (lista de modos de envio personalizados por comprador)." }, { "disabled": false, "key": "IDOrdersCarrierCollectionList", "value": "string", "description": "Lista de romaneios de coleta (CSV de identificadores) repassada ao processo do canal — usada por recursos de etiqueta/coleta." }, { "disabled": false, "key": "LabelFormat", "value": "string", "description": "Formato da etiqueta solicitada ao canal (repassado como format ao processo) — aplicável a recursos de geração de etiqueta." }, { "disabled": false, "key": "token", "value": "string", "description": "Token de autorização repassado ao processo do canal. Normalmente vem do contexto autenticado; aceito também via query como fallback." } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idtypecompanyintegration", "description": "(Required) Tipo de integração (canal)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "82687876-a47c-48e3-bee8-b09760a5d3c7", "name": "Resposta opaca devolvida pelo processo do canal. Estrutura varia por `ResourceType`/canal — não há schema único.", "originalRequest": { "url": { "path": [ "hub", "resource", ":idtypecompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeSalesChannelResource", "value": "1603" }, { "key": "IDHubProduct", "value": "1603" }, { "key": "IDHubAdvertisement", "value": "1603" }, { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "CategoryId", "value": "string" }, { "key": "CategoryName", "value": "string" }, { "key": "CatalogDomain", "value": "string" }, { "key": "Brand", "value": "string" }, { "key": "Gender", "value": "string" }, { "key": "SizeChart", "value": "string" }, { "key": "GenderId", "value": "string" }, { "key": "GridExternalId", "value": "string" }, { "key": "IDHubProductSizeChart", "value": "1603" }, { "key": "ProfitMargin", "value": "478.75460817372374" }, { "key": "FixedProfit", "value": "478.75460817372374" }, { "key": "OtherExpenses", "value": "478.75460817372374" }, { "key": "Cost", "value": "478.75460817372374" }, { "key": "Name", "value": "string" }, { "key": "Type", "value": "string" }, { "key": "BrandId", "value": "string" }, { "key": "ModelId", "value": "string" }, { "key": "YearId", "value": "string" }, { "key": "Filter", "value": "string" }, { "key": "PowerId", "value": "string" }, { "key": "ShortVersionId", "value": "string" }, { "key": "EngineId", "value": "string" }, { "key": "FuelId", "value": "string" }, { "key": "BodyTypeId", "value": "string" }, { "key": "TransmissionId", "value": "string" }, { "key": "GearId", "value": "string" }, { "key": "DoorsId", "value": "string" }, { "key": "SteeringId", "value": "string" }, { "key": "TractionId", "value": "string" }, { "key": "ValvesId", "value": "string" }, { "key": "Version", "value": "string" }, { "key": "Quantity", "value": "478.75460817372374" }, { "key": "State", "value": "string" }, { "key": "BuyerId", "value": "string" }, { "key": "IDOrdersCarrierCollectionList", "value": "string" }, { "key": "LabelFormat", "value": "string" }, { "key": "token", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idtypecompanyintegration", "description": "(Required) Tipo de integração (canal)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af9c4eb8-7d68-4ea6-b154-914049d0e7bf", "name": "Mensagens `[BadRequest]`:\n- `Integração não encontrada`\n- `Integração não tem recurso`", "originalRequest": { "url": { "path": [ "hub", "resource", ":idtypecompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeSalesChannelResource", "value": "1603" }, { "key": "IDHubProduct", "value": "1603" }, { "key": "IDHubAdvertisement", "value": "1603" }, { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "CategoryId", "value": "string" }, { "key": "CategoryName", "value": "string" }, { "key": "CatalogDomain", "value": "string" }, { "key": "Brand", "value": "string" }, { "key": "Gender", "value": "string" }, { "key": "SizeChart", "value": "string" }, { "key": "GenderId", "value": "string" }, { "key": "GridExternalId", "value": "string" }, { "key": "IDHubProductSizeChart", "value": "1603" }, { "key": "ProfitMargin", "value": "478.75460817372374" }, { "key": "FixedProfit", "value": "478.75460817372374" }, { "key": "OtherExpenses", "value": "478.75460817372374" }, { "key": "Cost", "value": "478.75460817372374" }, { "key": "Name", "value": "string" }, { "key": "Type", "value": "string" }, { "key": "BrandId", "value": "string" }, { "key": "ModelId", "value": "string" }, { "key": "YearId", "value": "string" }, { "key": "Filter", "value": "string" }, { "key": "PowerId", "value": "string" }, { "key": "ShortVersionId", "value": "string" }, { "key": "EngineId", "value": "string" }, { "key": "FuelId", "value": "string" }, { "key": "BodyTypeId", "value": "string" }, { "key": "TransmissionId", "value": "string" }, { "key": "GearId", "value": "string" }, { "key": "DoorsId", "value": "string" }, { "key": "SteeringId", "value": "string" }, { "key": "TractionId", "value": "string" }, { "key": "ValvesId", "value": "string" }, { "key": "Version", "value": "string" }, { "key": "Quantity", "value": "478.75460817372374" }, { "key": "State", "value": "string" }, { "key": "BuyerId", "value": "string" }, { "key": "IDOrdersCarrierCollectionList", "value": "string" }, { "key": "LabelFormat", "value": "string" }, { "key": "token", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idtypecompanyintegration", "description": "(Required) Tipo de integração (canal)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53232ac4-5011-4ddd-ba3c-076a9f96d317", "name": "Falha repassada pelo processo do canal. Corpo JSON com `errorMessage` e `errorCode` originados do canal, mais `errorHelp`, que é sempre devolvido como string vazia.", "originalRequest": { "url": { "path": [ "hub", "resource", ":idtypecompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeSalesChannelResource", "value": "1603" }, { "key": "IDHubProduct", "value": "1603" }, { "key": "IDHubAdvertisement", "value": "1603" }, { "key": "IDCompanyIntegration", "value": "1603" }, { "key": "CategoryId", "value": "string" }, { "key": "CategoryName", "value": "string" }, { "key": "CatalogDomain", "value": "string" }, { "key": "Brand", "value": "string" }, { "key": "Gender", "value": "string" }, { "key": "SizeChart", "value": "string" }, { "key": "GenderId", "value": "string" }, { "key": "GridExternalId", "value": "string" }, { "key": "IDHubProductSizeChart", "value": "1603" }, { "key": "ProfitMargin", "value": "478.75460817372374" }, { "key": "FixedProfit", "value": "478.75460817372374" }, { "key": "OtherExpenses", "value": "478.75460817372374" }, { "key": "Cost", "value": "478.75460817372374" }, { "key": "Name", "value": "string" }, { "key": "Type", "value": "string" }, { "key": "BrandId", "value": "string" }, { "key": "ModelId", "value": "string" }, { "key": "YearId", "value": "string" }, { "key": "Filter", "value": "string" }, { "key": "PowerId", "value": "string" }, { "key": "ShortVersionId", "value": "string" }, { "key": "EngineId", "value": "string" }, { "key": "FuelId", "value": "string" }, { "key": "BodyTypeId", "value": "string" }, { "key": "TransmissionId", "value": "string" }, { "key": "GearId", "value": "string" }, { "key": "DoorsId", "value": "string" }, { "key": "SteeringId", "value": "string" }, { "key": "TractionId", "value": "string" }, { "key": "ValvesId", "value": "string" }, { "key": "Version", "value": "string" }, { "key": "Quantity", "value": "478.75460817372374" }, { "key": "State", "value": "string" }, { "key": "BuyerId", "value": "string" }, { "key": "IDOrdersCarrierCollectionList", "value": "string" }, { "key": "LabelFormat", "value": "string" }, { "key": "token", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1603", "key": "idtypecompanyintegration", "description": "(Required) Tipo de integração (canal)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"string\",\n \"errorCode\": \"string\",\n \"errorHelp\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "af891945-9baa-49c7-a221-79d17569cbfc", "name": "Hub — Tipos de Referência", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e24524c6-e8ca-4e9c-894e-b5fd3e5be8ea", "name": "Lista status de promoção — Hub Promoções", "request": { "name": "Lista status de promoção — Hub Promoções", "description": { "content": "Lista os status possíveis de promoção do hub: `1` Ativo · `2` Iniciado · `3` Programada · `4` Candidato · `5` Finalizada · `6` Ativação pendente · `7` Exclusão pendente · `8` Excluido.", "type": "text/plain" }, "url": { "path": [ "type", "hub", "product", "promotion", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "2232", "description": "Filtra por integração (atualmente todos os status valem para todas as integrações)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e644c70a-e504-4397-b31d-c82ccbc77262", "name": "Status.", "originalRequest": { "url": { "path": [ "type", "hub", "product", "promotion", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeHubProductPromotionStatus\": \"string\",\n \"TypeHubProductPromotionStatus\": \"string\"\n },\n {\n \"IDTypeHubProductPromotionStatus\": \"string\",\n \"TypeHubProductPromotionStatus\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f6a5870-317e-42eb-8553-8e89b1d4a119", "name": "Lista tipos de promoção — Hub Promoções", "request": { "name": "Lista tipos de promoção — Hub Promoções", "description": { "content": "Lista os tipos de promoção do hub (`Tradicional`, `Campanha vendedor`, `Oferta relâmpago`, `Oferta do dia`, `Desconto individual`, etc.). Use `SellerCreate=1` para listar apenas tipos que o vendedor pode criar diretamente pela API.", "type": "text/plain" }, "url": { "path": [ "type", "hub", "product", "promotion", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "2232", "description": "Filtra por integração (ex.: `10` para Mercado Livre)." }, { "disabled": false, "key": "SellerCreate", "value": "2232", "description": "Filtra tipos que o vendedor pode criar localmente. `1` apenas criáveis · `0` apenas recebidos." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7ca95e44-6d11-43cb-8935-dbca9d38bd1c", "name": "Tipos.", "originalRequest": { "url": { "path": [ "type", "hub", "product", "promotion", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" }, { "key": "SellerCreate", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeHubProductPromotion\": \"string\",\n \"TypeHubProductPromotionDescription\": \"string\"\n },\n {\n \"IDTypeHubProductPromotion\": \"string\",\n \"TypeHubProductPromotionDescription\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a0bb89e-d70a-47c1-9ac1-845b8b875aa1", "name": "Lista motivos de reclamação de pedido (Hub)", "request": { "name": "Lista motivos de reclamação de pedido (Hub)", "description": { "content": "Lista os motivos de abertura de reclamações em pedidos do Hub. Quando filtrado por integração, retorna apenas os motivos válidos no marketplace correspondente.", "type": "text/plain" }, "url": { "path": [ "type", "hub", "order", "claim", "reason" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "2232", "description": "Identificador do tipo de integração do marketplace." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7414aa22-2112-4017-8980-425c6f5949b2", "name": "Lista retornada.", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "reason" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeHubOrderClaimReason\": 5445,\n \"IDTypeHubOrderClaimReasonExternalId\": \"string\",\n \"TypeHubOrderClaimReason\": \"string\"\n },\n {\n \"IDTypeHubOrderClaimReason\": 1707,\n \"IDTypeHubOrderClaimReasonExternalId\": \"string\",\n \"TypeHubOrderClaimReason\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8501e00b-f450-4bf9-937d-81fca8858e51", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "reason" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8ad93bd-261a-47ee-9f99-093d817d5054", "name": "Lista motivos de resolução de reclamação (Hub)", "request": { "name": "Lista motivos de resolução de reclamação (Hub)", "description": { "content": "Lista os motivos de resolução de reclamações de pedido do Hub.", "type": "text/plain" }, "url": { "path": [ "type", "hub", "order", "claim", "resolution-reason" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "2232", "description": "Identificador do tipo de integração do marketplace." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "05f3aebe-b235-462d-bd55-0c97cc20e85d", "name": "Lista retornada.", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "resolution-reason" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeHubOrderClaimResolutionReason\": 4872,\n \"IDTypeHubOrderClaimResolutionReasonExternalId\": \"string\",\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\"\n },\n {\n \"IDTypeHubOrderClaimResolutionReason\": 6130,\n \"IDTypeHubOrderClaimResolutionReasonExternalId\": \"string\",\n \"TypeHubOrderClaimResolutionReasonDescription\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01648bef-bad9-4fbe-97ab-861c7c6c09cf", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "resolution-reason" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cf40147-b3a4-48b8-86e7-a4ecdaf110e1", "name": "Lista estágios de reclamação (Hub)", "request": { "name": "Lista estágios de reclamação (Hub)", "description": { "content": "Lista os estágios de evolução de uma reclamação de pedido do Hub.", "type": "text/plain" }, "url": { "path": [ "type", "hub", "order", "claim", "stage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "2232", "description": "Identificador do tipo de integração do marketplace." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e0389fa7-7cf6-4aff-b2c5-76b4063654af", "name": "Lista retornada.", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "stage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeHubOrderClaimStage\": 1,\n \"IDTypeHubOrderClaimStageExternalId\": \"string\",\n \"TypeHubOrderClaimStageName\": \"string\"\n },\n {\n \"IDTypeHubOrderClaimStage\": 4,\n \"IDTypeHubOrderClaimStageExternalId\": \"string\",\n \"TypeHubOrderClaimStageName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7425ae83-9d8e-4007-97ec-d34abc04ee1a", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "stage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ec1399f-ec95-4dcd-b9d2-a2ee4122bd8b", "name": "Lista tipos de reclamação (Hub)", "request": { "name": "Lista tipos de reclamação (Hub)", "description": { "content": "Lista os tipos de reclamação de pedido (devolução, troca, garantia, etc.).", "type": "text/plain" }, "url": { "path": [ "type", "hub", "order", "claim", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "2232", "description": "Identificador do tipo de integração do marketplace." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "822954ce-5817-4ace-83ee-0f496e683fb7", "name": "Lista retornada.", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeHubOrderClaimType\": 6,\n \"IDTypeHubOrderClaimTypeExternalId\": \"string\",\n \"TypeHubOrderClaimTypeName\": \"string\"\n },\n {\n \"IDTypeHubOrderClaimType\": 7,\n \"IDTypeHubOrderClaimTypeExternalId\": \"string\",\n \"TypeHubOrderClaimTypeName\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255d3d1c-1f7c-4651-a562-3086302defc5", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "type", "hub", "order", "claim", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegration", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b5e9c80-5696-4fba-87f0-3df3964c5f4e", "name": "Lista status de pergunta de produto (Hub)", "request": { "name": "Lista status de pergunta de produto (Hub)", "description": { "content": "Lista os status possíveis de uma pergunta de produto em marketplaces (pendente, respondida, descartada, etc.).", "type": "text/plain" }, "url": { "path": [ "type", "hub", "product", "question-answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9ae27d2f-760a-4bfb-88d5-09a656ec52d9", "name": "Lista retornada.", "originalRequest": { "url": { "path": [ "type", "hub", "product", "question-answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeHubProductQuestionAnswerStatus\": 1,\n \"TypeHubProductQuestionAnswerStatus\": \"string\"\n },\n {\n \"IDTypeHubProductQuestionAnswerStatus\": 2,\n \"TypeHubProductQuestionAnswerStatus\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c15f74c-ffe0-42ca-8aa2-5f2a3b63eccc", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "type", "hub", "product", "question-answer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "74ebadfd-5e8d-48d0-b109-f327cf4103e8", "name": "Imagens de SKU", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "dcff73cd-05f7-4b3a-9363-1e9a528ba267", "name": "Lista as imagens de um SKU", "request": { "name": "Lista as imagens de um SKU", "description": { "content": "Retorna as imagens do SKU ordenadas por `ImageOrder`. Quando o SKU está configurado para herdar imagens do produto-pai (`ShareProductImage = 1`), inclui também as imagens deste com `ProductImage = 1`.", "type": "text/plain" }, "url": { "path": [ "sku", "image", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "495a838b-ceae-46f8-a745-99181e3cf3bf", "name": "Lista de imagens.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDImage\": 9554,\n \"IDSku\": 5889,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 2869,\n \"ImageWidth\": 215,\n \"ImageHeight\": 9343,\n \"ImageOrder\": 382,\n \"IsMain\": 474,\n \"Kit\": 4991,\n \"ShareProductImage\": 6868,\n \"ProductImage\": 7406\n },\n {\n \"IDImage\": 3246,\n \"IDSku\": 2559,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 5003,\n \"ImageWidth\": 2001,\n \"ImageHeight\": 3550,\n \"ImageOrder\": 8740,\n \"IsMain\": 8575,\n \"Kit\": 3091,\n \"ShareProductImage\": 813,\n \"ProductImage\": 8075\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "399c8ad4-2dd4-47ad-89c3-911d5060b6be", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf9de412-016e-4f90-b165-f9f4cce0bb2b", "name": "Envia uma imagem para o SKU", "request": { "name": "Envia uma imagem para o SKU", "description": { "content": "Cadastra uma imagem para o SKU em uma de três formas: upload do arquivo em `multipart/form-data` no campo `file`; corpo JSON com `Url`, e nesse caso o serviço baixa a imagem da URL externa e a republica no domínio público do idworks; ou `IDImage` na query string, que copia para este SKU uma imagem já existente da empresa, reaproveitando nome, dimensões, tamanho e URL do original. A primeira imagem não exclusiva de anúncio vira automaticamente a principal, e a ordem de exibição é atribuída na sequência das imagens já cadastradas — nenhum desses dois atributos pode ser informado na chamada. Quando `IDHubProduct` ou `IDHubAdvertisement` é informado, a imagem também é vinculada ao anúncio ou à variação de anúncio correspondente. Envia uma notificação para o webhook com o tópico `SkuImagePost`.", "type": "text/plain" }, "url": { "path": [ "sku", "image", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Invoke", "value": "string", "description": "Nome da rotina a executar após o upload, para refletir a alteração em uma integração específica." }, { "disabled": false, "key": "IDImage", "value": "2232", "description": "Quando informado, atualiza a imagem existente." }, { "disabled": false, "key": "OnlyAdvertisement", "value": "1", "description": "`1` salva a imagem como exclusiva de anúncio (não aparece na ficha do SKU)." }, { "disabled": false, "key": "IDHubProduct", "value": "2232", "description": "Vincula a imagem a um anúncio (produto no hub)." }, { "disabled": false, "key": "IDHubAdvertisement", "value": "2232", "description": "Vincula a imagem a uma variação de anúncio (SKU no hub)." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "Arquivo de imagem." } ] } }, "response": [ { "id": "a7901001-8eec-49af-b742-02807a89a278", "name": "Imagem cadastrada. O corpo depende do caminho usado:\n- Com `IDHubProduct`: array com as imagens do anúncio.\n- Com `IDHubAdvertisement`: array com as imagens da variação de anúncio.\n- Sem nenhum dos dois e com `Invoke`: array com as imagens do SKU, no mesmo formato de `GET /sku/image/{idsku}`.\n- Sem nenhum dos dois e sem `Invoke`: `200` **sem corpo**.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Invoke", "value": "string" }, { "key": "IDImage", "value": "2232" }, { "key": "OnlyAdvertisement", "value": "1" }, { "key": "IDHubProduct", "value": "2232" }, { "key": "IDHubAdvertisement", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo de imagem.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDImage\": 821,\n \"IDSku\": 8564,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 6178,\n \"ImageWidth\": 2059,\n \"ImageHeight\": 4183,\n \"ImageOrder\": 8522,\n \"IsMain\": 2020,\n \"Kit\": 9893,\n \"ShareProductImage\": 7932,\n \"ProductImage\": 2606,\n \"IDHubProduct\": 1912,\n \"IDHubAdvertisement\": 6977\n },\n {\n \"IDImage\": 236,\n \"IDSku\": 4033,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 9413,\n \"ImageWidth\": 8692,\n \"ImageHeight\": 6104,\n \"ImageOrder\": 9130,\n \"IsMain\": 7197,\n \"Kit\": 831,\n \"ShareProductImage\": 8546,\n \"ProductImage\": 5953,\n \"IDHubProduct\": 3890,\n \"IDHubAdvertisement\": 439\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de4eb6ac-a109-467b-8406-3c5767a52ea7", "name": "Anúncio inválido ou arquivo recusado. Com `IDHubProduct`/`IDHubAdvertisement` inválidos, o corpo é o texto puro `Anúncio não encontrado` ou `Variação anúncio não encontrada`. No upload em `multipart/form-data` sem o campo `file`, e quando o download da URL informada em `Url` falha, a resposta é `400` sem corpo. Quando a URL responde mas o arquivo não é reconhecido como imagem, o corpo traz `errorMessage` com `[BadRequest] - Verificar se URL possui extensão do arquivo (.jpg, .png) - `.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Invoke", "value": "string" }, { "key": "IDImage", "value": "2232" }, { "key": "OnlyAdvertisement", "value": "1" }, { "key": "IDHubProduct", "value": "2232" }, { "key": "IDHubAdvertisement", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo de imagem.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c352029b-6526-4f2b-9445-bbe04f6edf71", "name": "Sem corpo. Devolvido em dois casos: SKU não encontrado para a empresa; ou `IDImage` informado apontando para uma imagem que não pertence à empresa.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Invoke", "value": "string" }, { "key": "IDImage", "value": "2232" }, { "key": "OnlyAdvertisement", "value": "1" }, { "key": "IDHubProduct", "value": "2232" }, { "key": "IDHubAdvertisement", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Arquivo de imagem.", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6430f4b0-23a0-4dd7-85b3-aefb392ed826", "name": "Atualiza uma imagem do SKU", "request": { "name": "Atualiza uma imagem do SKU", "description": { "content": "Atualiza os atributos de uma imagem do SKU — imagem principal, ordem de exibição, nome, variante de kit e URL. Atualiza também a data da última modificação do SKU e registra a alteração no histórico de integração do SKU, para que as integrações de marketplace repliquem a mudança. Envia uma notificação para o webhook com o tópico `SkuImagePut` e retorna a lista atualizada de imagens do SKU.", "type": "text/plain" }, "url": { "path": [ "sku", "image", ":idsku", ":idimage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDImage", "value": "2232", "description": "Identificador da imagem a atualizar. Quando enviado, tem precedência sobre o `idimage` do caminho." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idimage", "description": "(Required) Identificador da imagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IsMain\": 1,\n \"ImageName\": \"string\",\n \"Kit\": 4806,\n \"Url\": \"string\",\n \"ImageOrder\": 8840\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1072c799-7cfd-4484-a479-b7753c8583f8", "name": "Imagem atualizada. Retorna a lista atualizada de imagens do SKU. A alteração atualiza a data da última modificação do SKU e entra no histórico de integração do SKU — é isso que faz as integrações de marketplace reprocessarem a imagem. O sistema também envia uma notificação para o webhook, no tópico `SkuImagePut`, com `IDSku`, `IDImage`, `AccountName` e a data/hora da modificação.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku", ":idimage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDImage", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idimage", "description": "(Required) Identificador da imagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IsMain\": 1,\n \"ImageName\": \"string\",\n \"Kit\": 4806,\n \"Url\": \"string\",\n \"ImageOrder\": 8840\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDImage\": 9554,\n \"IDSku\": 5889,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 2869,\n \"ImageWidth\": 215,\n \"ImageHeight\": 9343,\n \"ImageOrder\": 382,\n \"IsMain\": 474,\n \"Kit\": 4991,\n \"ShareProductImage\": 6868,\n \"ProductImage\": 7406\n },\n {\n \"IDImage\": 3246,\n \"IDSku\": 2559,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 5003,\n \"ImageWidth\": 2001,\n \"ImageHeight\": 3550,\n \"ImageOrder\": 8740,\n \"IsMain\": 8575,\n \"Kit\": 3091,\n \"ShareProductImage\": 813,\n \"ProductImage\": 8075\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e65b6b-454f-4bbb-8f66-c511e593af9a", "name": "SKU/imagem não encontrada. Prefixo `[BadRequest]`. Mensagem: `Company não existe`.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku", ":idimage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDImage", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idimage", "description": "(Required) Identificador da imagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IsMain\": 1,\n \"ImageName\": \"string\",\n \"Kit\": 4806,\n \"Url\": \"string\",\n \"ImageOrder\": 8840\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aca9cb8f-39e4-4186-a83f-11ebce6d2bb2", "name": "Remove uma imagem do SKU", "request": { "name": "Remove uma imagem do SKU", "description": { "content": "Remove a imagem do SKU. Quando a imagem ainda está vinculada a um anúncio de marketplace, ela não é excluída: passa a ser marcada como exclusiva de anúncio e some da ficha do SKU. Quando a imagem removida era a principal, a próxima imagem da galeria, por ordem de exibição, assume o lugar. Envia uma notificação para o webhook com o tópico `SkuImageDelete` e retorna a lista atualizada de imagens do SKU.", "type": "text/plain" }, "url": { "path": [ "sku", "image", ":idsku", ":idimage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDImage", "value": "2232", "description": "Identificador da imagem a remover. Quando enviado, tem precedência sobre o `idimage` do caminho." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idimage", "description": "(Required) Identificador da imagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "d77d77e0-aa81-4744-944a-39343ce22e5d", "name": "Imagem removida. Retorna a lista atualizada de imagens do SKU.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku", ":idimage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDImage", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idimage", "description": "(Required) Identificador da imagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDImage\": 9554,\n \"IDSku\": 5889,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 2869,\n \"ImageWidth\": 215,\n \"ImageHeight\": 9343,\n \"ImageOrder\": 382,\n \"IsMain\": 474,\n \"Kit\": 4991,\n \"ShareProductImage\": 6868,\n \"ProductImage\": 7406\n },\n {\n \"IDImage\": 3246,\n \"IDSku\": 2559,\n \"Url\": \"string\",\n \"ImageName\": \"string\",\n \"ImageSize\": 5003,\n \"ImageWidth\": 2001,\n \"ImageHeight\": 3550,\n \"ImageOrder\": 8740,\n \"IsMain\": 8575,\n \"Kit\": 3091,\n \"ShareProductImage\": 813,\n \"ProductImage\": 8075\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "547b43e6-4653-4b3c-b5ee-6491d37b97cb", "name": "Imagem não pertence ao SKU/empresa. Prefixo `[BadRequest]`. Mensagem: `Sku não existe`.", "originalRequest": { "url": { "path": [ "sku", "image", ":idsku", ":idimage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDImage", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idimage", "description": "(Required) Identificador da imagem." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f7a763e1-905a-4dff-873c-8de221f8e94a", "name": "Integrações", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9292ae04-0599-40e6-97e8-8b521c2aac5e", "name": "Lista as integrações da empresa", "request": { "name": "Lista as integrações da empresa", "description": { "content": "Retorna as integrações configuradas pela empresa (`CompanyIntegration`) com o tipo já resolvido (logo, nome, categoria) e o nível de reputação consolidado a partir das parametrizações. Aceita filtros opcionais por categoria, tipo, identificador, status e flag de gift card. Quando a empresa autenticada é a `all` (multi-conta), retorna integrações de todas as empresas vinculadas.", "type": "text/plain" }, "url": { "path": [ "company", "integration" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeCompanyIntegrationCategory", "value": "string", "description": "Filtra por categoria do tipo de integração. Aceita um id único ou uma lista separada por vírgula (ex.: `1,4`). Categorias usuais: 1=Canal de Venda, 2=Gateway, 3=Transportadora, 4=Adquirente, 9=Banco. Outras: 7=ERP, 8=WMS, 10=Hub, 14=Plataformas de e-commerce." }, { "disabled": false, "key": "IDTypeCompanyIntegration", "value": "2232", "description": "Filtra por tipo de integração (`IDTypeCompanyIntegration`). Ex.: 10=Mercado Livre, 16=idworks, 50=Correios, 131=Stark Bank." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "Filtra por identificador específico da integração da empresa." }, { "disabled": false, "key": "Status", "value": "3", "description": "Filtra pelo status da integração: `1`=Ativo, `2`=Erro de autenticação, `3`=Não autenticado, `0`=Inativo." }, { "disabled": false, "key": "GiftCard", "value": "1", "description": "Filtra pela flag `GiftCard` (tipos voltados a vale-presente)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6a47817c-991e-4969-9619-6ba78d6635f7", "name": "Lista de integrações.", "originalRequest": { "url": { "path": [ "company", "integration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegrationCategory", "value": "string" }, { "key": "IDTypeCompanyIntegration", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "Status", "value": "3" }, { "key": "GiftCard", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyIntegration\": 8618,\n \"IDTypeCompanyIntegration\": 5434,\n \"IDTypeCompanyIntegrationCategory\": 8244,\n \"AccountName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"IDSalesChannel\": 7958,\n \"IntegrationLogoUrl\": \"https://m.kxzVQiRTW9dCIH28SVFQGviBc6A0+Y,AY4G1tSaqQC63IWvHyqlhF-K1EQLF1K\",\n \"PathName\": \"string\",\n \"AuthUrl\": 0,\n \"HubPaymentCustom\": 1,\n \"Status\": 1,\n \"ReputationLevel\": \"string\"\n },\n {\n \"IDCompanyIntegration\": 8957,\n \"IDTypeCompanyIntegration\": 5246,\n \"IDTypeCompanyIntegrationCategory\": 7089,\n \"AccountName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"IDSalesChannel\": 3696,\n \"IntegrationLogoUrl\": \"https://wBQi.ynmIh-DtW\",\n \"PathName\": \"string\",\n \"AuthUrl\": 1,\n \"HubPaymentCustom\": 1,\n \"Status\": 3,\n \"ReputationLevel\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3d709bc-4ad4-4f05-b0bc-9b4a403ce0b5", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeCompanyIntegrationCategory", "value": "string" }, { "key": "IDTypeCompanyIntegration", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "Status", "value": "3" }, { "key": "GiftCard", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3db2d6e0-3d34-465d-8811-109b604c832f", "name": "Cria uma integração da empresa", "request": { "name": "Cria uma integração da empresa", "description": { "content": "Cadastra uma nova `CompanyIntegration` para a empresa autenticada, partindo de um tipo (`IDTypeCompanyIntegration`).\n\nO **status inicial** depende do tipo:\n- Se o tipo tem parametrização com `Key = \"Validate\"` no catálogo, a integração nasce com `Status = 3` (**Não Autenticado**). É preciso passar pelo fluxo de autenticação para virar `Ativo`.\n- Caso contrário, nasce com `Status = 1` (**Ativo**) direto.\n\nDevolve o detalhe da integração recém-criada (formato de `GET /company/integration/{idcompanyintegration}`), pronto para preencher as parametrizações.", "type": "text/plain" }, "url": { "path": [ "company", "integration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyIntegration\": 4264,\n \"CompanyIntegrationName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8606ad30-d93d-4e16-a809-a1f4689681e1", "name": "Integração criada. Devolve o detalhe (array de parametrizações, vazio até preencher).", "originalRequest": { "url": { "path": [ "company", "integration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyIntegration\": 4264,\n \"CompanyIntegrationName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeCompanyIntegration\": 5132,\n \"IDTypeCompanyParameters\": 7583,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 1,\n \"ParameterOrder\": 5997,\n \"IDTypeCompanyParametersGroup\": 9537,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n },\n {\n \"IDTypeCompanyIntegration\": 8170,\n \"IDTypeCompanyParameters\": 8392,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 0,\n \"ParameterOrder\": 2427,\n \"IDTypeCompanyParametersGroup\": 8051,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9da2526-93af-4c10-845a-d96e855de226", "name": "Erros de validação. Mensagens: `[BadRequest] - Tipo integração não existe`; `[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "company", "integration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyIntegration\": 4264,\n \"CompanyIntegrationName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "468d81de-ad94-4b72-98d7-8d64e35ba89c", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeCompanyIntegration\": 4264,\n \"CompanyIntegrationName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90d26f74-3cc5-4c66-bee1-e59d1ba39fe8", "name": "Atualiza nome e status de uma integração", "request": { "name": "Atualiza nome e status de uma integração", "description": { "content": "Atualiza o **nome** (`CompanyIntegrationName`) e o **status** (`Status`) da integração. Os outros dados (tipo, parametrizações) ficam intocados.\n\nA resposta repete o detalhe da integração (mesmo formato do `GET`).", "type": "text/plain" }, "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CompanyIntegrationName\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6d715a95-b709-453a-bd8f-6572e4f5903d", "name": "Integração atualizada.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CompanyIntegrationName\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeCompanyIntegration\": 930,\n \"IDTypeCompanyParameters\": 5989,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 0,\n \"ParameterOrder\": 3189,\n \"IDTypeCompanyParametersGroup\": 4376,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n },\n {\n \"IDTypeCompanyIntegration\": 8595,\n \"IDTypeCompanyParameters\": 5950,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 1,\n \"ParameterOrder\": 8973,\n \"IDTypeCompanyParametersGroup\": 1557,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd2b13d0-1cf0-4ab5-90ed-2215932ea32c", "name": "Integração não encontrada. Mensagem: `[BadRequest] - Integração não existe`.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CompanyIntegrationName\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af541b4-f3e5-4d75-92ab-cdb1acc3655c", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CompanyIntegrationName\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "095e3ab3-8a47-4079-b448-34fadf9c45e7", "name": "Exclui (inativa) uma integração", "request": { "name": "Exclui (inativa) uma integração", "description": { "content": "Inativa a integração (`Status = 0`, `Show = 0`) e **remove fisicamente**:\n- Todas as parametrizações (`CompanyParameters`).\n- Todos os mapas de Hub (`HubCategory`, `HubBrand`, `HubCarrier`, `HubPayment`, `HubSalesPolicy`, `HubVariation`, `HubWarehouse`).\n\nExclusão é **bloqueada** por categoria:\n- **Transportadora** (categoria 3): bloqueia quando há fornecedor ativo com esta integração — fornecedores inativos são desvinculados (limpa `IDCompanyIntegration`).\n- **Gateway / Adquirente / Banco** (categorias 2, 4, 9 — respectivamente Gateway, Adquirente, Banco): bloqueia quando há conta bancária ativa vinculada — contas inativas são desvinculadas.\n- **Anúncios**: bloqueia quando há `HubProduct` apontando para esta integração — é preciso excluir os anúncios antes.\n\nA resposta é a lista atualizada das integrações (mesmo formato do `GET /company/integration`).", "type": "text/plain" }, "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "a4bce484-e513-45cd-bb2a-172e8b673596", "name": "Integração inativada. Devolve a lista atualizada.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyIntegration\": 8618,\n \"IDTypeCompanyIntegration\": 5434,\n \"IDTypeCompanyIntegrationCategory\": 8244,\n \"AccountName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"IDSalesChannel\": 7958,\n \"IntegrationLogoUrl\": \"https://m.kxzVQiRTW9dCIH28SVFQGviBc6A0+Y,AY4G1tSaqQC63IWvHyqlhF-K1EQLF1K\",\n \"PathName\": \"string\",\n \"AuthUrl\": 0,\n \"HubPaymentCustom\": 1,\n \"Status\": 1,\n \"ReputationLevel\": \"string\"\n },\n {\n \"IDCompanyIntegration\": 8957,\n \"IDTypeCompanyIntegration\": 5246,\n \"IDTypeCompanyIntegrationCategory\": 7089,\n \"AccountName\": \"string\",\n \"CompanyIntegrationName\": \"string\",\n \"IntegrationName\": \"string\",\n \"SalesChannelName\": \"string\",\n \"IDSalesChannel\": 3696,\n \"IntegrationLogoUrl\": \"https://wBQi.ynmIh-DtW\",\n \"PathName\": \"string\",\n \"AuthUrl\": 1,\n \"HubPaymentCustom\": 1,\n \"Status\": 3,\n \"ReputationLevel\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6204d35-1086-4240-bebf-97e507ee61d9", "name": "Integração não encontrada ou bloqueada por vínculo. Mensagens: `[BadRequest] - Integração não existe`; `[BadRequest] - Existe fornecedor vinculado a essa integração, remover antes de excluir a integração`; `[BadRequest] - Existe conta bancária vinculada a essa integração, remover antes de excluir a integração`; `[BadRequest] - Integração possui anúncios, excluir antes de deletar a integração`.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f641e559-3825-48c9-8641-a18c7ad434a9", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "880c4a4c-cba5-4f90-9404-168d3ebe07a4", "name": "Verifica credenciais de uma integração", "request": { "name": "Verifica credenciais de uma integração", "description": { "content": "Faz uma checagem síncrona das credenciais configuradas para a integração no sistema externo. A verificação é roteada conforme o tipo da integração — Correios (tipo 50), E-mail (tipo 51) e os demais canais de venda, cada um pelo seu conector próprio.\n\nA resposta é o que o serviço de integração devolver — geralmente um JSON com `Status`, `Message` e detalhes do diagnóstico. Use para confirmar, antes de salvar parametrizações, que as credenciais respondem ao canal externo.", "type": "text/plain" }, "url": { "path": [ "company", "integration", ":idcompanyintegration", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "046f5651-a8bd-41c1-b40c-2422d12f535b", "name": "Resultado da checagem retornado pelo serviço de integração (formato varia por integração).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 216,\n \"key_1\": 6839.884845202689,\n \"key_2\": 4377,\n \"key_3\": 6093.401641468752\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03e23277-789b-41c9-82f5-408f13fe97fa", "name": "Falha de roteamento ou integração inválida. Mensagens: `[BadRequest] - Integração não encontrada`; `[BadRequest] - Integracão não tem consulta de status` (tipo não suporta check ou serviço de integração devolveu 404); mensagem do serviço de integração em outros casos.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06b7626e-550f-4c0e-a831-84aab215623a", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1935f7f-134d-44af-8804-3cce6af00ca2", "name": "Lista as parametrizações da integração", "request": { "name": "Lista as parametrizações da integração", "description": { "content": "Devolve o catálogo de parametrizações do tipo da integração cruzado com os valores já gravados pela empresa — é o que a tela usa para montar o formulário de configuração, agrupado por `TypeCompanyParametersGroup`.\n\nDetalhes do retorno:\n\n- Só vêm parametrizações com `Type` diferente de `hidden`, ordenadas por `ParameterOrder`.\n- Para `Type` `list`/`multi_list`, o campo `List` traz as opções disponíveis (itens de tabelas-tipo, planos de contas, contas bancárias, status, etc., conforme a `Key`).\n- Para `Type` `string_copy`/`url_get`, o campo `Value` pode ser **calculado** (ex.: URL de webhook/leilão de frete personalizada para a empresa, com tokens embutidos), em vez do valor cru gravado.\n\n**Modo alternativo** — quando `Type=ImportOffer`, o endpoint não retorna parametrizações: devolve o último job de importação de anúncios da integração com o progresso (`QuantityProcessed`, `QuantityPending`, `QuantityTotal`).", "type": "text/plain" }, "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "string", "description": "Modo de consulta. Em branco (padrão) retorna as parametrizações. Com `ImportOffer`, retorna o progresso do último job de importação de anúncios da integração." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4c0c9bf4-cff5-46c9-8c08-0d69350a19e5", "name": "No modo padrão: lista de parametrizações da integração. Array vazio quando não há registros.\n\nCom `Type=ImportOffer` os itens têm forma completamente diferente — são registros do último job de importação de anúncios da integração (identificador e tipo do job, datas de início e término, arquivo e o `Login` do usuário que disparou), acrescidos de `QuantityProcessed` (linhas já processadas), `QuantityPending` (linhas ainda na fila) e `QuantityTotal` (soma das duas). Também devolve array vazio quando não há registro.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeCompanyIntegration\": 930,\n \"IDTypeCompanyParameters\": 5989,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 0,\n \"ParameterOrder\": 3189,\n \"IDTypeCompanyParametersGroup\": 4376,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n },\n {\n \"IDTypeCompanyIntegration\": 8595,\n \"IDTypeCompanyParameters\": 5950,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 1,\n \"ParameterOrder\": 8973,\n \"IDTypeCompanyParametersGroup\": 1557,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d8d4c8-cf20-4f88-848b-80668cbb76a3", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43c00746-47a6-4412-b772-8f2ae533dea2", "name": "Atualiza as parametrizações da integração", "request": { "name": "Atualiza as parametrizações da integração", "description": { "content": "Sobrescreve (upsert) os valores das parametrizações da integração. O body é um **array** de `{Key, Value}`. Para cada item:\n\n1. Valida que a `Key` é uma parametrização válida do tipo da integração (`TypeCompanyParameters` com `Type` diferente de `hidden`, `string_copy` e `url_validate`).\n2. Faz upsert em `CompanyParameters` (chave única `IDCompanyIntegration + Key`).\n3. Grava o evento em `CompanyParametersLog` com o usuário autenticado e o body inteiro como `Data`.\n\nNão é necessário enviar todas as parametrizações — só as que mudaram. A resposta é o detalhe atualizado (mesmo formato do `GET`).", "type": "text/plain" }, "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n },\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de93fa55-ec60-483e-be50-2256b4f5fb13", "name": "Parametrizações atualizadas.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n },\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDTypeCompanyIntegration\": 930,\n \"IDTypeCompanyParameters\": 5989,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 0,\n \"ParameterOrder\": 3189,\n \"IDTypeCompanyParametersGroup\": 4376,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n },\n {\n \"IDTypeCompanyIntegration\": 8595,\n \"IDTypeCompanyParameters\": 5950,\n \"Key\": \"string\",\n \"KeyName\": \"string\",\n \"Description\": \"string\",\n \"Type\": \"string\",\n \"Required\": 1,\n \"ParameterOrder\": 8973,\n \"IDTypeCompanyParametersGroup\": 1557,\n \"TypeCompanyParametersGroup\": \"string\",\n \"Value\": \"string\",\n \"List\": [\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n },\n {\n \"Value\": \"string\",\n \"Label\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c1f9682-547d-433d-9453-f5344677f2a8", "name": "Integração não encontrada. Mensagem: `[BadRequest] - Integração não existe`.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n },\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0507ed44-6381-43ee-8f0b-ac458bf0eb10", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n },\n {\n \"Key\": \"string\",\n \"Value\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d12ca43-1c30-497d-8f64-d7cf9535dd9d", "name": "Dispara importação automática de anúncios", "request": { "name": "Dispara importação automática de anúncios", "description": { "content": "Dispara a importação automática de anúncios do canal de venda configurado (`idcompanyintegration`), repassando os demais parâmetros recebidos na query. Usado pela tela de importação direto do canal para popular a área temporária de produtos importados da integração.\n\nA resposta é o que o serviço de integração devolver (geralmente confirmação de enfileiramento).", "type": "text/plain" }, "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "6b19c566-f19a-4b7e-be63-99992d4dece7", "name": "Resposta do serviço de integração (formato varia).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": \"string\",\n \"key_1\": 8204.2638103615\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d90efae7-2f29-413c-93db-0ff4638d91c7", "name": "Falha do serviço de integração. Devolve o `errorMessage` recebido.", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bf42a22-d1b9-4068-89eb-976d7e263aab", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "integration", ":idcompanyintegration", "parameter", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanyintegration", "description": "(Required) Identificador da integração." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4c054a51-22d6-44e7-9f39-cb57080c9211", "name": "Inventário", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5bd715dc-a7d8-46f6-86b2-ecd1a918068d", "name": "Lista inventários", "request": { "name": "Lista inventários", "description": { "content": "Lista inventários da empresa, do mais recente para o mais antigo, paginada em blocos de 2000 (use `Page`). Os filtros são aplicados via query string. O filtro de **colaborador** considera o usuário em qualquer uma das três conferências.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Número da página (cada página tem 2000 registros). Quando omitido, vale `0`." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial do intervalo (filtro pela criação do inventário, `RecordTimestamp`)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final do intervalo. O sistema adiciona `23:59:59` ao valor." }, { "disabled": false, "key": "IDStockKeepingUnitInventorySummary", "value": "2232", "description": "Filtra pelo código do inventário." }, { "disabled": false, "key": "IDTypeStatusSkuInventory", "value": "2232", "description": "Status do inventário. Aceita lista separada por vírgula." }, { "disabled": false, "key": "IDStockKeepingUnitDistributionCenter", "value": "2232", "description": "Centro de distribuição." }, { "disabled": false, "key": "IDStockKeepingUnitWarehouse", "value": "2232", "description": "Armazém." }, { "disabled": false, "key": "RecordUserStart", "value": "2232", "description": "Colaborador atribuído (busca em qualquer uma das três conferências)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5a8f0e5a-9de9-4071-8b11-c4df410b3a6e", "name": "Lista de inventários.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDStockKeepingUnitInventorySummary", "value": "2232" }, { "key": "IDTypeStatusSkuInventory", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "2232" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "RecordUserStart", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitInventorySummary\": 8123,\n \"AccountName\": \"string\",\n \"IDCompany\": 756,\n \"IDStockKeepingUnitDistributionCenter\": 3678,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 1412,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 2,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 2,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 2,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 9964,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"1965-03-28T15:20:20.850Z\",\n \"InventoryFirstFinishTimestamp\": \"1963-03-31T04:59:48.002Z\",\n \"InventorySecondUserStart\": 5866,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"2013-09-25T22:20:47.201Z\",\n \"InventorySecondFinishTimestamp\": \"2025-11-04T12:34:48.108Z\",\n \"InventoryThirdUserStart\": 5989,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"2000-07-29T03:18:39.785Z\",\n \"InventoryThirdFinishTimestamp\": \"1996-01-17T09:06:45.633Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"1951-12-19T15:23:49.678Z\",\n \"RecordTimestamp\": \"1991-12-26T20:01:28.175Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 6898,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 3674\n },\n {\n \"IDStockKeepingUnitInventorySummary\": 1381,\n \"AccountName\": \"string\",\n \"IDCompany\": 7750,\n \"IDStockKeepingUnitDistributionCenter\": 2699,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 9992,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 2,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 8,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 2,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 3944,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"2002-03-05T23:13:12.381Z\",\n \"InventoryFirstFinishTimestamp\": \"1962-11-19T05:00:28.726Z\",\n \"InventorySecondUserStart\": 732,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"1999-03-02T15:05:02.432Z\",\n \"InventorySecondFinishTimestamp\": \"1958-11-10T07:51:44.793Z\",\n \"InventoryThirdUserStart\": 1532,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"2026-07-31T12:01:34.491Z\",\n \"InventoryThirdFinishTimestamp\": \"1993-10-30T21:45:34.431Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"1967-11-13T13:20:35.359Z\",\n \"RecordTimestamp\": \"1992-02-16T11:18:37.353Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 6069,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 7413\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91d6d72b-2f98-4f2b-80f9-7a1378bbb34c", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDStockKeepingUnitInventorySummary", "value": "2232" }, { "key": "IDTypeStatusSkuInventory", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "2232" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "RecordUserStart", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c394adb-fe7f-4b5c-b4d9-aea9d9ab3ac2", "name": "Cria inventário", "request": { "name": "Cria inventário", "description": { "content": "Cria um inventário no status `2` (Aberto) e devolve o inventário completo já criado. Valida o armazém (precisa estar ativo e pertencer à empresa), o tipo de inventário, o centro de distribuição e a política de quantidade. A criação fica registrada no histórico do inventário.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitWarehouse\": 1536,\n \"IDStockKeepingUnitDistributionCenter\": 1538,\n \"IDTypeInventorySummary\": 4,\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0fbaf53-a1da-4f6f-9be5-5cd90d48e78a", "name": "Inventário criado. A resposta é o mesmo objeto do detalhe do inventário: já traz `ItemsCount`, `HasNextPageItems` (sempre `0` na criação) e `InventoryLogs` com a entrada `Inventário criado`. `Items` e as filas de SKUs e de endereços vêm vazias.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitWarehouse\": 1536,\n \"IDStockKeepingUnitDistributionCenter\": 1538,\n \"IDTypeInventorySummary\": 4,\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitInventorySummary\": 753,\n \"AccountName\": \"string\",\n \"IDCompany\": 5323,\n \"IDStockKeepingUnitDistributionCenter\": 9046,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 1232,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 4,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 6,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 4418,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"2025-03-21T11:59:23.281Z\",\n \"InventoryFirstFinishTimestamp\": \"2008-07-22T01:11:30.534Z\",\n \"InventorySecondUserStart\": 7610,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"1983-04-25T21:22:18.502Z\",\n \"InventorySecondFinishTimestamp\": \"1957-09-15T20:17:08.589Z\",\n \"InventoryThirdUserStart\": 188,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"1978-05-20T07:29:27.764Z\",\n \"InventoryThirdFinishTimestamp\": \"1987-10-08T17:32:38.218Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"1948-08-02T16:39:12.809Z\",\n \"RecordTimestamp\": \"2010-02-09T13:13:53.752Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 9253,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 5715,\n \"TypeInventorySummaryQuantity\": \"string\",\n \"Items\": [\n {\n \"IDStockKeepingUnitInventoryItems\": 7445,\n \"IDSku\": 144,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 1109,\n \"RastroControl\": 3100,\n \"BatchRequired\": 7117,\n \"BestBeforeRequired\": 5777,\n \"QuantityBatch\": 3769.987786291222,\n \"QuantityInventory\": 8042.252154757348,\n \"QuantityInventorySecond\": 4158.719920183802,\n \"QuantityInventoryThird\": 1953.9307669751738,\n \"QuantityInventoryDiff\": 9667.423122208973,\n \"QuantityInventorySecondDiff\": 5517.240066864079,\n \"QuantityInventoryThirdDiff\": 6655.903907335026,\n \"IDBatch\": 2177,\n \"BestBeforeDate\": \"1999-12-02\",\n \"ManufacturingDate\": \"1970-04-12\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 2641,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 1867,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 6167,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5566.586403653107\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 9352,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8224.477677332949\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 6512,\n \"IDSku\": 210,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7463,\n \"RastroControl\": 3029,\n \"BatchRequired\": 9313,\n \"BestBeforeRequired\": 8971,\n \"QuantityBatch\": 8150.353860027195,\n \"QuantityInventory\": 5119.8575644615985,\n \"QuantityInventorySecond\": 3861.412131652291,\n \"QuantityInventoryThird\": 4574.531745141164,\n \"QuantityInventoryDiff\": 9273.423032876544,\n \"QuantityInventorySecondDiff\": 4855.95755306618,\n \"QuantityInventoryThirdDiff\": 5932.2311879093295,\n \"IDBatch\": 5964,\n \"BestBeforeDate\": \"2002-08-29\",\n \"ManufacturingDate\": \"1979-07-02\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 6056,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 479,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 6162,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3108.9601195403006\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 233,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 6094.660208905032\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummarySkuQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 9011,\n \"IDSku\": 3605,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 3960,\n \"IDSku\": 523,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummaryLocationQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 9446,\n \"IDStockKeepingUnitLocation\": 1879,\n \"Address\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 8783,\n \"IDStockKeepingUnitLocation\": 181,\n \"Address\": \"string\"\n }\n ],\n \"ItemsCount\": 7056,\n \"HasNextPageItems\": 0,\n \"InventoryLogs\": [\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 2507,\n \"IDStockKeepingUnitInventorySummary\": 6862,\n \"Data\": \"string\",\n \"RecordUserCreated\": 1112,\n \"RecordTimestamp\": \"1976-12-05T13:05:27.852Z\",\n \"Login\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 1884,\n \"IDStockKeepingUnitInventorySummary\": 5018,\n \"Data\": \"string\",\n \"RecordUserCreated\": 7318,\n \"RecordTimestamp\": \"1991-11-30T14:35:33.795Z\",\n \"Login\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitInventorySummary\": 6898,\n \"AccountName\": \"string\",\n \"IDCompany\": 2706,\n \"IDStockKeepingUnitDistributionCenter\": 3594,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 7730,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 3,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 9,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 3807,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"1990-11-28T02:33:24.813Z\",\n \"InventoryFirstFinishTimestamp\": \"1955-10-31T23:05:17.617Z\",\n \"InventorySecondUserStart\": 9105,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"2004-07-24T19:45:22.593Z\",\n \"InventorySecondFinishTimestamp\": \"2011-04-22T11:10:49.379Z\",\n \"InventoryThirdUserStart\": 443,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"2026-04-18T16:40:02.645Z\",\n \"InventoryThirdFinishTimestamp\": \"1968-07-06T13:32:11.108Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"2008-01-21T06:31:28.722Z\",\n \"RecordTimestamp\": \"2021-10-30T04:32:47.715Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 6045,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 1490,\n \"TypeInventorySummaryQuantity\": \"string\",\n \"Items\": [\n {\n \"IDStockKeepingUnitInventoryItems\": 6376,\n \"IDSku\": 1076,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7255,\n \"RastroControl\": 7689,\n \"BatchRequired\": 7363,\n \"BestBeforeRequired\": 9597,\n \"QuantityBatch\": 8660.712377200744,\n \"QuantityInventory\": 7976.921833341082,\n \"QuantityInventorySecond\": 8692.533392283152,\n \"QuantityInventoryThird\": 4317.099617133237,\n \"QuantityInventoryDiff\": 395.8856922959897,\n \"QuantityInventorySecondDiff\": 875.6443582380014,\n \"QuantityInventoryThirdDiff\": 1397.32137045244,\n \"IDBatch\": 1227,\n \"BestBeforeDate\": \"1958-05-19\",\n \"ManufacturingDate\": \"1988-01-13\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 3882,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 1867,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 1951,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8501.734141476503\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 1132,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 556.3263234045768\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 4735,\n \"IDSku\": 9332,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 371,\n \"RastroControl\": 7299,\n \"BatchRequired\": 8870,\n \"BestBeforeRequired\": 7488,\n \"QuantityBatch\": 6205.628781887244,\n \"QuantityInventory\": 8785.484038472225,\n \"QuantityInventorySecond\": 902.1384268202381,\n \"QuantityInventoryThird\": 2912.7408699268176,\n \"QuantityInventoryDiff\": 3260.7344615172005,\n \"QuantityInventorySecondDiff\": 2383.087626368734,\n \"QuantityInventoryThirdDiff\": 1188.7428651804166,\n \"IDBatch\": 1967,\n \"BestBeforeDate\": \"2015-04-25\",\n \"ManufacturingDate\": \"2001-09-25\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 5644,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 4254,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 5262,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 617.9699448204557\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 7335,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 4563.363623317418\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummarySkuQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 3757,\n \"IDSku\": 2804,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 6569,\n \"IDSku\": 5854,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummaryLocationQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 8302,\n \"IDStockKeepingUnitLocation\": 383,\n \"Address\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 898,\n \"IDStockKeepingUnitLocation\": 2384,\n \"Address\": \"string\"\n }\n ],\n \"ItemsCount\": 7601,\n \"HasNextPageItems\": 1,\n \"InventoryLogs\": [\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 3171,\n \"IDStockKeepingUnitInventorySummary\": 5128,\n \"Data\": \"string\",\n \"RecordUserCreated\": 7337,\n \"RecordTimestamp\": \"1990-01-18T01:59:43.142Z\",\n \"Login\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 3337,\n \"IDStockKeepingUnitInventorySummary\": 1081,\n \"Data\": \"string\",\n \"RecordUserCreated\": 2574,\n \"RecordTimestamp\": \"1967-08-25T10:20:56.445Z\",\n \"Login\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f6e593-97d6-402b-9fc9-92d957070a39", "name": "`[BadRequest] - Empresa não existe`, `Armazém não localizado`, `Armazém deve ser informado`, `Tipo inventário não existe`, `Centro de distribuição não existe`, `Tipo quantidade (contagem) inventário não existe`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitWarehouse\": 1536,\n \"IDStockKeepingUnitDistributionCenter\": 1538,\n \"IDTypeInventorySummary\": 4,\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acb7ffa4-5867-433f-bb5e-9b6ee3987a72", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitWarehouse\": 1536,\n \"IDStockKeepingUnitDistributionCenter\": 1538,\n \"IDTypeInventorySummary\": 4,\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b59b297-bb7f-48ff-95f4-49bd911defb2", "name": "Detalha inventário", "request": { "name": "Detalha inventário", "description": { "content": "Retorna o inventário completo com os itens contados (`Items`), a fila de SKUs (`StockKeepingUnitInventorySummarySkuQueue`), a fila de endereços (`StockKeepingUnitInventorySummaryLocationQueue`) e o histórico de alterações (`InventoryLogs`). Os itens vêm paginados em blocos de 5000 — use `Page` e acompanhe `HasNextPageItems` para saber se há mais páginas; `ItemsCount` traz o total. Cada item traz as diferenças `QuantityInventoryDiff`, `QuantityInventorySecondDiff` e `QuantityInventoryThirdDiff` em relação ao saldo do lote. A fila de endereços é devolvida ordenada por `Address`, em ordem alfanumérica natural.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Draft", "value": "1", "description": "Quando `1`, devolve o **rascunho** salvo (TTL 4 dias) em vez de consultar o banco." }, { "disabled": false, "key": "Page", "value": "4675", "description": "Página dos itens contados (`Items`), com 5000 itens por página. Quando omitido, vale `0`. As filas de SKUs e de endereços, o histórico e os totais não são paginados — vêm completos em toda página." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0640e7f9-8b80-407e-b29a-a2894384a8a3", "name": "Inventário ou lista vazia (`[]`) quando não localizado. Com `Draft=1`, devolve o rascunho salvo tal como foi enviado no lançamento de contagem, sem passar pelo formato do detalhe; quando não há rascunho gravado, a resposta vem vazia (`null`).", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Draft", "value": "1" }, { "key": "Page", "value": "4675" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitInventorySummary\": 6419,\n \"AccountName\": \"string\",\n \"IDCompany\": 6054,\n \"IDStockKeepingUnitDistributionCenter\": 1635,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 4227,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 4,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 2,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 3,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 4230,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"2026-09-20T21:09:21.330Z\",\n \"InventoryFirstFinishTimestamp\": \"2010-07-27T07:20:10.221Z\",\n \"InventorySecondUserStart\": 6884,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"1959-02-12T13:36:36.082Z\",\n \"InventorySecondFinishTimestamp\": \"1949-04-15T06:21:32.227Z\",\n \"InventoryThirdUserStart\": 5157,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"2007-05-28T04:28:36.773Z\",\n \"InventoryThirdFinishTimestamp\": \"1971-08-20T00:34:07.863Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"1985-01-02T00:54:21.433Z\",\n \"RecordTimestamp\": \"1957-06-26T22:45:12.099Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 5179,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 9711,\n \"TypeInventorySummaryQuantity\": \"string\",\n \"Items\": [\n {\n \"IDStockKeepingUnitInventoryItems\": 3506,\n \"IDSku\": 5331,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7751,\n \"RastroControl\": 4640,\n \"BatchRequired\": 1555,\n \"BestBeforeRequired\": 7448,\n \"QuantityBatch\": 7624.733840828457,\n \"QuantityInventory\": 3088.1026878097773,\n \"QuantityInventorySecond\": 2261.725208883598,\n \"QuantityInventoryThird\": 2690.8028860024947,\n \"QuantityInventoryDiff\": 5749.255468897949,\n \"QuantityInventorySecondDiff\": 8479.235034133379,\n \"QuantityInventoryThirdDiff\": 4300.409074963279,\n \"IDBatch\": 721,\n \"BestBeforeDate\": \"2025-06-26\",\n \"ManufacturingDate\": \"1959-05-24\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 844,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 7468,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 8444,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7902.688448774875\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 7837,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 2827.5717624728804\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 1350,\n \"IDSku\": 5154,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 6602,\n \"RastroControl\": 8656,\n \"BatchRequired\": 5784,\n \"BestBeforeRequired\": 4973,\n \"QuantityBatch\": 7326.966901190785,\n \"QuantityInventory\": 90.31019946387664,\n \"QuantityInventorySecond\": 5963.50156660342,\n \"QuantityInventoryThird\": 959.2091757226929,\n \"QuantityInventoryDiff\": 9598.556245240326,\n \"QuantityInventorySecondDiff\": 1890.1299281545048,\n \"QuantityInventoryThirdDiff\": 8926.521904908004,\n \"IDBatch\": 5291,\n \"BestBeforeDate\": \"2020-01-08\",\n \"ManufacturingDate\": \"1974-10-14\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 8253,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 5894,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 3163,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 6276.211205528874\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 9337,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 4378.573625372648\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummarySkuQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 5910,\n \"IDSku\": 9884,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 8402,\n \"IDSku\": 7964,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummaryLocationQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 8417,\n \"IDStockKeepingUnitLocation\": 5493,\n \"Address\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 1439,\n \"IDStockKeepingUnitLocation\": 701,\n \"Address\": \"string\"\n }\n ],\n \"ItemsCount\": 480,\n \"HasNextPageItems\": 0,\n \"InventoryLogs\": [\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 4349,\n \"IDStockKeepingUnitInventorySummary\": 2773,\n \"Data\": \"string\",\n \"RecordUserCreated\": 3566,\n \"RecordTimestamp\": \"1975-03-22T00:27:28.605Z\",\n \"Login\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 8700,\n \"IDStockKeepingUnitInventorySummary\": 3519,\n \"Data\": \"string\",\n \"RecordUserCreated\": 4724,\n \"RecordTimestamp\": \"1972-01-10T18:57:03.242Z\",\n \"Login\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitInventorySummary\": 1753,\n \"AccountName\": \"string\",\n \"IDCompany\": 512,\n \"IDStockKeepingUnitDistributionCenter\": 7611,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 5588,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 2,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 1,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 9678,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"2008-11-25T19:09:00.584Z\",\n \"InventoryFirstFinishTimestamp\": \"1959-02-17T09:00:34.909Z\",\n \"InventorySecondUserStart\": 1284,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"1977-03-04T05:14:20.824Z\",\n \"InventorySecondFinishTimestamp\": \"1969-03-05T22:09:01.350Z\",\n \"InventoryThirdUserStart\": 9603,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"1980-08-28T08:05:03.230Z\",\n \"InventoryThirdFinishTimestamp\": \"2026-08-12T01:54:38.795Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"2013-11-04T11:23:08.719Z\",\n \"RecordTimestamp\": \"1987-02-11T17:22:03.346Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 3708,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 1214,\n \"TypeInventorySummaryQuantity\": \"string\",\n \"Items\": [\n {\n \"IDStockKeepingUnitInventoryItems\": 3623,\n \"IDSku\": 3125,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7556,\n \"RastroControl\": 5957,\n \"BatchRequired\": 7398,\n \"BestBeforeRequired\": 4411,\n \"QuantityBatch\": 6785.592563740554,\n \"QuantityInventory\": 9392.97238803477,\n \"QuantityInventorySecond\": 2776.90193072615,\n \"QuantityInventoryThird\": 5152.3517637062,\n \"QuantityInventoryDiff\": 6963.3904654769285,\n \"QuantityInventorySecondDiff\": 3782.2000963082214,\n \"QuantityInventoryThirdDiff\": 8439.285606674362,\n \"IDBatch\": 1651,\n \"BestBeforeDate\": \"1981-05-07\",\n \"ManufacturingDate\": \"1982-12-24\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 4193,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 3359,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 3341,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5625.694692463559\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 150,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 6649.55123068607\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 8028,\n \"IDSku\": 2254,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7400,\n \"RastroControl\": 2488,\n \"BatchRequired\": 4716,\n \"BestBeforeRequired\": 4896,\n \"QuantityBatch\": 9526.46656345637,\n \"QuantityInventory\": 6297.112526318791,\n \"QuantityInventorySecond\": 9644.520789903783,\n \"QuantityInventoryThird\": 874.9636731511612,\n \"QuantityInventoryDiff\": 5067.558387446427,\n \"QuantityInventorySecondDiff\": 7879.124586957629,\n \"QuantityInventoryThirdDiff\": 2345.4388889602674,\n \"IDBatch\": 7739,\n \"BestBeforeDate\": \"2019-08-24\",\n \"ManufacturingDate\": \"1996-02-01\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 5402,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 7812,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 8747,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 4551.148648998742\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 3951,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 1570.8061291433783\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummarySkuQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 5683,\n \"IDSku\": 3003,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 6785,\n \"IDSku\": 9583,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummaryLocationQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 6273,\n \"IDStockKeepingUnitLocation\": 5248,\n \"Address\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 1038,\n \"IDStockKeepingUnitLocation\": 5286,\n \"Address\": \"string\"\n }\n ],\n \"ItemsCount\": 3996,\n \"HasNextPageItems\": 1,\n \"InventoryLogs\": [\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 4952,\n \"IDStockKeepingUnitInventorySummary\": 535,\n \"Data\": \"string\",\n \"RecordUserCreated\": 9186,\n \"RecordTimestamp\": \"1989-12-17T19:16:46.721Z\",\n \"Login\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 927,\n \"IDStockKeepingUnitInventorySummary\": 2761,\n \"Data\": \"string\",\n \"RecordUserCreated\": 3299,\n \"RecordTimestamp\": \"1968-10-03T08:07:22.583Z\",\n \"Login\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eca0c142-ddc6-4d3c-a9fc-70c1d3af03ae", "name": "Atualiza inventário", "request": { "name": "Atualiza inventário", "description": { "content": "Atualiza o cabeçalho do inventário. Usado para:\n\n- **Encerrar uma conferência** — `IDTypeStatusSkuInventory = 6` finaliza a 1ª, `7` a 2ª, `8` a 3ª. Cada transição grava o horário correspondente e registra a conferência finalizada no histórico. Repetir uma finalização já feita é rejeitado.\n- **Atribuir colaborador** — `InventorySecondUserStart` exige o inventário no status `6` e `InventoryThirdUserStart` exige o status `7`; fora disso a requisição é rejeitada. `InventoryStartUser` só é aplicado enquanto o status for menor que `6` — em status maior, o campo é ignorado sem erro. O usuário precisa estar ativo na empresa.\n\nAo finalizar a **1ª conferência** de um inventário do tipo Auditoria (`IDTypeInventorySummary = 4`) que tenha SKUs na fila de contagem, o sistema inclui automaticamente, com quantidade `0`, os lotes desses SKUs no armazém que ainda tinham saldo e não foram contados, registrando a inclusão no histórico.\n\nNão é possível atualizar inventários Finalizados (`1`) ou Cancelados (`4`).", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypeStatusSkuInventory\": 7,\n \"InventoryStartUser\": 9496,\n \"InventorySecondUserStart\": 584,\n \"InventoryThirdUserStart\": 6772\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "97c6bbe2-4b8b-4643-ad36-7a3b4cfe251b", "name": "Inventário atualizado (mesmo formato de `GET /sku/inventory-summary/{id}`), já com `ItemsCount`, `HasNextPageItems` e `InventoryLogs`. Como o detalhe passou a ser paginado, `Items` traz no máximo 5000 registros — sempre a primeira página, já que este endpoint não aceita paginação.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypeStatusSkuInventory\": 7,\n \"InventoryStartUser\": 9496,\n \"InventorySecondUserStart\": 584,\n \"InventoryThirdUserStart\": 6772\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitInventorySummary\": 6419,\n \"AccountName\": \"string\",\n \"IDCompany\": 6054,\n \"IDStockKeepingUnitDistributionCenter\": 1635,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 4227,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 4,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 2,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 3,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 4230,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"2026-09-20T21:09:21.330Z\",\n \"InventoryFirstFinishTimestamp\": \"2010-07-27T07:20:10.221Z\",\n \"InventorySecondUserStart\": 6884,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"1959-02-12T13:36:36.082Z\",\n \"InventorySecondFinishTimestamp\": \"1949-04-15T06:21:32.227Z\",\n \"InventoryThirdUserStart\": 5157,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"2007-05-28T04:28:36.773Z\",\n \"InventoryThirdFinishTimestamp\": \"1971-08-20T00:34:07.863Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"1985-01-02T00:54:21.433Z\",\n \"RecordTimestamp\": \"1957-06-26T22:45:12.099Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 5179,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 9711,\n \"TypeInventorySummaryQuantity\": \"string\",\n \"Items\": [\n {\n \"IDStockKeepingUnitInventoryItems\": 3506,\n \"IDSku\": 5331,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7751,\n \"RastroControl\": 4640,\n \"BatchRequired\": 1555,\n \"BestBeforeRequired\": 7448,\n \"QuantityBatch\": 7624.733840828457,\n \"QuantityInventory\": 3088.1026878097773,\n \"QuantityInventorySecond\": 2261.725208883598,\n \"QuantityInventoryThird\": 2690.8028860024947,\n \"QuantityInventoryDiff\": 5749.255468897949,\n \"QuantityInventorySecondDiff\": 8479.235034133379,\n \"QuantityInventoryThirdDiff\": 4300.409074963279,\n \"IDBatch\": 721,\n \"BestBeforeDate\": \"2025-06-26\",\n \"ManufacturingDate\": \"1959-05-24\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 844,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 7468,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 8444,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7902.688448774875\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 7837,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 2827.5717624728804\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 1350,\n \"IDSku\": 5154,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 6602,\n \"RastroControl\": 8656,\n \"BatchRequired\": 5784,\n \"BestBeforeRequired\": 4973,\n \"QuantityBatch\": 7326.966901190785,\n \"QuantityInventory\": 90.31019946387664,\n \"QuantityInventorySecond\": 5963.50156660342,\n \"QuantityInventoryThird\": 959.2091757226929,\n \"QuantityInventoryDiff\": 9598.556245240326,\n \"QuantityInventorySecondDiff\": 1890.1299281545048,\n \"QuantityInventoryThirdDiff\": 8926.521904908004,\n \"IDBatch\": 5291,\n \"BestBeforeDate\": \"2020-01-08\",\n \"ManufacturingDate\": \"1974-10-14\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 8253,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 5894,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 3163,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 6276.211205528874\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 9337,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 4378.573625372648\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummarySkuQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 5910,\n \"IDSku\": 9884,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 8402,\n \"IDSku\": 7964,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummaryLocationQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 8417,\n \"IDStockKeepingUnitLocation\": 5493,\n \"Address\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 1439,\n \"IDStockKeepingUnitLocation\": 701,\n \"Address\": \"string\"\n }\n ],\n \"ItemsCount\": 480,\n \"HasNextPageItems\": 0,\n \"InventoryLogs\": [\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 4349,\n \"IDStockKeepingUnitInventorySummary\": 2773,\n \"Data\": \"string\",\n \"RecordUserCreated\": 3566,\n \"RecordTimestamp\": \"1975-03-22T00:27:28.605Z\",\n \"Login\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 8700,\n \"IDStockKeepingUnitInventorySummary\": 3519,\n \"Data\": \"string\",\n \"RecordUserCreated\": 4724,\n \"RecordTimestamp\": \"1972-01-10T18:57:03.242Z\",\n \"Login\": \"string\"\n }\n ]\n },\n {\n \"IDStockKeepingUnitInventorySummary\": 1753,\n \"AccountName\": \"string\",\n \"IDCompany\": 512,\n \"IDStockKeepingUnitDistributionCenter\": 7611,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 5588,\n \"WarehouseName\": \"string\",\n \"IDTypeInventorySummary\": 2,\n \"TypeInventorySummary\": \"string\",\n \"IDTypeStatusSkuInventory\": 1,\n \"TypeStatusSkuInventory\": \"string\",\n \"IDTypeQuantity\": 1,\n \"InventoryDescription\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"InventoryStartUser\": 9678,\n \"InventoryStartUserLogin\": \"string\",\n \"InventoryStartTimestamp\": \"2008-11-25T19:09:00.584Z\",\n \"InventoryFirstFinishTimestamp\": \"1959-02-17T09:00:34.909Z\",\n \"InventorySecondUserStart\": 1284,\n \"InventorySecondUserStartLogin\": \"string\",\n \"InventorySecondStartTimestamp\": \"1977-03-04T05:14:20.824Z\",\n \"InventorySecondFinishTimestamp\": \"1969-03-05T22:09:01.350Z\",\n \"InventoryThirdUserStart\": 9603,\n \"InventoryThirdUserStartLogin\": \"string\",\n \"InventoryThirdStartTimestamp\": \"1980-08-28T08:05:03.230Z\",\n \"InventoryThirdFinishTimestamp\": \"2026-08-12T01:54:38.795Z\",\n \"InventoryFinishUser\": \"string\",\n \"InventoryFinishTimestamp\": \"2013-11-04T11:23:08.719Z\",\n \"RecordTimestamp\": \"1987-02-11T17:22:03.346Z\",\n \"StockKeepingUnitInventorySummarySkuQueueCount\": 3708,\n \"StockKeepingUnitInventorySummaryLocationQueueCount\": 1214,\n \"TypeInventorySummaryQuantity\": \"string\",\n \"Items\": [\n {\n \"IDStockKeepingUnitInventoryItems\": 3623,\n \"IDSku\": 3125,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7556,\n \"RastroControl\": 5957,\n \"BatchRequired\": 7398,\n \"BestBeforeRequired\": 4411,\n \"QuantityBatch\": 6785.592563740554,\n \"QuantityInventory\": 9392.97238803477,\n \"QuantityInventorySecond\": 2776.90193072615,\n \"QuantityInventoryThird\": 5152.3517637062,\n \"QuantityInventoryDiff\": 6963.3904654769285,\n \"QuantityInventorySecondDiff\": 3782.2000963082214,\n \"QuantityInventoryThirdDiff\": 8439.285606674362,\n \"IDBatch\": 1651,\n \"BestBeforeDate\": \"1981-05-07\",\n \"ManufacturingDate\": \"1982-12-24\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 4193,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 3359,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 3341,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 5625.694692463559\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 150,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 6649.55123068607\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 8028,\n \"IDSku\": 2254,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 7400,\n \"RastroControl\": 2488,\n \"BatchRequired\": 4716,\n \"BestBeforeRequired\": 4896,\n \"QuantityBatch\": 9526.46656345637,\n \"QuantityInventory\": 6297.112526318791,\n \"QuantityInventorySecond\": 9644.520789903783,\n \"QuantityInventoryThird\": 874.9636731511612,\n \"QuantityInventoryDiff\": 5067.558387446427,\n \"QuantityInventorySecondDiff\": 7879.124586957629,\n \"QuantityInventoryThirdDiff\": 2345.4388889602674,\n \"IDBatch\": 7739,\n \"BestBeforeDate\": \"2019-08-24\",\n \"ManufacturingDate\": \"1996-02-01\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 5402,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 7812,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 8747,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 4551.148648998742\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 3951,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 1570.8061291433783\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummarySkuQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 5683,\n \"IDSku\": 3003,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 6785,\n \"IDSku\": 9583,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\"\n }\n ],\n \"StockKeepingUnitInventorySummaryLocationQueue\": [\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 6273,\n \"IDStockKeepingUnitLocation\": 5248,\n \"Address\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummarySkuQueue\": 1038,\n \"IDStockKeepingUnitLocation\": 5286,\n \"Address\": \"string\"\n }\n ],\n \"ItemsCount\": 3996,\n \"HasNextPageItems\": 1,\n \"InventoryLogs\": [\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 4952,\n \"IDStockKeepingUnitInventorySummary\": 535,\n \"Data\": \"string\",\n \"RecordUserCreated\": 9186,\n \"RecordTimestamp\": \"1989-12-17T19:16:46.721Z\",\n \"Login\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventorySummaryLog\": 927,\n \"IDStockKeepingUnitInventorySummary\": 2761,\n \"Data\": \"string\",\n \"RecordUserCreated\": 3299,\n \"RecordTimestamp\": \"1968-10-03T08:07:22.583Z\",\n \"Login\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "131f8a52-ab2f-4d4c-a062-d1d321e1466e", "name": "Mensagens (prefixo `[BadRequest]`): `Inventário não existe`; `Inventário já está finalizado`; `Inventário está cancelado`; `Inventário não pode ter a primeira/segunda/terceira conferência finalizada novamente`; `Colaborador primeira/segunda/terceira conferência não existe`; `Precisa finalizar a primeira conferência antes de definir o colaborador da segunda`; `Precisa finalizar a segunda conferência antes de definir o colaborador da terceira`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypeStatusSkuInventory\": 7,\n \"InventoryStartUser\": 9496,\n \"InventorySecondUserStart\": 584,\n \"InventoryThirdUserStart\": 6772\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd3d41e7-d472-4860-ad2c-07122d5f5e26", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypeStatusSkuInventory\": 7,\n \"InventoryStartUser\": 9496,\n \"InventorySecondUserStart\": 584,\n \"InventoryThirdUserStart\": 6772\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4136be76-153a-4d6f-b7a7-fdb060f252c7", "name": "Cancela inventário", "request": { "name": "Cancela inventário", "description": { "content": "Marca o inventário como Cancelado (`IDTypeStatusSkuInventory = 4`) e registra a ação no histórico do inventário. Não dispara ajuste de estoque. Inventários já Finalizados (`1`) não podem ser cancelados.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e41a989b-009e-4af1-b3d6-6e81cf9389d5", "name": "Cancelamento bem-sucedido. Retorna a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a59d7c77-7151-44cf-953d-e6ce2b9b208b", "name": "`[BadRequest] - Inventário não existe`; `[BadRequest] - Inventário já está finalizado`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "311aa3f5-b72f-4965-815b-642aa1ef442e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03918895-ddf8-447a-b23b-6d72961da3d5", "name": "Finaliza inventário e gera os ajustes de estoque", "request": { "name": "Finaliza inventário e gera os ajustes de estoque", "description": { "content": "Fecha o inventário gerando os ajustes de saldo: para cada SKU/lote contado e ainda não ajustado, compara a quantidade contada com o saldo apurado do lote e gera uma entrada (`IDTypeMovement=0`) ou uma saída (`IDTypeMovement=1`). A quantidade considerada é a da 3ª conferência quando preenchida, senão a da 2ª, senão a da 1ª. Quando o mesmo SKU e lote aparecem em mais de uma linha de contagem, as quantidades da 1ª conferência são somadas antes da comparação. Cada movimentação gerada é publicada para o webhook com o topic `SkuBalanceInventoryFinish`.\n\n**Itens já ajustados** — itens que geraram movimentação numa finalização anterior, e itens cujo lote não existe mais, são ignorados.\n\n**Inventário do tipo Endereço** — antes do ajuste, o sistema inclui automaticamente, com quantidade `0`, os lotes com saldo dos endereços que estavam na fila de contagem mas não foram lançados. Cada inclusão automática fica registrada no histórico do inventário.\n\n**Custo aplicado** — o custo médio do SKU naquele armazém; quando zero, usa o custo da última compra `CostLastPurchase` do SKU. Quando o parâmetro `UseCostFromCostSet` está ativo na empresa, o sistema usa o Custo Manual `CostSet` cadastrado no SKU.\n\nDurante o processamento o status passa a `5` (Processando) e, ao concluir, vai para `1` (Finalizado), gravando `InventoryFinishTimestamp` e registrando a finalização no histórico. Só é possível finalizar a partir dos status `2`, `3`, `6`, `7` ou `8`.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "finish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c871fe8e-dc77-4184-8d41-8bd8e1e1730b", "name": "Finalização concluída. Corpo: a string `sucesso`, devolvida somente depois que todos os ajustes de saldo foram gravados — a operação não retorna antes de concluir. Apenas a notificação com o topic `SkuBalanceInventoryFinish`, publicada para o webhook, é assíncrona.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "finish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d14e294-a6e1-4aa6-9490-6131625f1a0c", "name": "`[BadRequest] - inventário não localizado para finalizar` — o inventário não existe, não pertence à empresa, ou existe mas não tem nenhum item pendente de ajuste. `[BadRequest] - inventário não tem itens` — mensagem residual. `[BadRequest] - Status inventário não permite finalizar` — o inventário está fora dos status `2`, `3`, `6`, `7` e `8`. `[BadRequest] - Lote do item {IDSkuCompany} está inativo` — algum lote contado foi desativado.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "finish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12d5bcba-a126-437e-843d-28300f4df86d", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "finish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f6cd0e1-280f-43de-a152-650d5541f416", "name": "Adiciona SKU/endereço à fila ou lança contagem", "request": { "name": "Adiciona SKU/endereço à fila ou lança contagem", "description": { "content": "Endpoint multi-uso, controlado pela query string:\n\n- `IDTypeQueue=1` — adiciona endereços na fila de contagem. Com `AddAllLocations=1`, inclui todos os endereços do armazém do inventário que tenham saldo de lote diferente de zero.\n- `IDTypeQueue=2` — adiciona SKUs na fila de contagem. Com `AddAllSkus=1`, inclui todos os SKUs ativos da empresa com saldo de lote no centro de distribuição do inventário.\n- **Sem `IDTypeQueue`** — lança a quantidade contada de um SKU. Exige `IDSku` e `IDStockKeepingUnitWarehouse`; itens sem esses dois campos são ignorados sem erro. `QuantityInventory` ausente ou vazio é gravado como contagem `0` — não equivale a \"não contado\". Quando `IDStockKeepingUnitLocation` vem na query, os itens daquele endereço que não foram enviados no corpo são automaticamente zerados (uso pelo coletor).\n\nO corpo aceita um objeto único ou um array de objetos. Em array, itens inválidos não interrompem o processamento: a resposta vem com a lista de erros. Em objeto único, o primeiro erro vira `400`.\n\n**Atenção — recontagem destrutiva:** quando a estratégia de quantidade em vigor é `2` (enviada em `IDTypeQuantity` ou herdada do cadastro do inventário), todos os itens já lançados no inventário são apagados antes de processar a requisição, e a remoção fica registrada no histórico.\n\n`Draft=1` guarda o corpo como rascunho temporário (4 dias) sem persistir nada — nesse modo a resposta vem vazia e o rascunho é recuperado no detalhe do inventário com `Draft=1`.\n\nAo receber a primeira contagem, o sistema atribui o usuário autenticado como colaborador da 1ª conferência e muda o status para `3` (Em andamento). Enviar `QuantityInventorySecond` ou `QuantityInventoryThird` apenas assume a 2ª/3ª conferência — atribui o colaborador e muda o status para `9` ou `10`; a quantidade gravada continua sendo a de `QuantityInventory`.\n\nQuando o SKU ainda não tem nenhum lote no armazém informado, o sistema cria um lote para receber a contagem — e, se o armazém não tiver nenhum endereço, cria também o endereço padrão `Principal`.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeQueue", "value": "1", "description": "Tipo de item da fila. Omita para lançamento de contagem." }, { "disabled": false, "key": "AddAllLocations", "value": "1", "description": "Junto com `IDTypeQueue=1`, adiciona automaticamente todos os endereços do armazém com saldo." }, { "disabled": false, "key": "AddAllSkus", "value": "1", "description": "Junto com `IDTypeQueue=2`, adiciona automaticamente todos os SKUs ativos da empresa com saldo." }, { "disabled": false, "key": "IDTypeQuantity", "value": "2", "description": "Sobrescreve a estratégia de quantidade do cadastro do inventário." }, { "disabled": false, "key": "IDStockKeepingUnitLocation", "value": "2232", "description": "Quando informado sem `IDTypeQueue`, o sistema considera que a contagem é por endereço e zera os SKUs deste endereço que não vieram no body." }, { "disabled": false, "key": "Draft", "value": "1", "description": "Quando `1`, salva o body como rascunho temporário (TTL 4 dias) em vez de persistir." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSku\": 1666,\n \"IDStockKeepingUnitLocation\": 485,\n \"IDStockKeepingUnitWarehouse\": 6691,\n \"QuantityInventory\": 5409.32310586461,\n \"QuantityInventorySecond\": 4047.2740924009363,\n \"QuantityInventoryThird\": 6949.2173939705635,\n \"IDBatchNumber\": 3839,\n \"BestBeforeDate\": \"1990-08-27\",\n \"ManufacturingDate\": \"2019-08-02\",\n \"BatchComments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9c7fd55c-d181-4c54-b8f3-b35176b9c8bf", "name": "Lista atualizada de itens contados do inventário. Como o detalhe passou a ser paginado, vem no máximo a **primeira página** — 5000 registros; para inventários maiores, o restante é obtido pelo detalhe do inventário com `Page`.\n\nCom `Draft=1` a resposta é vazia: o rascunho é apenas gravado, sem devolver a lista de itens.\n\nQuando o corpo é um array e ocorrem erros parciais, a resposta é a lista de erros.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeQueue", "value": "" }, { "key": "AddAllLocations", "value": "1" }, { "key": "AddAllSkus", "value": "1" }, { "key": "IDTypeQuantity", "value": "" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "Draft", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 1666,\n \"IDStockKeepingUnitLocation\": 485,\n \"IDStockKeepingUnitWarehouse\": 6691,\n \"QuantityInventory\": 5409.32310586461,\n \"QuantityInventorySecond\": 4047.2740924009363,\n \"QuantityInventoryThird\": 6949.2173939705635,\n \"IDBatchNumber\": 3839,\n \"BestBeforeDate\": \"1990-08-27\",\n \"ManufacturingDate\": \"2019-08-02\",\n \"BatchComments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitInventoryItems\": 7404,\n \"IDSku\": 4219,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 9088,\n \"RastroControl\": 9809,\n \"BatchRequired\": 8104,\n \"BestBeforeRequired\": 5349,\n \"QuantityBatch\": 4123.349692657516,\n \"QuantityInventory\": 8175.967338402365,\n \"QuantityInventorySecond\": 6224.77137988755,\n \"QuantityInventoryThird\": 1276.4058305896885,\n \"QuantityInventoryDiff\": 5942.883589123693,\n \"QuantityInventorySecondDiff\": 2215.5038197144595,\n \"QuantityInventoryThirdDiff\": 184.19745040714864,\n \"IDBatch\": 9454,\n \"BestBeforeDate\": \"2026-07-19\",\n \"ManufacturingDate\": \"2025-04-29\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 340,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 9356,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 5550,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8144.505305085648\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 899,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8953.671273841092\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 1259,\n \"IDSku\": 7164,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 9068,\n \"RastroControl\": 8249,\n \"BatchRequired\": 2224,\n \"BestBeforeRequired\": 9548,\n \"QuantityBatch\": 5700.4671212892945,\n \"QuantityInventory\": 6520.093992248339,\n \"QuantityInventorySecond\": 539.959298999324,\n \"QuantityInventoryThird\": 3054.1493864630474,\n \"QuantityInventoryDiff\": 6960.787048018984,\n \"QuantityInventorySecondDiff\": 5389.643954267094,\n \"QuantityInventoryThirdDiff\": 137.15913855025352,\n \"IDBatch\": 5799,\n \"BestBeforeDate\": \"1987-02-11\",\n \"ManufacturingDate\": \"1978-03-03\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 4385,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 4122,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 7246,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3387.30428557279\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 6467,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7681.218634681805\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e33a019-dde6-446a-a32a-e4f1f4112144", "name": "Mensagens (prefixo `[BadRequest]`): `Inventário não existe`; `Inventário já está finalizado`; `Inventário está cancelado`; `Sku não existe`; `Armazém não existe`; `Lote não existe`; `Endereço não existe para armazém`.\n\nAs três de item (`Sku não existe`, `Armazém não existe`, `Lote não existe`) só viram erro `400` quando o corpo é um objeto único; com o corpo em array, elas voltam no `200` como erros parciais.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeQueue", "value": "" }, { "key": "AddAllLocations", "value": "1" }, { "key": "AddAllSkus", "value": "1" }, { "key": "IDTypeQuantity", "value": "" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "Draft", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 1666,\n \"IDStockKeepingUnitLocation\": 485,\n \"IDStockKeepingUnitWarehouse\": 6691,\n \"QuantityInventory\": 5409.32310586461,\n \"QuantityInventorySecond\": 4047.2740924009363,\n \"QuantityInventoryThird\": 6949.2173939705635,\n \"IDBatchNumber\": 3839,\n \"BestBeforeDate\": \"1990-08-27\",\n \"ManufacturingDate\": \"2019-08-02\",\n \"BatchComments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b26ff80-449a-44ff-a219-f06057c64a29", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeQueue", "value": "" }, { "key": "AddAllLocations", "value": "1" }, { "key": "AddAllSkus", "value": "1" }, { "key": "IDTypeQuantity", "value": "" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "Draft", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 1666,\n \"IDStockKeepingUnitLocation\": 485,\n \"IDStockKeepingUnitWarehouse\": 6691,\n \"QuantityInventory\": 5409.32310586461,\n \"QuantityInventorySecond\": 4047.2740924009363,\n \"QuantityInventoryThird\": 6949.2173939705635,\n \"IDBatchNumber\": 3839,\n \"BestBeforeDate\": \"1990-08-27\",\n \"ManufacturingDate\": \"2019-08-02\",\n \"BatchComments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65939deb-5d32-4f84-93bb-64a1ee37d999", "name": "Remove item da fila", "request": { "name": "Remove item da fila", "description": { "content": "Remove um SKU ou um endereço da fila de contagem. É obrigatório enviar **uma** das duas query strings — se as duas vierem, prevalece `IDStockKeepingUnitInventorySummarySkuQueue` e o endereço é ignorado. O código do endereço na fila é o que o detalhe do inventário devolve, dentro da fila de endereços, na chave legada `IDStockKeepingUnitInventorySummarySkuQueue`.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDStockKeepingUnitInventorySummarySkuQueue", "value": "2232", "description": "Código do SKU na fila." }, { "disabled": false, "key": "IDStockKeepingUnitInventorySummaryLocationQueue", "value": "2232", "description": "Código do endereço na fila." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "05cf1686-369a-4adc-9386-d866e4f2024b", "name": "Remoção bem-sucedida. Retorna a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitInventorySummarySkuQueue", "value": "2232" }, { "key": "IDStockKeepingUnitInventorySummaryLocationQueue", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dda0767-2fb2-45d8-93c3-8ac5449f4d21", "name": "Mensagens (prefixo `[BadRequest]`): `Inventário não encontrado`; `Inventário já está finalizado`; `Inventário está cancelado`; `Erro ao deletar item a ser inventariado`; `Erro ao deletar endereço a ser inventariado`; `Precisa ser enviado o endereço ou o item a ser inventariado para deletar`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitInventorySummarySkuQueue", "value": "2232" }, { "key": "IDStockKeepingUnitInventorySummaryLocationQueue", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb54fdb-02de-48b5-be7b-ce9d433c38c6", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDStockKeepingUnitInventorySummarySkuQueue", "value": "2232" }, { "key": "IDStockKeepingUnitInventorySummaryLocationQueue", "value": "2232" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08097433-46c7-4e43-a779-8a9ec6029679", "name": "Atualiza a quantidade lançada de um item", "request": { "name": "Atualiza a quantidade lançada de um item", "description": { "content": "Atualiza a contagem de um item já existente na lista de itens. O sistema escolhe a conferência ativa pelo status atual do inventário: status `3` (Em andamento) grava `QuantityInventory`; `6` ou `9` gravam `QuantityInventorySecond`; `7` ou `10` gravam `QuantityInventoryThird` — os campos das demais conferências são descartados. Em qualquer outro status (por exemplo `2` Aberto), todos os campos enviados são gravados.\n\n**Atenção — não é atualização parcial.** Com exceção de `QuantityInventory`, todo campo omitido do corpo é gravado com o valor padrão, e não preservado: `BestBeforeDate` ausente grava o marcador de item sem validade, `BatchComments` e `ManufacturingDate` ausentes limpam o campo, e `QuantityInventorySecond`/`QuantityInventoryThird` ausentes limpam a contagem da conferência correspondente sempre que ela for a conferência ativa. Reenvie os valores atuais dos campos que não quiser alterar.\n\nQuando `QuantityInventorySecond` (ou `QuantityInventoryThird`) é enviado e a conferência correspondente ainda não foi iniciada, o sistema atribui o usuário autenticado como colaborador da rodada e muda o status do inventário para `9` ou `10`.\n\nCada alteração de valor fica registrada no histórico do inventário, com o valor anterior e o novo.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"QuantityInventory\": 9466.567508531323,\n \"QuantityInventorySecond\": 1065.9131975795156,\n \"QuantityInventoryThird\": 5586.697931188238,\n \"BestBeforeDate\": \"2002-10-12\",\n \"ManufacturingDate\": \"1958-01-02\",\n \"BatchComments\": \"string\"\n },\n {\n \"QuantityInventory\": 1738.4429592439776,\n \"QuantityInventorySecond\": 7017.40641410132,\n \"QuantityInventoryThird\": 1477.837815486438,\n \"BestBeforeDate\": \"1959-12-05\",\n \"ManufacturingDate\": \"1958-12-15\",\n \"BatchComments\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4c7a8c89-89ea-429f-b106-33850afb5693", "name": "Contagem atualizada. O corpo devolve TODOS os itens do inventário, não apenas o item alterado. Cada item traz menos campos que o detalhe do inventário — não vêm as diferenças por conferência (`QuantityInventoryDiff`, `QuantityInventorySecondDiff`, `QuantityInventoryThirdDiff`), `BarCodeList`, `BarCodePackageList`, `RastroControl`, `BestBeforeRequired`, `BatchRequired` nem `MainImageThumbnailURL` — e traz `MainImageURL` (URL da imagem principal do SKU, sem o sufixo de miniatura), exclusivo desta resposta. `BestBeforeDate` pode vir como `4000-01-01` (marcador de item sem validade), enquanto o detalhe do inventário devolve vazio nesse caso.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"QuantityInventory\": 3235.971177397503,\n \"QuantityInventorySecond\": 8816.982305946163,\n \"QuantityInventoryThird\": 1456.662274105951,\n \"BestBeforeDate\": \"1992-09-03\",\n \"ManufacturingDate\": \"1991-06-13\",\n \"BatchComments\": \"string\"\n },\n {\n \"QuantityInventory\": 6036.007119645074,\n \"QuantityInventorySecond\": 4448.810958373008,\n \"QuantityInventoryThird\": 2315.767982517365,\n \"BestBeforeDate\": \"1996-08-01\",\n \"ManufacturingDate\": \"2002-06-17\",\n \"BatchComments\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitInventoryItems\": 7404,\n \"IDSku\": 4219,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 9088,\n \"RastroControl\": 9809,\n \"BatchRequired\": 8104,\n \"BestBeforeRequired\": 5349,\n \"QuantityBatch\": 4123.349692657516,\n \"QuantityInventory\": 8175.967338402365,\n \"QuantityInventorySecond\": 6224.77137988755,\n \"QuantityInventoryThird\": 1276.4058305896885,\n \"QuantityInventoryDiff\": 5942.883589123693,\n \"QuantityInventorySecondDiff\": 2215.5038197144595,\n \"QuantityInventoryThirdDiff\": 184.19745040714864,\n \"IDBatch\": 9454,\n \"BestBeforeDate\": \"2026-07-19\",\n \"ManufacturingDate\": \"2025-04-29\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 340,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 9356,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 5550,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8144.505305085648\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 899,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 8953.671273841092\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n },\n {\n \"IDStockKeepingUnitInventoryItems\": 1259,\n \"IDSku\": 7164,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 9068,\n \"RastroControl\": 8249,\n \"BatchRequired\": 2224,\n \"BestBeforeRequired\": 9548,\n \"QuantityBatch\": 5700.4671212892945,\n \"QuantityInventory\": 6520.093992248339,\n \"QuantityInventorySecond\": 539.959298999324,\n \"QuantityInventoryThird\": 3054.1493864630474,\n \"QuantityInventoryDiff\": 6960.787048018984,\n \"QuantityInventorySecondDiff\": 5389.643954267094,\n \"QuantityInventoryThirdDiff\": 137.15913855025352,\n \"IDBatch\": 5799,\n \"BestBeforeDate\": \"1987-02-11\",\n \"ManufacturingDate\": \"1978-03-03\",\n \"BatchComments\": \"string\",\n \"IDStockKeepingUnitLocation\": 4385,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 4122,\n \"WarehouseName\": \"string\",\n \"AccountName\": \"string\",\n \"BarCodeList\": [\n \"string\",\n \"string\"\n ],\n \"BarCodePackageList\": [\n {\n \"IDStockKeepingUnitBarCodePackage\": 7246,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 3387.30428557279\n },\n {\n \"IDStockKeepingUnitBarCodePackage\": 6467,\n \"BarCodePackage\": \"string\",\n \"PackageFactor\": 7681.218634681805\n }\n ],\n \"MainImageThumbnailURL\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec2c6a34-2237-4a21-803f-83cb75c5619b", "name": "`[BadRequest] - Sku inventário não encontrado`; `[BadRequest] - Inventário já está finalizado`; `[BadRequest] - Inventário está cancelado`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"QuantityInventory\": 3235.971177397503,\n \"QuantityInventorySecond\": 8816.982305946163,\n \"QuantityInventoryThird\": 1456.662274105951,\n \"BestBeforeDate\": \"1992-09-03\",\n \"ManufacturingDate\": \"1991-06-13\",\n \"BatchComments\": \"string\"\n },\n {\n \"QuantityInventory\": 6036.007119645074,\n \"QuantityInventorySecond\": 4448.810958373008,\n \"QuantityInventoryThird\": 2315.767982517365,\n \"BestBeforeDate\": \"1996-08-01\",\n \"ManufacturingDate\": \"2002-06-17\",\n \"BatchComments\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f20434a5-4773-43dc-bdc7-27c6fd9a7fbd", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"QuantityInventory\": 3235.971177397503,\n \"QuantityInventorySecond\": 8816.982305946163,\n \"QuantityInventoryThird\": 1456.662274105951,\n \"BestBeforeDate\": \"1992-09-03\",\n \"ManufacturingDate\": \"1991-06-13\",\n \"BatchComments\": \"string\"\n },\n {\n \"QuantityInventory\": 6036.007119645074,\n \"QuantityInventorySecond\": 4448.810958373008,\n \"QuantityInventoryThird\": 2315.767982517365,\n \"BestBeforeDate\": \"1996-08-01\",\n \"ManufacturingDate\": \"2002-06-17\",\n \"BatchComments\": \"string\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4858d011-eb4d-4ce5-80d1-b1021861f380", "name": "Remove item contado", "request": { "name": "Remove item contado", "description": { "content": "Remove uma linha de item já lançada na contagem e registra a exclusão (SKU e quantidade) no histórico do inventário. Não é possível remover quando o inventário está Finalizado (`1`) ou Cancelado (`4`).", "type": "text/plain" }, "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "30e6753a-2233-44b8-ae3f-d5bfb3895b4d", "name": "Remoção bem-sucedida. Retorna a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2752cccc-5cd5-4f72-871d-3dc3c22ed4d2", "name": "`[BadRequest] - Sku inventário não encontrado`; `[BadRequest] - Inventário já está finalizado`; `[BadRequest] - Inventário está cancelado`.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caef19ea-5711-41a1-991f-0f002d6a7bc9", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory-summary", ":idstockkeepingunitinventorysummary", "sku", ":idstockkeepingunitinventoryitems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventorysummary", "description": "(Required) Código do inventário." }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitinventoryitems", "description": "(Required) Código do item contado dentro do inventário." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "57070e34-bc03-4590-9cf4-a4660282b71a", "name": "Inventário (Legacy)", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6bc3b542-bc99-42de-a56b-e1ca5760ae36", "name": "Lista histórico de ajustes", "request": { "name": "Lista histórico de ajustes", "description": { "content": "Lista os ajustes de saldo lançados pela tela **Inventário** (`/app/inventory`) — uma linha por ajuste, com SKU, lote, armazém, quantidade contada, comentário, usuário e data. Paginada em blocos de 2000 (`Page`).", "type": "text/plain" }, "url": { "path": [ "sku", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Número da página (cada página tem 2000 registros). Default `0`." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial do intervalo (criação do ajuste)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final do intervalo. O sistema adiciona `23:59:59` ao valor." }, { "disabled": false, "key": "IDSku", "value": "2232", "description": "Filtra pelo código interno do SKU." }, { "disabled": false, "key": "SkuName", "value": "string", "description": "Filtra pelo nome do SKU (busca parcial)." }, { "disabled": false, "key": "Barcode", "value": "string", "description": "Filtra pelo código de barras principal." }, { "disabled": false, "key": "IDSkuCompany", "value": "string", "description": "Filtra pelo código de referência do SKU na empresa (busca parcial)." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca rápida — procura simultaneamente em `IDSku`, `SkuName`, `BarCode` e `IDSkuCompany`. Espaços viram `%` (LIKE)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a5fa9974-995d-487b-952e-122fa5a7a97c", "name": "Lista de ajustes.", "originalRequest": { "url": { "path": [ "sku", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDSku", "value": "2232" }, { "key": "SkuName", "value": "string" }, { "key": "Barcode", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "Search", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitInventory\": 2736,\n \"AccountName\": \"string\",\n \"IDSku\": 1036,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"Barcode\": \"string\",\n \"Quantity\": 7889.585700787538,\n \"IDStockKeepingUnitWarehouse\": 5614,\n \"WarehouseName\": \"string\",\n \"IDBatch\": 2589,\n \"Comments\": \"string\",\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1995-05-30T17:54:17.090Z\",\n \"IDSkuMovement\": 3956\n },\n {\n \"IDStockKeepingUnitInventory\": 7250,\n \"AccountName\": \"string\",\n \"IDSku\": 5434,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"Barcode\": \"string\",\n \"Quantity\": 5112.9103334023985,\n \"IDStockKeepingUnitWarehouse\": 4279,\n \"WarehouseName\": \"string\",\n \"IDBatch\": 1095,\n \"Comments\": \"string\",\n \"Login\": \"string\",\n \"RecordTimestamp\": \"1998-11-30T07:01:01.176Z\",\n \"IDSkuMovement\": 4721\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67fc6066-8c3a-445f-a155-551ffa35af3c", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDSku", "value": "2232" }, { "key": "SkuName", "value": "string" }, { "key": "Barcode", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "Search", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a943cec3-890b-45dc-9c7f-3dedc5de768f", "name": "Lança ajustes de saldo", "request": { "name": "Lança ajustes de saldo", "description": { "content": "Lança um array de ajustes de saldo. O sistema processa **item por item**, criando uma movimentação de estoque (`StockKeepingUnitMovement`) para cada item válido e um registro de ajuste (`StockKeepingUnitInventory`) apontando para ela. Para cada movimentação, dispara uma notificação `SkuBalanceAdjust` para o webhook.\n\n**Cálculo da diferença**:\n\n- Quando `IDMovementType = 0` ou `1`, força a direção e usa `QuantityInventory` como `Quantity` da movimentação.\n- Quando `IDMovementType = 3`, compara `QuantityInventory` contra o saldo disponível atual do SKU (`QtyAvailable`) e cria movimentação pela diferença.\n- Quando `IDMovementType` é omitido, compara `QuantityInventory` contra o saldo do **lote** (soma das movimentações do lote) e cria movimentação pela diferença.\n\n**Custo aplicado**: `CostSet` (custo manual) quando `UseCostFromCostSet = 1`; caso contrário, `CostAverage` apurado pelo balanço; quando o custo médio é zero, `CostLastPurchase` do SKU.\n\n**Auto-criação de lote**: quando o SKU não tem lote no armazém, o sistema cria automaticamente um lote no primeiro endereço (`Default = 1`) — quando não há endereço, cria um endereço `Principal` antes.\n\n**Erros parciais**: itens inválidos não interrompem o processamento — são acumulados em `tempError` e devolvidos no array de resposta.", "type": "text/plain" }, "url": { "path": [ "sku", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"IDStockKeepingUnitWarehouse\": 9134,\n \"IDSku\": 8934,\n \"QuantityInventory\": 9240.37466162004,\n \"IDBatchNumber\": 7314,\n \"Comments\": \"string\",\n \"IDStockKeepingUnitLocation\": 5582,\n \"IDMovementType\": 3\n },\n {\n \"IDStockKeepingUnitWarehouse\": 7930,\n \"IDSku\": 3215,\n \"QuantityInventory\": 1790.7951264347678,\n \"IDBatchNumber\": 3834,\n \"Comments\": \"string\",\n \"IDStockKeepingUnitLocation\": 4096,\n \"IDMovementType\": 3\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "01748354-4db5-4979-9f55-491675f3f31d", "name": "Resposta. Quando todos os itens foram processados com sucesso, devolve um array vazio. Quando há erros parciais, devolve a lista de falhas.", "originalRequest": { "url": { "path": [ "sku", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDStockKeepingUnitWarehouse\": 8391,\n \"IDSku\": 1893,\n \"QuantityInventory\": 2301.659827082776,\n \"IDBatchNumber\": 6794,\n \"Comments\": \"string\",\n \"IDStockKeepingUnitLocation\": 1042,\n \"IDMovementType\": 3\n },\n {\n \"IDStockKeepingUnitWarehouse\": 5218,\n \"IDSku\": 8908,\n \"QuantityInventory\": 7134.149462573824,\n \"IDBatchNumber\": 4572,\n \"Comments\": \"string\",\n \"IDStockKeepingUnitLocation\": 7989,\n \"IDMovementType\": 3\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"Description\": \"string\",\n \"Status\": 0\n },\n {\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"Description\": \"string\",\n \"Status\": 0\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c484e3b2-1376-4cde-a826-a4279292c4cc", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "inventory" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"IDStockKeepingUnitWarehouse\": 8391,\n \"IDSku\": 1893,\n \"QuantityInventory\": 2301.659827082776,\n \"IDBatchNumber\": 6794,\n \"Comments\": \"string\",\n \"IDStockKeepingUnitLocation\": 1042,\n \"IDMovementType\": 3\n },\n {\n \"IDStockKeepingUnitWarehouse\": 5218,\n \"IDSku\": 8908,\n \"QuantityInventory\": 7134.149462573824,\n \"IDBatchNumber\": 4572,\n \"Comments\": \"string\",\n \"IDStockKeepingUnitLocation\": 7989,\n \"IDMovementType\": 3\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3c8a3370-ae64-4dcb-9517-cf168f51d328", "name": "Jobs e Tarefas", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1e440cb9-f3d4-4e99-8930-705740b37f40", "name": "Lista jobs de ação em massa", "request": { "name": "Lista jobs de ação em massa", "description": { "content": "Retorna os jobs disparados pela empresa, do mais recente para o mais antigo. Cada item traz o tipo da ação (`TypeJob`) e o login do usuário que criou. Aceita filtro opcional por `IDTypeJob`. Quando a empresa autenticada é a `all` (multi-conta), retorna jobs de todas as empresas vinculadas.", "type": "text/plain" }, "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeJob", "value": "2232", "description": "Filtra pelo tipo da ação (`IDTypeJob`). Ex.: 1=Criar sku/produto, 3=Criar pedido, 6=Criar Contas a pagar, 7=Criar Contas a receber, 38=Importar extrato OFX, 41=Importar conciliação adquirente, 48=Importar extrato Marketplace." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1ac504da-a940-46af-9537-1049b9dd1769", "name": "Lista de jobs.", "originalRequest": { "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeJob", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDJob\": 5944,\n \"AccountName\": \"string\",\n \"IDCompany\": 5767,\n \"IDTypeJob\": 9,\n \"TypeJob\": \"string\",\n \"Login\": \"string\",\n \"RecordUserCreated\": 979,\n \"RecordTimestamp\": \"1985-10-26T03:47:45.059Z\",\n \"StartedAt\": \"1963-03-28T08:33:34.938Z\",\n \"FinishedAt\": \"1947-09-05T00:37:34.309Z\",\n \"RestartedAt\": \"1977-08-02T15:45:38.610Z\",\n \"Attempts\": 2467,\n \"IDFile\": \"string\",\n \"FileHash\": \"string\",\n \"Metadata\": \"string\",\n \"IDCompanyIntegration\": 9998\n },\n {\n \"IDJob\": 5311,\n \"AccountName\": \"string\",\n \"IDCompany\": 4386,\n \"IDTypeJob\": 9857,\n \"TypeJob\": \"string\",\n \"Login\": \"string\",\n \"RecordUserCreated\": 6222,\n \"RecordTimestamp\": \"1980-08-05T09:47:36.323Z\",\n \"StartedAt\": \"2005-10-06T14:42:13.054Z\",\n \"FinishedAt\": \"1961-06-11T00:05:14.040Z\",\n \"RestartedAt\": \"2024-03-20T17:50:54.362Z\",\n \"Attempts\": 2681,\n \"IDFile\": \"string\",\n \"FileHash\": \"string\",\n \"Metadata\": \"string\",\n \"IDCompanyIntegration\": 3802\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caa82ccf-bd94-45a8-94f3-23e197478f08", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeJob", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c10e4322-1ed1-4e29-a57b-b9919bbd73e2", "name": "Dispara um job de ação em massa (upload de planilha)", "request": { "name": "Dispara um job de ação em massa (upload de planilha)", "description": { "content": "Cria um job para processar em lote a ação indicada por `IDTypeJob`. O envio do arquivo pode ser feito de duas formas: diretamente na requisição, em `multipart/form-data`; ou em dois passos, enviando `Action` `RequestUploadUrl` para obter uma URL de envio temporária e depois `Action` `ConfirmUpload` com a chave devolvida — o caminho recomendado para arquivos grandes, já que o conteúdo não trafega pela API. O envio em dois passos aceita arquivos até o tamanho máximo configurado, 50 MB por padrão, e a URL temporária vale 1 hora; o envio direto fica limitado ao tamanho máximo de requisição aceito pela API. Em qualquer um dos dois, se a empresa já tem um job em processamento com o mesmo arquivo, o job existente é reaproveitado e nenhum processamento novo é disparado. O processamento é assíncrono: a resposta traz o `IDJob` e o resultado real é acompanhado em `GET /job/{idjob}` ou recebido por e-mail.", "type": "text/plain" }, "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeJob", "value": "2232", "description": "(Required) Identificador do tipo de ação. Define qual rotina processa o arquivo. Lista completa em `TypeJob` — ex.: 1=Criar sku/produto, 3=Criar pedido, 6=Criar Contas a pagar, 7=Criar Contas a receber, 38=Importar extrato OFX, 41=Importar conciliação adquirente, 48=Importar extrato Marketplace." }, { "disabled": false, "key": "IDBankAccount", "value": "2232", "description": "**Obrigatório quando `IDTypeJob = 38`** (Importar extrato OFX). Identificador da conta bancária de destino. Vai como `Metadata` do job." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "**Obrigatório quando `IDTypeJob = 41`** (Importar conciliação adquirente). Identificador da integração de adquirente. Vai como `Metadata` do job." }, { "disabled": false, "key": "IDSupplier", "value": "2232", "description": "Usado por algumas ações de tabela de frete (`IDTypeJob` 4, 5, 10). Vai como `Metadata` do job junto com o nome do arquivo." }, { "disabled": false, "key": "Type", "value": "carrier", "description": "Complementa as ações de tabela de frete. Com `carrier` ou `carrierIntelipost`, o nome original do arquivo é guardado junto do fornecedor informado em `IDSupplier` para uso no processamento. Não tem efeito nas demais ações." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Planilha `.xlsx` ou `.xls` com os dados a importar. Até 5 MB. O modelo da planilha de cada tipo é baixado em `TemplateUrl` (quando preenchido)." } ] } }, "response": [ { "id": "bb99f647-241c-43cc-b0d2-72de2d98a9f9", "name": "Job criado (ou reaproveitado). Devolve `IDJob` para acompanhamento — o identificador pode ser o de um job já existente, tanto quando o mesmo arquivo já foi confirmado antes quanto quando outro job com o mesmo conteúdo ainda está em processamento. O processamento é assíncrono: o resultado vem por e-mail e pode ser acompanhado em `GET /job/{idjob}`. No modo `Action=RequestUploadUrl` o corpo é outro — um objeto com `UploadUrl` (endereço temporário para enviar o arquivo), `Key` (chave a devolver em `ConfirmUpload`), `Name`, `Method` (sempre `PUT`), `Headers` (cabeçalhos obrigatórios no envio), `SizeBytes` e `ExpiresIn` (validade em segundos, `3600` por padrão).", "originalRequest": { "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeJob", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDSupplier", "value": "2232" }, { "key": "Type", "value": "carrier" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Planilha `.xlsx` ou `.xls` com os dados a importar. Até 5 MB. O modelo da planilha de cada tipo é baixado em `TemplateUrl` (quando preenchido).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"IDJob\": 7244,\n \"Message\": \"Arquivo em processamento, aguardar resposta por email\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40c18aef-7db1-4f09-a8b3-c4d2853395fe", "name": "Falha de validação. O corpo traz `errorMessage` com o prefixo `[BadRequest] - ` seguido de uma das mensagens:\n\n- `Ação não encontrada` (IDTypeJob inválido)\n- `Erro ao processar ação em massa` (combinação rota/tipo não mapeada)\n- `IDBankAccount é obrigatório`\n- `IDCompanyIntegration é obrigatório`\n- `Corpo da requisição inválido`\n- `Selecione um arquivo para enviar`\n- `Não foi possível identificar o tipo do arquivo selecionado`\n- `Não foi possível identificar o tamanho do arquivo selecionado`\n- `O arquivo selecionado excede o tamanho máximo permitido`\n- `Não foi possível validar o arquivo selecionado. Selecione-o novamente e tente de novo`\n- `Falha ao gerar o link de upload: `\n- `Não foi possível identificar o arquivo enviado. Solicite um novo envio`\n- `Não foi possível localizar o arquivo enviado. Envie-o novamente`\n- `O arquivo enviado não corresponde ao arquivo selecionado. Envie-o novamente`\n- `Não foi possível validar o arquivo enviado. Envie-o novamente`\n- `Não foi possível ler o arquivo enviado. Envie-o novamente`\n- `Não foi possível confirmar o envio do arquivo. Tente novamente`\n- `Não foi possível processar o arquivo enviado. Envie-o novamente`", "originalRequest": { "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeJob", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDSupplier", "value": "2232" }, { "key": "Type", "value": "carrier" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Planilha `.xlsx` ou `.xls` com os dados a importar. Até 5 MB. O modelo da planilha de cada tipo é baixado em `TemplateUrl` (quando preenchido).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91207f82-f8b1-4511-9dcb-0aab4b00000a", "name": "Empresa do `accountname` não localizada (404 sem corpo).", "originalRequest": { "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeJob", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDSupplier", "value": "2232" }, { "key": "Type", "value": "carrier" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Planilha `.xlsx` ou `.xls` com os dados a importar. Até 5 MB. O modelo da planilha de cada tipo é baixado em `TemplateUrl` (quando preenchido).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b91f41b7-87d7-4c18-a2a6-38e9ce34f6e9", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "job" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeJob", "value": "2232" }, { "key": "IDBankAccount", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDSupplier", "value": "2232" }, { "key": "Type", "value": "carrier" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Planilha `.xlsx` ou `.xls` com os dados a importar. Até 5 MB. O modelo da planilha de cada tipo é baixado em `TemplateUrl` (quando preenchido).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d12df4a-3930-4b7c-a143-783cd252601b", "name": "Detalha um job com os resultados linha-a-linha", "request": { "name": "Detalha um job com os resultados linha-a-linha", "description": { "content": "Retorna o cabeçalho do job (datas, usuário, tipo, etc.) e o array `Result` com **uma entrada por linha** processada — cada uma com a aba (`Sheet`), o número da linha (`Line`), o status (`1` = sucesso, `0` = erro), a descrição da ação ou do erro, e o id e nome do recurso afetado. A resposta também traz uma **URL pré-assinada** (`UrlFile`) para baixar o arquivo enviado (válida por 2 dias).\n\nPaginação por `Page` (5000 linhas de resultado por página). Quando o id não pertence à empresa autenticada, devolve `[]`.", "type": "text/plain" }, "url": { "path": [ "job", ":idjob" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Página zero-based para a lista de resultados (`Result`). Cada página devolve no máximo 5000 linhas. Default: 0." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjob", "description": "(Required) Identificador do job." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c5771b04-5691-402f-9db9-ec59b7fb3b1d", "name": "Detalhe do job (array com 1 item) ou `[]` quando o id não pertence à empresa.", "originalRequest": { "url": { "path": [ "job", ":idjob" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjob", "description": "(Required) Identificador do job." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDJob\": 8659,\n \"AccountName\": \"string\",\n \"IDCompany\": 748,\n \"IDTypeJob\": 444,\n \"TypeJob\": \"string\",\n \"Login\": \"string\",\n \"RecordUserCreated\": 5602,\n \"RecordTimestamp\": \"2012-10-08T02:50:12.023Z\",\n \"StartedAt\": \"1992-08-31T03:51:38.215Z\",\n \"FinishedAt\": \"1953-12-14T15:03:36.368Z\",\n \"RestartedAt\": \"2000-06-06T14:07:01.741Z\",\n \"Attempts\": 8999,\n \"IDFile\": \"string\",\n \"FileHash\": \"string\",\n \"Metadata\": \"string\",\n \"IDCompanyIntegration\": 7100,\n \"Result\": [\n {\n \"IDJobsResult\": 2985,\n \"Sheet\": \"string\",\n \"Line\": 5137,\n \"Status\": 1,\n \"StatusName\": \"Erro\",\n \"Description\": \"string\",\n \"ID\": 8627,\n \"Name\": \"string\"\n },\n {\n \"IDJobsResult\": 2387,\n \"Sheet\": \"string\",\n \"Line\": 2249,\n \"Status\": 1,\n \"StatusName\": \"Sucesso\",\n \"Description\": \"string\",\n \"ID\": 124,\n \"Name\": \"string\"\n }\n ],\n \"UrlFile\": \"https://WYo.yfmzuJ1Hi\"\n },\n {\n \"IDJob\": 7259,\n \"AccountName\": \"string\",\n \"IDCompany\": 3190,\n \"IDTypeJob\": 4681,\n \"TypeJob\": \"string\",\n \"Login\": \"string\",\n \"RecordUserCreated\": 6783,\n \"RecordTimestamp\": \"2017-07-22T23:18:38.244Z\",\n \"StartedAt\": \"2019-01-13T23:49:40.282Z\",\n \"FinishedAt\": \"2005-12-28T16:58:54.085Z\",\n \"RestartedAt\": \"1973-08-02T04:35:57.099Z\",\n \"Attempts\": 7411,\n \"IDFile\": \"string\",\n \"FileHash\": \"string\",\n \"Metadata\": \"string\",\n \"IDCompanyIntegration\": 8649,\n \"Result\": [\n {\n \"IDJobsResult\": 8094,\n \"Sheet\": \"string\",\n \"Line\": 5616,\n \"Status\": 0,\n \"StatusName\": \"Erro\",\n \"Description\": \"string\",\n \"ID\": 8650,\n \"Name\": \"string\"\n },\n {\n \"IDJobsResult\": 80,\n \"Sheet\": \"string\",\n \"Line\": 8076,\n \"Status\": 1,\n \"StatusName\": \"Erro\",\n \"Description\": \"string\",\n \"ID\": 6046,\n \"Name\": \"string\"\n }\n ],\n \"UrlFile\": \"https://Zr.vijE0fDF\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86be65a1-48c7-4748-86ae-4f5d151dee05", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "job", ":idjob" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idjob", "description": "(Required) Identificador do job." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ae0308ea-a997-4e52-9335-11c938a95b79", "name": "Jornada de Trabalho", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "61489355-277f-4051-84a5-e2dfd43a166d", "name": "Lista colaboradores", "request": { "name": "Lista colaboradores", "description": { "content": "Lista colaboradores (`UserWorkingDay`) com escala, função atual, funções permitidas, grupos de endereços, categorias de endereço, supervisor e última atividade do usuário (`LastActivityTimestamp`).", "type": "text/plain" }, "url": { "path": [ "user", "workingday" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDUserWorkingDay", "value": "2232", "description": "Filtra pelo identificador do dia de trabalho do usuário." }, { "disabled": false, "key": "IDUser", "value": "2232", "description": "Filtra pelo identificador do usuário." }, { "disabled": false, "key": "IDStockKeepingUnitLocationCategoryList", "value": "string", "description": "Lista CSV de ids; filtra coincidência exata da string CSV." }, { "disabled": false, "key": "IDUserJobPositionList", "value": "2232", "description": "Filtra colaboradores que tenham essa função no CSV `IDUserJobPositionList` (`FIND_IN_SET`)." }, { "disabled": false, "key": "Status", "value": "1", "description": "Filtra por status. A semântica e os valores aceitos dependem do endpoint — consulte o `description` da operação." }, { "disabled": false, "key": "IDWorkScale", "value": "2232", "description": "Filtra pelo identificador da escala de trabalho." }, { "disabled": false, "key": "IDUserUpper", "value": "2232", "description": "Filtra subordinados de um supervisor." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fcffa5da-ac51-478c-b838-4c599020ad2a", "name": "Lista de colaboradores.", "originalRequest": { "url": { "path": [ "user", "workingday" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDUserWorkingDay", "value": "2232" }, { "key": "IDUser", "value": "2232" }, { "key": "IDStockKeepingUnitLocationCategoryList", "value": "string" }, { "key": "IDUserJobPositionList", "value": "2232" }, { "key": "Status", "value": "1" }, { "key": "IDWorkScale", "value": "2232" }, { "key": "IDUserUpper", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDUserWorkingDay\": 7192,\n \"IDUser\": 4099,\n \"UserName\": \"string\",\n \"LastActivityTimestamp\": \"2023-04-07T10:27:50.820Z\",\n \"IDAcess\": 4431,\n \"Status\": 2,\n \"IDUserWorkScale\": 2628,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 3436,\n \"WeekDay\": 6600,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n },\n {\n \"IDUserWorkShift\": 2232,\n \"WeekDay\": 5303,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n }\n ],\n \"IDUserJobPositionList\": \"string\",\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 6427,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 5262,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4546,\n \"CurrentPositionName\": \"string\",\n \"IDUserUpper\": 6687,\n \"UserUpperName\": \"string\",\n \"Categories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 6077,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 9548,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"LocationsGroup\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 3727,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 8239,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDUserWorkingDay\": 5475,\n \"IDUser\": 5322,\n \"UserName\": \"string\",\n \"LastActivityTimestamp\": \"1989-11-17T20:29:46.437Z\",\n \"IDAcess\": 8820,\n \"Status\": 2,\n \"IDUserWorkScale\": 6544,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 8337,\n \"WeekDay\": 6235,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n },\n {\n \"IDUserWorkShift\": 4469,\n \"WeekDay\": 4214,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n }\n ],\n \"IDUserJobPositionList\": \"string\",\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 6913,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 5359,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 2450,\n \"CurrentPositionName\": \"string\",\n \"IDUserUpper\": 4833,\n \"UserUpperName\": \"string\",\n \"Categories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 6183,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 9523,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"LocationsGroup\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 5024,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 1502,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c5c877-4917-402f-aa08-86e76b1e5f4d", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "user", "workingday" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDUserWorkingDay", "value": "2232" }, { "key": "IDUser", "value": "2232" }, { "key": "IDStockKeepingUnitLocationCategoryList", "value": "string" }, { "key": "IDUserJobPositionList", "value": "2232" }, { "key": "Status", "value": "1" }, { "key": "IDWorkScale", "value": "2232" }, { "key": "IDUserUpper", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02c16854-71ee-49be-9d3a-02a48a13ad92", "name": "Cadastra um colaborador", "request": { "name": "Cadastra um colaborador", "description": { "content": "Cria o registro de colaborador para um `IDUser` existente. Valida em cascata: usuário pertence à empresa, escala existe na empresa, cada função informada existe, função atual está dentro da lista de funções, cada categoria/grupo de endereço informado pertence à empresa, supervisor (quando informado) existe.\n\n**Restrição**: cada usuário tem **apenas 1** registro `UserWorkingDay` por empresa — tentativa duplicada devolve `[BadRequest] - Colaborador já existe para esse usuário`.", "type": "text/plain" }, "url": { "path": [ "user", "workingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDUser\": 5047,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserWorkScale\": 4846,\n \"IDUserJobPositionCurrent\": 7695,\n \"IDUserUpper\": 9435,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c4e5251a-dfd3-46cb-91e0-95b68a4806af", "name": "Colaborador criado.", "originalRequest": { "url": { "path": [ "user", "workingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDUser\": 5047,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserWorkScale\": 4846,\n \"IDUserJobPositionCurrent\": 7695,\n \"IDUserUpper\": 9435,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDUserWorkingDay\": 6083,\n \"IDUser\": 9818,\n \"UserName\": \"string\",\n \"LastActivityTimestamp\": \"1973-12-28T05:13:52.225Z\",\n \"IDAcess\": 426,\n \"Status\": 2,\n \"IDUserWorkScale\": 3878,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 6267,\n \"WeekDay\": 9624,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n },\n {\n \"IDUserWorkShift\": 2926,\n \"WeekDay\": 9978,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n }\n ],\n \"IDUserJobPositionList\": \"string\",\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 388,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 5945,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4796,\n \"CurrentPositionName\": \"string\",\n \"IDUserUpper\": 8023,\n \"UserUpperName\": \"string\",\n \"Categories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 3487,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 2951,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"LocationsGroup\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 9675,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 5117,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c27d8a9-2ed3-47a1-b5ec-70bdd005e8ce", "name": "Validações: `[BadRequest] - Preencha os campos corretamente`; `[BadRequest] - Usuário não existe, preencha corretamente`; `[BadRequest] - Colaborador já existe para esse usuário`; `[BadRequest] - Função atual não atríbuida ao colaborador`; `[BadRequest] - Função não existente, preencha corretamente`; `[BadRequest] - Categoria de armazenamento não existe`; `[BadRequest] - Escala não existe, preencha corretamente`; `[BadRequest] - Grupo de armazenamento não existe`; `[BadRequest] - Colaborador superior não existe, preencha corretamente`; `[BadRequest] - Empresa não existe`; `[BadRequest] - Erro ao cadastrar colaborador`.", "originalRequest": { "url": { "path": [ "user", "workingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDUser\": 5047,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserWorkScale\": 4846,\n \"IDUserJobPositionCurrent\": 7695,\n \"IDUserUpper\": 9435,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "754aea73-0a3b-4ebb-ac82-ec8b183bc556", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "user", "workingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDUser\": 5047,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserWorkScale\": 4846,\n \"IDUserJobPositionCurrent\": 7695,\n \"IDUserUpper\": 9435,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7145dbc0-efe4-4a98-9174-0d83e0cef2fb", "name": "Atualiza um colaborador", "request": { "name": "Atualiza um colaborador", "description": { "content": "**Atualização parcial** — só os campos enviados são alterados (passar string vazia em `IDStockKeepingUnitLocationCategoryList`, `IDStockKeepingUnitLocationGroupList` ou `IDUserUpper` limpa o campo para NULL). Valida unicidade da escala/função/grupo dentro da empresa e proíbe colaborador ser próprio supervisor.", "type": "text/plain" }, "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDUser\": 3355,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 8344,\n \"IDUserWorkScale\": 9735,\n \"IDUserUpper\": 9661,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5f89e801-76b8-4015-851a-050123c53a2e", "name": "Colaborador atualizado.", "originalRequest": { "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDUser\": 3355,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 8344,\n \"IDUserWorkScale\": 9735,\n \"IDUserUpper\": 9661,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDUserWorkingDay\": 6083,\n \"IDUser\": 9818,\n \"UserName\": \"string\",\n \"LastActivityTimestamp\": \"1973-12-28T05:13:52.225Z\",\n \"IDAcess\": 426,\n \"Status\": 2,\n \"IDUserWorkScale\": 3878,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 6267,\n \"WeekDay\": 9624,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n },\n {\n \"IDUserWorkShift\": 2926,\n \"WeekDay\": 9978,\n \"StartTime\": \"string\",\n \"FinishTime\": \"string\"\n }\n ],\n \"IDUserJobPositionList\": \"string\",\n \"JobPositions\": [\n {\n \"IDUserJobPosition\": 388,\n \"UserJobPositionName\": \"string\"\n },\n {\n \"IDUserJobPosition\": 5945,\n \"UserJobPositionName\": \"string\"\n }\n ],\n \"IDUserJobPositionCurrent\": 4796,\n \"CurrentPositionName\": \"string\",\n \"IDUserUpper\": 8023,\n \"UserUpperName\": \"string\",\n \"Categories\": [\n {\n \"IDStockKeepingUnitLocationCategory\": 3487,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationCategory\": 2951,\n \"StockKeepingUnitLocationCategoryName\": \"string\"\n }\n ],\n \"LocationsGroup\": [\n {\n \"IDStockKeepingUnitLocationGroup\": 9675,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n },\n {\n \"IDStockKeepingUnitLocationGroup\": 5117,\n \"StockKeepingUnitLocationGroupName\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55165a3d-4f31-40cf-850f-1693b1363f60", "name": "Validações do POST + `[BadRequest] - Colaborador não existe`; `[BadRequest] - Colaborador não pode ser seu próprio supervisor`; `[BadRequest] - Preencha corretamente o status`; `[BadRequest] - Categoria armazém não existe ()`; `[BadRequest] - Grupo endereços não existe`.", "originalRequest": { "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDUser\": 3355,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 8344,\n \"IDUserWorkScale\": 9735,\n \"IDUserUpper\": 9661,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15de26c4-5a94-489d-973f-c2ce6d906088", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDUser\": 3355,\n \"IDUserJobPositionList\": \"string\",\n \"IDUserJobPositionCurrent\": 8344,\n \"IDUserWorkScale\": 9735,\n \"IDUserUpper\": 9661,\n \"IDStockKeepingUnitLocationCategoryList\": \"string\",\n \"IDStockKeepingUnitLocationGroupList\": \"string\",\n \"Status\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa9669ca-9407-4549-9c29-a424bf907d17", "name": "Exclui um colaborador", "request": { "name": "Exclui um colaborador", "description": { "content": "**Exclusão física**. Bloqueada quando o colaborador é supervisor de outro colaborador (verifica `IDUserUpper = ?`).", "type": "text/plain" }, "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "dcb2a546-2e46-42b4-89c1-5e818bb8998a", "name": "Colaborador excluído (string literal `Colaborador excluído com sucesso`).", "originalRequest": { "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeffd1fb-07ad-46f2-ba8a-452a6bdd2ca3", "name": "`[BadRequest] - Informe corretamente o colaborador`; `[BadRequest] - Colaborador não existe`; `[BadRequest] - Colaborador é supervisor de outros colaboradores e não pode ser excluído`.", "originalRequest": { "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "616aff77-2a51-4402-8303-400f27740053", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "user", "workingday", ":idworkingday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idworkingday", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d7032aa-03f8-444c-b048-a82e44c61723", "name": "Lista as escalas de trabalho da empresa", "request": { "name": "Lista as escalas de trabalho da empresa", "description": { "content": "Retorna as escalas de trabalho cadastradas, cada uma com a lista de turnos (`WorkShift`) — dia da semana, horário de início e fim. Aceita filtro opcional por uma escala específica.", "type": "text/plain" }, "url": { "path": [ "user", "workingday", "workscale" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDUserWorkScale", "value": "2232", "description": "Identificador da escala. Quando informado, restringe a resposta a essa escala." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "006fefc2-0cbf-4583-937c-d2b173cca3a2", "name": "Lista de escalas. Retorna `[]` quando não houver registros.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDUserWorkScale", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 1185,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 5900,\n \"IDUserWorkScale\": 2884,\n \"WeekDay\": 5,\n \"StartTime\": \"95:83\",\n \"FinishTime\": \"39:72\"\n },\n {\n \"IDUserWorkShift\": 4687,\n \"IDUserWorkScale\": 6180,\n \"WeekDay\": 5,\n \"StartTime\": \"36:40\",\n \"FinishTime\": \"70:46\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 6122,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 483,\n \"IDUserWorkScale\": 7865,\n \"WeekDay\": 5,\n \"StartTime\": \"87:99:88\",\n \"FinishTime\": \"14:93\"\n },\n {\n \"IDUserWorkShift\": 6856,\n \"IDUserWorkScale\": 9422,\n \"WeekDay\": 0,\n \"StartTime\": \"41:73\",\n \"FinishTime\": \"54:23:76\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2792ce20-05aa-4d97-80bd-016bbe55de9c", "name": "Cadastra uma nova escala de trabalho", "request": { "name": "Cadastra uma nova escala de trabalho", "description": { "content": "Cria uma escala vinculada à empresa autenticada. O nome precisa ser único dentro da empresa. Após a criação, devolve a escala recém-cadastrada já enriquecida com a lista de turnos (vazia neste momento).", "type": "text/plain" }, "url": { "path": [ "user", "workingday", "workscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserWorkScaleName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "633bc7a9-d06a-43a3-b2b3-a5f5641b9081", "name": "Escala cadastrada. Retorna a escala recém-criada conforme o formato de `GET /user/workingday/workscale`.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserWorkScaleName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 1807,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 2641,\n \"IDUserWorkScale\": 3171,\n \"WeekDay\": 5,\n \"StartTime\": \"59:15:52\",\n \"FinishTime\": \"85:36\"\n },\n {\n \"IDUserWorkShift\": 1739,\n \"IDUserWorkScale\": 4144,\n \"WeekDay\": 4,\n \"StartTime\": \"43:59:14\",\n \"FinishTime\": \"56:77\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 229,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 5117,\n \"IDUserWorkScale\": 6653,\n \"WeekDay\": 4,\n \"StartTime\": \"98:69\",\n \"FinishTime\": \"76:45\"\n },\n {\n \"IDUserWorkShift\": 737,\n \"IDUserWorkScale\": 971,\n \"WeekDay\": 1,\n \"StartTime\": \"20:76:73\",\n \"FinishTime\": \"95:93\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cbf67fa-9553-46e2-bf07-819a1fad4484", "name": "Mensagens conhecidas:\n- `[BadRequest] - Escala já existe`\n- `[BadRequest] - Erro ao adicionar escala`\n- `[BadRequest] - Empresa não existe`.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserWorkScaleName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8af20516-259c-482f-9e2b-ea5210f82ad2", "name": "Substitui os turnos de uma escala", "request": { "name": "Substitui os turnos de uma escala", "description": { "content": "Apaga todos os turnos atuais da escala informada e insere os turnos enviados em `shifts` no lugar — operação de substituição em bloco, não incremental. Cada turno define dia da semana `WeekDay` (0=domingo a 6=sábado), horário de início `StartTime` e horário de fim `FinishTime`. Após a gravação, devolve a escala atualizada com os novos turnos.", "type": "text/plain" }, "url": { "path": [ "user", "workingday", "workscale", "shift" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDUserWorkScale\": 3455,\n \"shifts\": [\n {\n \"WeekDay\": 4,\n \"StartTime\": \"18:24\",\n \"FinishTime\": \"02:85\"\n },\n {\n \"WeekDay\": 0,\n \"StartTime\": \"93:45:86\",\n \"FinishTime\": \"21:48\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "acfa4b73-19a7-4bd4-90a6-4afc20736d5c", "name": "Turnos gravados. Retorna a escala atualizada conforme o formato de `GET /user/workingday/workscale`.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale", "shift" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDUserWorkScale\": 2386,\n \"shifts\": [\n {\n \"WeekDay\": 2,\n \"StartTime\": \"04:44\",\n \"FinishTime\": \"02:86:27\"\n },\n {\n \"WeekDay\": 4,\n \"StartTime\": \"03:58:08\",\n \"FinishTime\": \"07:83:48\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 1807,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 2641,\n \"IDUserWorkScale\": 3171,\n \"WeekDay\": 5,\n \"StartTime\": \"59:15:52\",\n \"FinishTime\": \"85:36\"\n },\n {\n \"IDUserWorkShift\": 1739,\n \"IDUserWorkScale\": 4144,\n \"WeekDay\": 4,\n \"StartTime\": \"43:59:14\",\n \"FinishTime\": \"56:77\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 229,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 5117,\n \"IDUserWorkScale\": 6653,\n \"WeekDay\": 4,\n \"StartTime\": \"98:69\",\n \"FinishTime\": \"76:45\"\n },\n {\n \"IDUserWorkShift\": 737,\n \"IDUserWorkScale\": 971,\n \"WeekDay\": 1,\n \"StartTime\": \"20:76:73\",\n \"FinishTime\": \"95:93\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb24d929-6c1e-474e-9d8c-453ed560ea30", "name": "Mensagens conhecidas:\n- `[BadRequest] - Escala não existe`\n- `[BadRequest] - Preencha corretamente os campos Dia da semana, horário de início/fim e escala`\n- `[BadRequest] - Preencha corretamente o dia da semana`.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale", "shift" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDUserWorkScale\": 2386,\n \"shifts\": [\n {\n \"WeekDay\": 2,\n \"StartTime\": \"04:44\",\n \"FinishTime\": \"02:86:27\"\n },\n {\n \"WeekDay\": 4,\n \"StartTime\": \"03:58:08\",\n \"FinishTime\": \"07:83:48\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "508ec5a2-5743-48f8-9fe2-2931631aeefd", "name": "Renomeia uma escala de trabalho", "request": { "name": "Renomeia uma escala de trabalho", "description": { "content": "Altera o nome da escala. O novo nome precisa ser único na empresa.", "type": "text/plain" }, "url": { "path": [ "user", "workingday", "workscale", ":iduserworkscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduserworkscale", "description": "(Required) Identificador da escala a renomear." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserWorkScaleName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "16ba7f3f-8cd5-4a38-8705-e009c93952ea", "name": "Escala atualizada. Retorna a escala conforme o formato de `GET /user/workingday/workscale`.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale", ":iduserworkscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduserworkscale", "description": "(Required) Identificador da escala a renomear." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserWorkScaleName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 1807,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 2641,\n \"IDUserWorkScale\": 3171,\n \"WeekDay\": 5,\n \"StartTime\": \"59:15:52\",\n \"FinishTime\": \"85:36\"\n },\n {\n \"IDUserWorkShift\": 1739,\n \"IDUserWorkScale\": 4144,\n \"WeekDay\": 4,\n \"StartTime\": \"43:59:14\",\n \"FinishTime\": \"56:77\"\n }\n ]\n },\n {\n \"AccountName\": \"string\",\n \"IDUserWorkScale\": 229,\n \"UserWorkScaleName\": \"string\",\n \"WorkShift\": [\n {\n \"IDUserWorkShift\": 5117,\n \"IDUserWorkScale\": 6653,\n \"WeekDay\": 4,\n \"StartTime\": \"98:69\",\n \"FinishTime\": \"76:45\"\n },\n {\n \"IDUserWorkShift\": 737,\n \"IDUserWorkScale\": 971,\n \"WeekDay\": 1,\n \"StartTime\": \"20:76:73\",\n \"FinishTime\": \"95:93\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a71ba2-6e8c-4415-a10a-e609e1eca998", "name": "Mensagens conhecidas:\n- `[BadRequest] - Preencha corretamente o nome da escala`\n- `[BadRequest] - Escala já existente com esse nome`\n- `[BadRequest] - Escala não existe`\n- `[BadRequest] - Escala não atualizada`.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale", ":iduserworkscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduserworkscale", "description": "(Required) Identificador da escala a renomear." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserWorkScaleName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8899fd2a-c77a-45ca-8d5d-deaf8deb49f0", "name": "Exclui uma escala de trabalho", "request": { "name": "Exclui uma escala de trabalho", "description": { "content": "Remove a escala e seus turnos. Só é permitido excluir escalas que não estejam vinculadas a nenhum colaborador.", "type": "text/plain" }, "url": { "path": [ "user", "workingday", "workscale", ":iduserworkscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduserworkscale", "description": "(Required) Identificador da escala a excluir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "cfbb54f8-de32-4f5c-a719-36a8b4be1473", "name": "Escala excluída.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale", ":iduserworkscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduserworkscale", "description": "(Required) Identificador da escala a excluir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Escala excluída com sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed979004-c917-4796-8b10-36d147c22f4a", "name": "Mensagens conhecidas:\n- `[BadRequest] - Informe corretamente a escala`\n- `[BadRequest] - Há colaboradores com essa escala, altere antes de excluir`\n- `[BadRequest] - Escala não existe`.", "originalRequest": { "url": { "path": [ "user", "workingday", "workscale", ":iduserworkscale" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "iduserworkscale", "description": "(Required) Identificador da escala a excluir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5e871667-98c3-4129-9c9a-a63253682372", "name": "Kits", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "acdd1d9b-9c65-40d5-acf2-c1cfb00b49e4", "name": "Resumo dos kits (variantes) de um SKU", "request": { "name": "Resumo dos kits (variantes) de um SKU", "description": { "content": "Retorna o resumo de cada variante de kit do SKU (até 4 variantes), com quantidade montável, soma de preço/custo dos componentes e markup.", "type": "text/plain" }, "url": { "path": [ "sku", "kit", "summary", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bc076d5f-91df-4313-968c-69b45a3a1350", "name": "Resumo das variantes.", "originalRequest": { "url": { "path": [ "sku", "kit", "summary", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"index\": 5267,\n \"IDStockKeepingUnitKit\": 3377,\n \"Active\": 3490,\n \"Kit\": 4818,\n \"Priority\": 5847,\n \"QtyAvailable\": 2665,\n \"QtySku\": 9957,\n \"QtyItems\": 2764.489917375961,\n \"SumSellingPrice\": 3775.3738820603776,\n \"SumListPrice\": 3440.1337758118734,\n \"SumCostAverage\": 9595.390704077345,\n \"Markup\": \"string\"\n },\n {\n \"index\": 7303,\n \"IDStockKeepingUnitKit\": 7385,\n \"Active\": 6927,\n \"Kit\": 7739,\n \"Priority\": 7306,\n \"QtyAvailable\": 615,\n \"QtySku\": 2281,\n \"QtyItems\": 3166.573737076168,\n \"SumSellingPrice\": 4569.381784704902,\n \"SumListPrice\": 4902.8381282003265,\n \"SumCostAverage\": 2432.234106496478,\n \"Markup\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1885d7dd-8a2f-4edf-8f7b-99b8f0581ea4", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "kit", "summary", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "431ed518-47e7-441a-bbd5-b0717e6b53b1", "name": "Atualiza prioridade de uma variante de kit", "request": { "name": "Atualiza prioridade de uma variante de kit", "description": { "content": "Ajusta a prioridade de uma variante de kit do SKU. Aceita apenas para SKUs do tipo 1 ou 2.", "type": "text/plain" }, "url": { "path": [ "sku", "kit", "summary", ":idsku", ":idstockkeepingunitkit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkit", "description": "(Required) Identificador da variante de kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Priority\": 9395\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d5271a83-eb28-4bda-ab84-12f5c26df0da", "name": "Prioridade atualizada. Retorna `kitGet`.", "originalRequest": { "url": { "path": [ "sku", "kit", "summary", ":idsku", ":idstockkeepingunitkit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkit", "description": "(Required) Identificador da variante de kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Priority\": 9395\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 8690,\n \"IDSkuComponent\": 5235,\n \"Quantity\": 7561.001424527223,\n \"Kit\": 770,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 5169.726640176719,\n \"CostAverageTotal\": 3746.752932291584,\n \"CostSet\": 2511.338284062239,\n \"CostSetTotal\": 4910.62008811562,\n \"CostLastPurchase\": 2202.4123719910403,\n \"CostLastPurchaseTotal\": 5767.902804273582,\n \"QtyAvailable\": 8514.964879032623,\n \"PriceSell\": 62.919470455464754,\n \"PriceSellTotal\": 8279.50687344816,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2006-05-12T06:08:19.279Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 1383,\n \"IDSkuComponent\": 6223,\n \"Quantity\": 9894.225771170582,\n \"Kit\": 4586,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 2123.9505641483693,\n \"CostAverageTotal\": 5298.854265435957,\n \"CostSet\": 3226.31703510462,\n \"CostSetTotal\": 8382.906562785525,\n \"CostLastPurchase\": 9757.188572909115,\n \"CostLastPurchaseTotal\": 1334.0611828372894,\n \"QtyAvailable\": 2855.289286114073,\n \"PriceSell\": 6567.400913916417,\n \"PriceSellTotal\": 6483.49215355761,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2011-01-18T23:28:28.935Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19702c21-feef-4827-8e27-ae232142ce0d", "name": "SKU não localizado ou não suporta kit. Prefixo `[BadRequest]`. Mensagem: `Sku não existe`.", "originalRequest": { "url": { "path": [ "sku", "kit", "summary", ":idsku", ":idstockkeepingunitkit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkit", "description": "(Required) Identificador da variante de kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Priority\": 9395\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf16a944-5be1-450a-8b73-be3c3b30f639", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "kit", "summary", ":idsku", ":idstockkeepingunitkit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkit", "description": "(Required) Identificador da variante de kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Priority\": 9395\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec817ef6-3c19-4e47-b423-380304e3fc8f", "name": "Lista os componentes de um kit", "request": { "name": "Lista os componentes de um kit", "description": { "content": "Lista os componentes do kit selecionado (`kit=1..4`). Quando `Type=KitsRelated`, inverte a perspectiva e lista os kits em que este SKU aparece como componente.", "type": "text/plain" }, "url": { "path": [ "sku", "kit", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "kit", "value": "4", "description": "Variante do kit. Default `1`." }, { "disabled": false, "key": "Type", "value": "Components", "description": "`Components` lista componentes do kit do SKU; `KitsRelated` lista kits que usam este SKU como componente. Default `Components`." } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1f56b429-4d16-4f54-b2a4-40e73e3a2d11", "name": "Lista de componentes (ou kits relacionados).", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kit", "value": "4" }, { "key": "Type", "value": "Components" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 8690,\n \"IDSkuComponent\": 5235,\n \"Quantity\": 7561.001424527223,\n \"Kit\": 770,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 5169.726640176719,\n \"CostAverageTotal\": 3746.752932291584,\n \"CostSet\": 2511.338284062239,\n \"CostSetTotal\": 4910.62008811562,\n \"CostLastPurchase\": 2202.4123719910403,\n \"CostLastPurchaseTotal\": 5767.902804273582,\n \"QtyAvailable\": 8514.964879032623,\n \"PriceSell\": 62.919470455464754,\n \"PriceSellTotal\": 8279.50687344816,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2006-05-12T06:08:19.279Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 1383,\n \"IDSkuComponent\": 6223,\n \"Quantity\": 9894.225771170582,\n \"Kit\": 4586,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 2123.9505641483693,\n \"CostAverageTotal\": 5298.854265435957,\n \"CostSet\": 3226.31703510462,\n \"CostSetTotal\": 8382.906562785525,\n \"CostLastPurchase\": 9757.188572909115,\n \"CostLastPurchaseTotal\": 1334.0611828372894,\n \"QtyAvailable\": 2855.289286114073,\n \"PriceSell\": 6567.400913916417,\n \"PriceSellTotal\": 6483.49215355761,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2011-01-18T23:28:28.935Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8c60e1e-1970-4a88-aaf5-11f16a79ac8c", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kit", "value": "4" }, { "key": "Type", "value": "Components" } ], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40a19348-6623-486a-bd55-c70e0f6ad516", "name": "Adiciona um componente ao kit", "request": { "name": "Adiciona um componente ao kit", "description": { "content": "Adiciona um SKU componente à variante de kit do SKU pai. Quando a empresa usa atualização automática de medidas de kit, recalcula peso e dimensões do SKU pai a partir dos componentes.", "type": "text/plain" }, "url": { "path": [ "sku", "kit", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 759,\n \"Quantity\": 243.52055671823746,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8f0dc971-b84c-43cf-9b4b-57bbc7219543", "name": "Componente adicionado. Retorna `kitGet`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 759,\n \"Quantity\": 243.52055671823746,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 8690,\n \"IDSkuComponent\": 5235,\n \"Quantity\": 7561.001424527223,\n \"Kit\": 770,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 5169.726640176719,\n \"CostAverageTotal\": 3746.752932291584,\n \"CostSet\": 2511.338284062239,\n \"CostSetTotal\": 4910.62008811562,\n \"CostLastPurchase\": 2202.4123719910403,\n \"CostLastPurchaseTotal\": 5767.902804273582,\n \"QtyAvailable\": 8514.964879032623,\n \"PriceSell\": 62.919470455464754,\n \"PriceSellTotal\": 8279.50687344816,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2006-05-12T06:08:19.279Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 1383,\n \"IDSkuComponent\": 6223,\n \"Quantity\": 9894.225771170582,\n \"Kit\": 4586,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 2123.9505641483693,\n \"CostAverageTotal\": 5298.854265435957,\n \"CostSet\": 3226.31703510462,\n \"CostSetTotal\": 8382.906562785525,\n \"CostLastPurchase\": 9757.188572909115,\n \"CostLastPurchaseTotal\": 1334.0611828372894,\n \"QtyAvailable\": 2855.289286114073,\n \"PriceSell\": 6567.400913916417,\n \"PriceSellTotal\": 6483.49215355761,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2011-01-18T23:28:28.935Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "685bd9bb-aa68-402f-a956-361ab07bee2b", "name": "Validação falhou. Prefixo `[BadRequest]`. Mensagens: `Quantidade precisa ser maior que 0`, `Sku não existe`, `Sku Componente não existe`, `Componente não é do tipo normal`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 759,\n \"Quantity\": 243.52055671823746,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da051663-7a87-4f2b-bfe1-313183f62e54", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 759,\n \"Quantity\": 243.52055671823746,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7e1f421-da90-4a6f-a1d6-895bb4b09e63", "name": "Atualiza um componente do kit", "request": { "name": "Atualiza um componente do kit", "description": { "content": "Troca o SKU componente, quantidade ou variante de kit do item. Recalcula medidas do SKU pai quando a atualização automática está habilitada.", "type": "text/plain" }, "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 8335,\n \"Quantity\": 142.69936258708205,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70d38b1d-18de-4937-8abb-7165993f6f06", "name": "Componente atualizado. Retorna `kitGet`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 8335,\n \"Quantity\": 142.69936258708205,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 8690,\n \"IDSkuComponent\": 5235,\n \"Quantity\": 7561.001424527223,\n \"Kit\": 770,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 5169.726640176719,\n \"CostAverageTotal\": 3746.752932291584,\n \"CostSet\": 2511.338284062239,\n \"CostSetTotal\": 4910.62008811562,\n \"CostLastPurchase\": 2202.4123719910403,\n \"CostLastPurchaseTotal\": 5767.902804273582,\n \"QtyAvailable\": 8514.964879032623,\n \"PriceSell\": 62.919470455464754,\n \"PriceSellTotal\": 8279.50687344816,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2006-05-12T06:08:19.279Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 1383,\n \"IDSkuComponent\": 6223,\n \"Quantity\": 9894.225771170582,\n \"Kit\": 4586,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 2123.9505641483693,\n \"CostAverageTotal\": 5298.854265435957,\n \"CostSet\": 3226.31703510462,\n \"CostSetTotal\": 8382.906562785525,\n \"CostLastPurchase\": 9757.188572909115,\n \"CostLastPurchaseTotal\": 1334.0611828372894,\n \"QtyAvailable\": 2855.289286114073,\n \"PriceSell\": 6567.400913916417,\n \"PriceSellTotal\": 6483.49215355761,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2011-01-18T23:28:28.935Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7bf2137-6b99-4374-82ae-e192b7a70a45", "name": "Prefixo `[BadRequest]`. Mensagens: `Quantidade precisa ser maior que 0`, `Sku não existe`, `Sku Componente não existe`, `Componente não é do tipo normal`, `Erro ao processar a solicitação`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 8335,\n \"Quantity\": 142.69936258708205,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8748a3a0-fdfd-461f-8745-fc419bdd04a2", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDSkuComponent\": 8335,\n \"Quantity\": 142.69936258708205,\n \"Kit\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c0ee1ac-ca8a-471a-b184-3863516e3059", "name": "Remove um componente do kit", "request": { "name": "Remove um componente do kit", "description": { "content": "Remove o componente do kit. Recalcula medidas do SKU pai quando a atualização automática está habilitada.", "type": "text/plain" }, "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "30319205-ea30-4b98-b719-7bda17a36ba8", "name": "Componente removido. Retorna `kitGet`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 8690,\n \"IDSkuComponent\": 5235,\n \"Quantity\": 7561.001424527223,\n \"Kit\": 770,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 5169.726640176719,\n \"CostAverageTotal\": 3746.752932291584,\n \"CostSet\": 2511.338284062239,\n \"CostSetTotal\": 4910.62008811562,\n \"CostLastPurchase\": 2202.4123719910403,\n \"CostLastPurchaseTotal\": 5767.902804273582,\n \"QtyAvailable\": 8514.964879032623,\n \"PriceSell\": 62.919470455464754,\n \"PriceSellTotal\": 8279.50687344816,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2006-05-12T06:08:19.279Z\"\n },\n {\n \"AccountName\": \"string\",\n \"IDStockKeepingUnitKitItems\": 1383,\n \"IDSkuComponent\": 6223,\n \"Quantity\": 9894.225771170582,\n \"Kit\": 4586,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"CostAverage\": 2123.9505641483693,\n \"CostAverageTotal\": 5298.854265435957,\n \"CostSet\": 3226.31703510462,\n \"CostSetTotal\": 8382.906562785525,\n \"CostLastPurchase\": 9757.188572909115,\n \"CostLastPurchaseTotal\": 1334.0611828372894,\n \"QtyAvailable\": 2855.289286114073,\n \"PriceSell\": 6567.400913916417,\n \"PriceSellTotal\": 6483.49215355761,\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"RecordTimestamp\": \"2011-01-18T23:28:28.935Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca4d7788-c54c-4b22-8e2d-b9680724c546", "name": "Prefixo `[BadRequest]`. Mensagens: `Sku não existe`, `Falha ao deletar item kit`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36cce3eb-192a-4309-a600-06b41cd28282", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "kit", ":idsku", ":idstockkeepingunitkititems" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idstockkeepingunitkititems", "description": "(Required) Identificador do componente dentro do kit." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "92c813e8-67b0-474d-bb00-f8366e0df6d2", "name": "Log de SKU", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4555d465-5433-4797-8961-49e4c9213502", "name": "Lista logs de integração de SKU", "request": { "name": "Lista logs de integração de SKU", "description": { "content": "Lista o histórico de integração dos SKUs (envios para hubs, alterações registradas). Paginação fixa de 4000 registros por página em ordem decrescente de id.", "type": "text/plain" }, "url": { "path": [ "sku", "log" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "2232", "description": "Página (offset = `Page * 5000`)." }, { "disabled": false, "key": "IDSku", "value": "2232", "description": "Filtra pelo identificador do produto/SKU." }, { "disabled": false, "key": "IDSkuCompany", "value": "string", "description": "Código de referência (busca `LIKE`)." }, { "disabled": false, "key": "SkuName", "value": "string", "description": "Nome do SKU (busca `LIKE`)." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "Filtra pelo identificador da integração da empresa." }, { "disabled": false, "key": "IDHubProduct", "value": "2232", "description": "Filtra pelo identificador do produto no hub." }, { "disabled": false, "key": "IDAction", "value": "2232", "description": "Tipo de ação (`IDSkuAction`)." }, { "disabled": false, "key": "Status", "value": "2232", "description": "Filtra por `Header`: `1` sucesso, `2` inativo, outros = erro." }, { "disabled": false, "key": "DateFrom", "value": "1978-04-10T08:52:42.717Z", "description": "Início do intervalo de datas no filtro (formato `YYYY-MM-DD`)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Fim do intervalo de datas no filtro (formato `YYYY-MM-DD`)." }, { "disabled": false, "key": "IDStockKeepingUnitIntegrationLog", "value": "2232", "description": "Filtra pelo identificador do log de integração do SKU." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7470170b-dd87-465a-aecf-f6b8606eac4b", "name": "Lista de logs.", "originalRequest": { "url": { "path": [ "sku", "log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "2232" }, { "key": "IDSku", "value": "2232" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDHubProduct", "value": "2232" }, { "key": "IDAction", "value": "2232" }, { "key": "Status", "value": "2232" }, { "key": "DateFrom", "value": "1978-04-10T08:52:42.717Z" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDStockKeepingUnitIntegrationLog", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDStockKeepingUnitIntegrationLog\": 6764,\n \"AccountName\": \"string\",\n \"IDSku\": 7582,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Comments\": \"string\",\n \"Header\": 6657,\n \"Status\": \"string\",\n \"IDAction\": 52,\n \"ActionName\": \"string\",\n \"IDHubProduct\": 887,\n \"IDCompanyIntegration\": 2433,\n \"CompanyIntegration\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"RecordTimestamp\": \"1982-05-18T23:07:54.263Z\"\n },\n {\n \"IDStockKeepingUnitIntegrationLog\": 6017,\n \"AccountName\": \"string\",\n \"IDSku\": 5055,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"Comments\": \"string\",\n \"Header\": 5650,\n \"Status\": \"string\",\n \"IDAction\": 166,\n \"ActionName\": \"string\",\n \"IDHubProduct\": 2696,\n \"IDCompanyIntegration\": 6179,\n \"CompanyIntegration\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"RecordTimestamp\": \"1982-07-04T00:03:12.637Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d525fca4-ff1c-482c-a635-2de85c4d3d48", "name": "Erro de configuração da empresa. Prefixo `[BadRequest]`.", "originalRequest": { "url": { "path": [ "sku", "log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "2232" }, { "key": "IDSku", "value": "2232" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDHubProduct", "value": "2232" }, { "key": "IDAction", "value": "2232" }, { "key": "Status", "value": "2232" }, { "key": "DateFrom", "value": "1978-04-10T08:52:42.717Z" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDStockKeepingUnitIntegrationLog", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ae2cb73-eb60-4684-adaf-1f78bf1175ab", "name": "Erro interno. Prefixo `Error:`.", "originalRequest": { "url": { "path": [ "sku", "log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "2232" }, { "key": "IDSku", "value": "2232" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDHubProduct", "value": "2232" }, { "key": "IDAction", "value": "2232" }, { "key": "Status", "value": "2232" }, { "key": "DateFrom", "value": "1978-04-10T08:52:42.717Z" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "IDStockKeepingUnitIntegrationLog", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9909c0bf-c69b-42ec-85a2-bd99dc24df45", "name": "Logs de Webhook", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4b37cdef-25aa-4cc5-9716-c5335f8e3185", "name": "Lista logs de envio de webhook", "request": { "name": "Lista logs de envio de webhook", "description": { "content": "Retorna o histórico de tentativas de envio de webhook da empresa, do mais recente para o mais antigo. Cada item representa **uma tentativa** de envio identificada pelo `UUID` da mensagem SQS — o campo `Attempts` indica quantas vezes a tentativa foi retentada. Aceita filtros opcionais por `Topic`, `Status`, faixa de data e paginação (2000 registros por página).\n\nFluxo de origem dos registros: quando uma ação habilitada no idworks ocorre (criar SKU, emitir NF, atualizar tracking, etc.), o sistema enfileira a notificação para envio ao webhook. O consumidor (`webhookPost`) lê a fila, consulta o endpoint e as credenciais configuradas para a empresa na integração `Webhook` (`IDTypeCompanyIntegration=52`), faz `POST` no endpoint do cliente com timeout de 10s e grava o resultado nesta tabela (`Status = 1` em sucesso, `Status = 0` em erro). Falhas voltam para a fila e incrementam `Attempts` na próxima tentativa.", "type": "text/plain" }, "url": { "path": [ "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Page", "value": "4675", "description": "Página (zero-based). Cada página devolve no máximo 2000 itens. Default: 0." }, { "disabled": false, "key": "Topic", "value": "string", "description": "Filtra pelo nome técnico do tópico (`SkuPost`, `InvoiceIssue`, `OrderStatus`, etc.). Match exato." }, { "disabled": false, "key": "Status", "value": "1", "description": "Filtra pelo status do envio: `1` = sucesso (o destino respondeu 2xx), `0` = erro." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial (inclusive) do `RecordTimestamp`. Combina com `DateTo`." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final do `RecordTimestamp`, inclusivo até `23:59:59`. Combina com `DateFrom`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "78271fb7-fed4-4ae1-86e4-f251c12be259", "name": "Lista de tentativas (até 2000 por página).", "originalRequest": { "url": { "path": [ "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "Topic", "value": "string" }, { "key": "Status", "value": "1" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDWebhookLog\": 2080,\n \"RecordTimestamp\": \"1982-11-25T07:06:56.429Z\",\n \"IDCompany\": 6237,\n \"AccountName\": \"string\",\n \"Topic\": \"string\",\n \"EndPoint\": \"string\",\n \"PostData\": \"string\",\n \"ResponseData\": \"string\",\n \"Status\": 0,\n \"StatusName\": \"Sucesso\",\n \"Attempts\": 65\n },\n {\n \"IDWebhookLog\": 7872,\n \"RecordTimestamp\": \"2024-08-21T12:33:16.868Z\",\n \"IDCompany\": 1989,\n \"AccountName\": \"string\",\n \"Topic\": \"string\",\n \"EndPoint\": \"string\",\n \"PostData\": \"string\",\n \"ResponseData\": \"string\",\n \"Status\": 0,\n \"StatusName\": \"Sucesso\",\n \"Attempts\": 1978\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4583fdc-f7bc-4d6c-a6b8-35921627a7c6", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "webhook" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Page", "value": "4675" }, { "key": "Topic", "value": "string" }, { "key": "Status", "value": "1" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "26db71ca-59dc-4603-9d62-5e0fa8c035c6", "name": "Logística Reversa Correios", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ae5b3b45-818c-41e1-92aa-7af5017be0b4", "name": "Lista as solicitações de logística reversa Correios", "request": { "name": "Lista as solicitações de logística reversa Correios", "description": { "content": "Retorna as coletas reversas abertas para os pedidos da empresa, com identificador da coleta, prazo, transportadora associada e origens do pedido. Pagina por blocos de 3.000 registros (`Page`) limitando 1.000 por página.", "type": "text/plain" }, "url": { "path": [ "correios", "reversa" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Order", "value": "string", "description": "Filtra pelo número do pedido (busca parcial via `LIKE`)." }, { "disabled": false, "key": "OrderFrom", "value": "string", "description": "Filtra por uma origem associada ao pedido." }, { "disabled": false, "key": "IDColeta", "value": "string", "description": "Filtra pelo código da coleta Correios (busca parcial via `LIKE`)." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial de criação da coleta reversa." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final de criação da coleta reversa. O sistema concatena `23:59:59`." }, { "disabled": false, "key": "DateReverseDeadlineFrom", "value": "1980-02-08", "description": "Data inicial do prazo da coleta." }, { "disabled": false, "key": "DateReverseDeadlineTo", "value": "1980-02-08", "description": "Data final do prazo da coleta. O sistema concatena `23:59:59`." }, { "disabled": false, "key": "Page", "value": "4675", "description": "Número da página. Cada página retorna até 1.000 registros, com offset de 3.000 por página." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4662561c-e459-4e8b-ac12-f7d0ab061fab", "name": "Coletas retornadas.", "originalRequest": { "url": { "path": [ "correios", "reversa" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Order", "value": "string" }, { "key": "OrderFrom", "value": "string" }, { "key": "IDColeta", "value": "string" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "DateReverseDeadlineFrom", "value": "1980-02-08" }, { "key": "DateReverseDeadlineTo", "value": "1980-02-08" }, { "key": "Page", "value": "4675" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCorreiosReverso\": 1850,\n \"IDOrder\": 3668,\n \"IDColeta\": \"string\",\n \"SRO\": \"string\",\n \"Prazo\": \"2009-06-01\",\n \"RecordTimestamp\": \"2016-04-03T07:56:08.115Z\",\n \"TipoColeta\": \"string\",\n \"IDCarrier\": 4039,\n \"Order\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"OrderFrom\": \"string\"\n },\n {\n \"IDCorreiosReverso\": 17,\n \"IDOrder\": 1620,\n \"IDColeta\": \"string\",\n \"SRO\": \"string\",\n \"Prazo\": \"2010-05-04\",\n \"RecordTimestamp\": \"1975-03-06T08:52:30.599Z\",\n \"TipoColeta\": \"string\",\n \"IDCarrier\": 7957,\n \"Order\": \"string\",\n \"AccountName\": \"string\",\n \"SupplierNameCorporateName\": \"string\",\n \"OrderFrom\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c443146-6561-48d3-9be0-0b6360b8adc4", "name": "Solicita uma coleta reversa Correios", "request": { "name": "Solicita uma coleta reversa Correios", "description": { "content": "Encaminha a solicitação de postagem reversa ao processo dos Correios. Aceita coleta domiciliar (`TipoColeta` informado) ou postagem em agência (`TipoColeta=0`, valor padrão quando omitido).", "type": "text/plain" }, "url": { "path": [ "correios", "reversa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDOrder\": 6043,\n \"IDCarrier\": 3391,\n \"QtyObject\": 4898,\n \"TipoColeta\": 4474,\n \"Schedule\": {\n \"DateCollect\": \"2018-08-04\",\n \"PeriodCollect\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2e877d67-8b0b-49cb-9955-fc2186c5d71a", "name": "Solicitação aceita. Retorna o literal `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "correios", "reversa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDOrder\": 6043,\n \"IDCarrier\": 3391,\n \"QtyObject\": 4898,\n \"TipoColeta\": 4474,\n \"Schedule\": {\n \"DateCollect\": \"2018-08-04\",\n \"PeriodCollect\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d26464d8-218e-4864-b5c3-48910c92921b", "name": "Erro retornado pelo processo dos Correios. Mensagem propagada do serviço externo.", "originalRequest": { "url": { "path": [ "correios", "reversa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDOrder\": 6043,\n \"IDCarrier\": 3391,\n \"QtyObject\": 4898,\n \"TipoColeta\": 4474,\n \"Schedule\": {\n \"DateCollect\": \"2018-08-04\",\n \"PeriodCollect\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2dbd3f21-7325-4d55-8060-a924dc980449", "name": "Lotes", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d3a48d2e-3344-41d5-ab32-47aa2d28fcc9", "name": "Lista lotes e endereços de SKU", "request": { "name": "Lista lotes e endereços de SKU", "description": { "content": "Lista os lotes de SKU da empresa com dados do produto, do endereço de armazenagem (armazém, centro de distribuição, grupo, categoria e tipo de endereço), validade, data de fabricação, comentários e saldos calculados: saldo do lote `BatchBalance`, quantidade em movimentação `QtyHandling` e saldo disponível do SKU no armazém `QtyAvailable`. Retorna também preço de venda `PriceSell` e preço de tabela `PriceList`; ao informar uma política comercial em `IDCompanySalesPolicy`, os preços seguem essa política e, havendo promoção ativa, o desconto percentual `PercentualDiscountValue` é aplicado ao `PriceSell`. Considera apenas SKUs não deletados dos tipos Sku, Matéria-prima e Uso e consumo. Respeita a restrição de centros de distribuição do usuário e o compartilhamento de estoque entre empresas relacionadas.", "type": "text/plain" }, "url": { "path": [ "sku", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDSku", "value": "2232", "description": "Filtra pelo identificador do produto/SKU." }, { "disabled": false, "key": "IDBatch", "value": "2232", "description": "Filtra pelo identificador do lote." }, { "disabled": false, "key": "IDStockKeepingUnitLocation", "value": "2232", "description": "Filtra pelo identificador da localização do SKU." }, { "disabled": false, "key": "IDStockKeepingUnitWarehouse", "value": "2232", "description": "Filtra pelo identificador do depósito do SKU." }, { "disabled": false, "key": "IDStockKeepingUnitDistributionCenter", "value": "string", "description": "Aceita CSV." }, { "disabled": false, "key": "SkuName", "value": "string", "description": "Filtra pelo nome do produto (busca parcial)." }, { "disabled": false, "key": "IDSkuCompany", "value": "string", "description": "Código de referência do SKU (`LIKE`)." }, { "disabled": false, "key": "BarCode", "value": "string", "description": "Filtra pelo código de barras do produto." }, { "disabled": false, "key": "Address", "value": "string", "description": "Filtra pelo logradouro do endereço (busca parcial)." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "`BestBeforeDate` ≥ data." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "`BestBeforeDate` ≤ data." }, { "disabled": false, "key": "Status", "value": "1", "description": "`1` lotes Ativos (com saldo), `0` Inativos (sem saldo)." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca multi-campo (SKU, nome, endereço, código de barras). `nulladdress` filtra lotes sem endereço." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Número da página da listagem (1-based). Padrão `1`." }, { "disabled": false, "key": "IDCompanySalesPolicy", "value": "2232", "description": "Identificador da política comercial usada para calcular os preços `PriceSell` e `PriceList` de cada lote. Quando informada e diferente da política padrão, promoções ativas do SKU também são aplicadas (desconto retornado em `PercentualDiscountValue`). Quando omitida, usa a política comercial padrão da empresa." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2252a27d-8c88-45b1-9ac8-a60ef3a6b111", "name": "Lista de lotes.", "originalRequest": { "url": { "path": [ "sku", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDSku", "value": "2232" }, { "key": "IDBatch", "value": "2232" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "Address", "value": "string" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Status", "value": "1" }, { "key": "Search", "value": "string" }, { "key": "Page", "value": "2232" }, { "key": "IDCompanySalesPolicy", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDBatchNumber\": 8710,\n \"IDSku\": 5453,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 0,\n \"IDStockKeepingUnitLocation\": 7925,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 4604,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 4263,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 2574,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 408,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"IDTypeAddress\": 1,\n \"TypeAddress\": \"string\",\n \"BestBeforeDate\": \"1967-07-30\",\n \"ManufacturingDate\": \"2017-07-29\",\n \"Comments\": \"string\",\n \"Default\": 0,\n \"IDTypeSku\": 4996,\n \"AbcCurve\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"BatchBalance\": 3.890578490024499,\n \"QtyHandling\": 3401.1545651304154,\n \"QtyAvailable\": 6458.227623573946,\n \"IDBatchStatus\": 0,\n \"BatchStatus\": \"Ativo\",\n \"BatchDAgeInDays\": 7297,\n \"RecordTimestamp\": \"1990-01-22T05:47:17.168Z\",\n \"PriceSell\": 7175.299908016242,\n \"PriceList\": 2251.6242264492403,\n \"PercentualDiscountValue\": 5211.3067102028435\n },\n {\n \"AccountName\": \"string\",\n \"IDBatchNumber\": 9468,\n \"IDSku\": 5186,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 1,\n \"IDStockKeepingUnitLocation\": 6990,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 5599,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 6495,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 6561,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 1073,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"IDTypeAddress\": 2,\n \"TypeAddress\": \"string\",\n \"BestBeforeDate\": \"1983-05-29\",\n \"ManufacturingDate\": \"1993-12-21\",\n \"Comments\": \"string\",\n \"Default\": 1,\n \"IDTypeSku\": 9,\n \"AbcCurve\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"BatchBalance\": 187.15396975478748,\n \"QtyHandling\": 7320.448142527487,\n \"QtyAvailable\": 6587.3972452293965,\n \"IDBatchStatus\": 0,\n \"BatchStatus\": \"Ativo\",\n \"BatchDAgeInDays\": 3822,\n \"RecordTimestamp\": \"1954-09-19T19:34:06.656Z\",\n \"PriceSell\": 6678.847711993496,\n \"PriceList\": 1893.2423964543466,\n \"PercentualDiscountValue\": 7835.489166257621\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f261214-ab3d-4526-a394-253aefa905af", "name": "Validação falhou. Prefixo `[BadRequest]`. Mensagem: `Política comercial não existe` — quando `IDCompanySalesPolicy` é informado mas não corresponde a nenhuma política comercial da empresa.", "originalRequest": { "url": { "path": [ "sku", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDSku", "value": "2232" }, { "key": "IDBatch", "value": "2232" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "Address", "value": "string" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Status", "value": "1" }, { "key": "Search", "value": "string" }, { "key": "Page", "value": "2232" }, { "key": "IDCompanySalesPolicy", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12cf7add-96f2-40ec-9058-8b538aa3981e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDSku", "value": "2232" }, { "key": "IDBatch", "value": "2232" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitDistributionCenter", "value": "string" }, { "key": "SkuName", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "Address", "value": "string" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "Status", "value": "1" }, { "key": "Search", "value": "string" }, { "key": "Page", "value": "2232" }, { "key": "IDCompanySalesPolicy", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6e841bd-5f51-4343-9f03-15efc59a815b", "name": "Cria lote para um SKU", "request": { "name": "Cria lote para um SKU", "description": { "content": "Cria um lote no SKU em um endereço específico. Validações:\n\n- **SKU sem controle de lote** (`Batch != 1`): se já existe lote desse SKU no endereço, devolve `[BadRequest] - SKU já tem este endereço`.\n- **Endereço** precisa pertencer à empresa (ou empresa relacionada com `ShareSkuLocationWithRelatedCompanies = 1`).\n- Quando `Default = 1`, zera o `Default` dos demais lotes do SKU antes de inserir.", "type": "text/plain" }, "url": { "path": [ "sku", "batch", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitLocation\": 1134,\n \"BestBeforeDate\": \"1953-06-26\",\n \"Comments\": \"string\",\n \"Default\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f99e6fe3-eab1-4db5-8bd0-f43203e77837", "name": "Lote criado.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitLocation\": 1134,\n \"BestBeforeDate\": \"1953-06-26\",\n \"Comments\": \"string\",\n \"Default\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDBatchNumber\": 4983,\n \"IDSku\": 7630,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 0,\n \"IDStockKeepingUnitLocation\": 7032,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 520,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 3309,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 441,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 5561,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"IDTypeAddress\": 3,\n \"TypeAddress\": \"string\",\n \"BestBeforeDate\": \"1967-01-02\",\n \"ManufacturingDate\": \"1984-01-18\",\n \"Comments\": \"string\",\n \"Default\": 0,\n \"IDTypeSku\": 8663,\n \"AbcCurve\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"BatchBalance\": 5194.492380798899,\n \"QtyHandling\": 7890.39114801076,\n \"QtyAvailable\": 8834.636020518612,\n \"IDBatchStatus\": 1,\n \"BatchStatus\": \"Inativo\",\n \"BatchDAgeInDays\": 8243,\n \"RecordTimestamp\": \"1952-03-11T20:21:21.008Z\",\n \"PriceSell\": 4427.101453813202,\n \"PriceList\": 9407.403955702363,\n \"PercentualDiscountValue\": 1829.121719569926\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6a65ba6-16a3-4e70-80d4-e503e741932f", "name": "`[BadRequest] - SKU não existe`; `[BadRequest] - SKU já tem este endereço`; `[BadRequest] - Endereço SKU não existe`.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitLocation\": 1134,\n \"BestBeforeDate\": \"1953-06-26\",\n \"Comments\": \"string\",\n \"Default\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3199c355-a66a-453f-879f-e365dfc96fd9", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDStockKeepingUnitLocation\": 1134,\n \"BestBeforeDate\": \"1953-06-26\",\n \"Comments\": \"string\",\n \"Default\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e9655de-b935-4923-b08f-e7e5ad6f3792", "name": "Atualiza lote (id no body)", "request": { "name": "Atualiza lote (id no body)", "description": { "content": "Versão do PUT em que o `IDBatch` vem no corpo. Mesmas validações do PUT por path.", "type": "text/plain" }, "url": { "path": [ "sku", "batch", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBatch\": 6497,\n \"IDStockKeepingUnitLocation\": 3452,\n \"BestBeforeDate\": \"1951-07-12\",\n \"ManufacturingDate\": \"1982-07-25\",\n \"Comments\": \"string\",\n \"Default\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "278d7533-d4ab-49eb-9c06-dbbc872e3909", "name": "Atualizado.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDBatch\": 6497,\n \"IDStockKeepingUnitLocation\": 3452,\n \"BestBeforeDate\": \"1951-07-12\",\n \"ManufacturingDate\": \"1982-07-25\",\n \"Comments\": \"string\",\n \"Default\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDBatchNumber\": 8710,\n \"IDSku\": 5453,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 0,\n \"IDStockKeepingUnitLocation\": 7925,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 4604,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 4263,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 2574,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 408,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"IDTypeAddress\": 1,\n \"TypeAddress\": \"string\",\n \"BestBeforeDate\": \"1967-07-30\",\n \"ManufacturingDate\": \"2017-07-29\",\n \"Comments\": \"string\",\n \"Default\": 0,\n \"IDTypeSku\": 4996,\n \"AbcCurve\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"BatchBalance\": 3.890578490024499,\n \"QtyHandling\": 3401.1545651304154,\n \"QtyAvailable\": 6458.227623573946,\n \"IDBatchStatus\": 0,\n \"BatchStatus\": \"Ativo\",\n \"BatchDAgeInDays\": 7297,\n \"RecordTimestamp\": \"1990-01-22T05:47:17.168Z\",\n \"PriceSell\": 7175.299908016242,\n \"PriceList\": 2251.6242264492403,\n \"PercentualDiscountValue\": 5211.3067102028435\n },\n {\n \"AccountName\": \"string\",\n \"IDBatchNumber\": 9468,\n \"IDSku\": 5186,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 1,\n \"IDStockKeepingUnitLocation\": 6990,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 5599,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 6495,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 6561,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 1073,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"IDTypeAddress\": 2,\n \"TypeAddress\": \"string\",\n \"BestBeforeDate\": \"1983-05-29\",\n \"ManufacturingDate\": \"1993-12-21\",\n \"Comments\": \"string\",\n \"Default\": 1,\n \"IDTypeSku\": 9,\n \"AbcCurve\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"BatchBalance\": 187.15396975478748,\n \"QtyHandling\": 7320.448142527487,\n \"QtyAvailable\": 6587.3972452293965,\n \"IDBatchStatus\": 0,\n \"BatchStatus\": \"Ativo\",\n \"BatchDAgeInDays\": 3822,\n \"RecordTimestamp\": \"1954-09-19T19:34:06.656Z\",\n \"PriceSell\": 6678.847711993496,\n \"PriceList\": 1893.2423964543466,\n \"PercentualDiscountValue\": 7835.489166257621\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6430efb7-5309-49ae-ae99-d51814dc9198", "name": "Atualiza lote", "request": { "name": "Atualiza lote", "description": { "content": "Atualiza validade (`BestBeforeDate`), fabricação (`ManufacturingDate`), endereço, descrição (`Comments`) e flag de padrão. Validações:\n\n- `ManufacturingDate ≤ BestBeforeDate` e `ManufacturingDate ≤ 2099-12-31`.\n- `IDStockKeepingUnitLocation = null` é rejeitado (`Endereço não pode ser removido`).\n- Endereço novo precisa pertencer ao **mesmo armazém** do endereço atual (ou empresa relacionada).\n- Quando seta `Default = 1`, zera os demais lotes do SKU.\n\nRequer privilégio `PrivilegeSkuBatch` (Editar Validade Lote Sku).", "type": "text/plain" }, "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDBatch\": 6497,\n \"IDStockKeepingUnitLocation\": 3452,\n \"BestBeforeDate\": \"1951-07-12\",\n \"ManufacturingDate\": \"1982-07-25\",\n \"Comments\": \"string\",\n \"Default\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "582899bb-d9e6-48c0-aa2a-e342f567073c", "name": "Lote atualizado.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDBatch\": 6497,\n \"IDStockKeepingUnitLocation\": 3452,\n \"BestBeforeDate\": \"1951-07-12\",\n \"ManufacturingDate\": \"1982-07-25\",\n \"Comments\": \"string\",\n \"Default\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDBatchNumber\": 4983,\n \"IDSku\": 7630,\n \"IDSkuCompany\": \"string\",\n \"SkuName\": \"string\",\n \"BarCode\": \"string\",\n \"Batch\": 0,\n \"IDStockKeepingUnitLocation\": 7032,\n \"Address\": \"string\",\n \"IDStockKeepingUnitWarehouse\": 520,\n \"WarehouseName\": \"string\",\n \"IDStockKeepingUnitDistributionCenter\": 3309,\n \"DistributionCenterName\": \"string\",\n \"IDStockKeepingUnitLocationCategory\": 441,\n \"StockKeepingUnitLocationCategoryName\": \"string\",\n \"IDStockKeepingUnitLocationGroup\": 5561,\n \"StockKeepingUnitLocationGroupName\": \"string\",\n \"IDTypeAddress\": 3,\n \"TypeAddress\": \"string\",\n \"BestBeforeDate\": \"1967-01-02\",\n \"ManufacturingDate\": \"1984-01-18\",\n \"Comments\": \"string\",\n \"Default\": 0,\n \"IDTypeSku\": 8663,\n \"AbcCurve\": \"string\",\n \"MainImageURL\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"BatchBalance\": 5194.492380798899,\n \"QtyHandling\": 7890.39114801076,\n \"QtyAvailable\": 8834.636020518612,\n \"IDBatchStatus\": 1,\n \"BatchStatus\": \"Inativo\",\n \"BatchDAgeInDays\": 8243,\n \"RecordTimestamp\": \"1952-03-11T20:21:21.008Z\",\n \"PriceSell\": 4427.101453813202,\n \"PriceList\": 9407.403955702363,\n \"PercentualDiscountValue\": 1829.121719569926\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2c0c147-e660-48d7-92a6-39168f0f7b86", "name": "`[BadRequest] - Lote não existe`; `[BadRequest] - Data de fabricação não pode ser maior que data de validade nem 31/12/2099`; `[BadRequest] - Data de fabricação não pode ser maior que data de validade`; `[BadRequest] - Endereço não pode ser removido`; `[BadRequest] - Endereço SKU não existe ou pertence a outro armazém`.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDBatch\": 6497,\n \"IDStockKeepingUnitLocation\": 3452,\n \"BestBeforeDate\": \"1951-07-12\",\n \"ManufacturingDate\": \"1982-07-25\",\n \"Comments\": \"string\",\n \"Default\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "608ca39d-4698-492d-9c85-10cd963c58dd", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDBatch\": 6497,\n \"IDStockKeepingUnitLocation\": 3452,\n \"BestBeforeDate\": \"1951-07-12\",\n \"ManufacturingDate\": \"1982-07-25\",\n \"Comments\": \"string\",\n \"Default\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50ef4d9b-bae2-43f2-8d98-d9aa3448b367", "name": "Remove lote", "request": { "name": "Remove lote", "description": { "content": "Remove um lote de SKU. A exclusão é bloqueada quando o lote ainda tem saldo em estoque (saldo diferente de zero); nesse caso, transfira a quantidade para outro endereço ou consuma-a via venda/saída antes de excluir.", "type": "text/plain" }, "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ee998e29-72e9-4afb-b8ba-972a28d9b4fb", "name": "Lote removido.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"string\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66541309-debb-4133-82a1-a4447e36f426", "name": "`[BadRequest] - Lote não existe`; `[BadRequest] - Lote tem saldo, transferir quantidade para deletar`.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72624524-d09d-4e70-bcd9-549f8da57c90", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "batch", ":idsku", ":idbatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idsku", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "2232", "key": "idbatch", "description": "(Required) " }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2ad8dfaa-c337-42f6-8db2-62276eeb5e65", "name": "Marcas", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "97a35b89-c523-4295-bbab-5c1659113724", "name": "Lista marcas", "request": { "name": "Lista marcas", "description": { "content": "Retorna as marcas ativas da empresa. Aceita uma busca textual por `Search` que casa contra o id e o nome. Limite máximo de 5000 resultados.", "type": "text/plain" }, "url": { "path": [ "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Search", "value": "string", "description": "Busca textual contra identificador `IDBrand` e nome `Name`. Cada espaço vira um curinga `%` interno." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "78cd55d6-04d9-4b3c-a671-f97b43256f55", "name": "Lista de marcas.", "originalRequest": { "url": { "path": [ "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Search", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDBrand\": 4811,\n \"Name\": \"string\",\n \"IsActive\": 1,\n \"Status\": \"Inativo\"\n },\n {\n \"AccountName\": \"string\",\n \"IDBrand\": 8171,\n \"Name\": \"string\",\n \"IsActive\": 0,\n \"Status\": \"Ativo\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60da5ce0-b722-4b1d-a4de-fbda5224b49e", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Search", "value": "string" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3bf7d03-6c3f-4db4-b587-9657f23a833e", "name": "Cadastra uma marca", "request": { "name": "Cadastra uma marca", "description": { "content": "Cria uma marca para a empresa. Os campos `Description`, `Keywords` e `Title` herdam o valor de `Name` quando ausentes ou vazios. `IsActive` assume `1` por padrão, `MenuHome` assume `0`, e `Score` fica nulo.\n\nA resposta é o detalhe da marca recém-criada (mesmo formato do `GET /brand/{idbrand}`).", "type": "text/plain" }, "url": { "path": [ "brand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 5639\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a78e97dc-2555-4be2-a751-3d90e906c7b0", "name": "Marca criada.", "originalRequest": { "url": { "path": [ "brand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 5639\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBrand\": 6793,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 0,\n \"MenuHome\": 1,\n \"Score\": 211,\n \"RecordTimestamp\": \"1965-09-01T16:12:00.307Z\",\n \"Status\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d971bbad-f43c-4024-83f0-cb1801cf1b48", "name": "Empresa não localizada. Mensagem: `[BadRequest] - Company não existe`.", "originalRequest": { "url": { "path": [ "brand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 5639\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b164fb6-13db-460b-bc0e-98a9b3852bbd", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "brand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 5639\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "348599de-7d94-4fa2-b754-f63418610120", "name": "Detalha uma marca", "request": { "name": "Detalha uma marca", "description": { "content": "Retorna o cadastro completo de uma marca.", "type": "text/plain" }, "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7ad40448-7e12-4928-b42f-ee0753795337", "name": "Marca encontrada (array com 1 item) ou array vazio quando o id não pertence à empresa.", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBrand\": 2667,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 345,\n \"RecordTimestamp\": \"1991-10-11T05:18:58.927Z\",\n \"Status\": 1\n },\n {\n \"IDBrand\": 9401,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 0,\n \"MenuHome\": 0,\n \"Score\": 8697,\n \"RecordTimestamp\": \"2021-10-29T14:40:01.167Z\",\n \"Status\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f14f9b53-6d97-467f-b240-f28b5ee2f2e7", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f63cee7-97ad-48b8-bc2a-2f63f08165d1", "name": "Atualiza uma marca", "request": { "name": "Atualiza uma marca", "description": { "content": "Atualiza a marca de forma parcial — apenas os campos enviados são alterados. A resposta é o detalhe da marca atualizada.", "type": "text/plain" }, "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 2549\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4c4fb24d-884c-4c43-bfd4-2f2235b37931", "name": "Marca atualizada.", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 2549\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDBrand\": 6793,\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 0,\n \"MenuHome\": 1,\n \"Score\": 211,\n \"RecordTimestamp\": \"1965-09-01T16:12:00.307Z\",\n \"Status\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71f51ad0-11bf-4836-9efd-b0ed2c59ef2e", "name": "Marca não encontrada. Mensagem: `[BadRequest] - Brand não existe`.", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 2549\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35ccf60a-8878-422b-b47a-956e33ce9862", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Name\": \"string\",\n \"Description\": \"string\",\n \"Keywords\": \"string\",\n \"Title\": \"string\",\n \"IsActive\": 1,\n \"MenuHome\": 0,\n \"Score\": 2549\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af494dfd-1ba8-4ffc-b669-89476b05bbae", "name": "Exclui (inativa) uma marca", "request": { "name": "Exclui (inativa) uma marca", "description": { "content": "Inativa a marca (`Status = 0`). Não exclui fisicamente o registro. A exclusão é bloqueada quando há produtos ativos vinculados à marca.", "type": "text/plain" }, "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f599ae2e-478b-4f59-97db-9dc27842caa4", "name": "Marca inativada. Devolve a string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc850376-c009-4219-ab18-a3809c22db18", "name": "Regras impeditivas (prefixo `[BadRequest]`): `marca não existe`, `Marca possui produto ativos. Alterar a marca no cadastro do item antes de excluir a marca`.", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "544ef535-409c-4b3c-bff3-41f083bc2606", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "brand", ":idbrand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idbrand", "description": "(Required) Identificador da marca." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "46954d87-c4ce-433b-ac19-e069d91a4168", "name": "Metas", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1c0bb25d-5ea5-4893-97be-485469703e8e", "name": "Lista as metas cadastradas para a empresa", "request": { "name": "Lista as metas cadastradas para a empresa", "description": { "content": "Retorna até 5.000 metas ordenadas pela data inicial decrescente. Aceita filtros por tipo de meta, identificador da meta e janela de início. Cada meta traz o tipo amigável.", "type": "text/plain" }, "url": { "path": [ "goal" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDTypeGoal", "value": "4", "description": "Tipo da meta: `1` vendedor, `2` faturador, `3` tipo de pedido, `4` integração." }, { "disabled": false, "key": "IDCompanyGoal", "value": "2232", "description": "Identificador da meta." }, { "disabled": false, "key": "DateFromFrom", "value": "1980-02-08", "description": "Data inicial mínima de vigência." }, { "disabled": false, "key": "DateFromTo", "value": "1980-02-08", "description": "Data inicial máxima de vigência. O sistema concatena `23:59:59`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9d5cffe7-c5f6-461b-9aa0-294ac7462a19", "name": "Metas retornadas.", "originalRequest": { "url": { "path": [ "goal" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDTypeGoal", "value": "4" }, { "key": "IDCompanyGoal", "value": "2232" }, { "key": "DateFromFrom", "value": "1980-02-08" }, { "key": "DateFromTo", "value": "1980-02-08" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyGoal\": 4664,\n \"RecordTimestamp\": \"1973-09-11T14:38:59.090Z\",\n \"IDCompany\": 8020,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 4,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"1969-06-04\",\n \"DateTo\": \"1977-11-23\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 6246,\n \"IDUser\": 4617,\n \"Login\": \"string\",\n \"GoalValue\": 9240.725370165623\n },\n {\n \"IDCompanyGoalSalesmans\": 3778,\n \"IDUser\": 7462,\n \"Login\": \"string\",\n \"GoalValue\": 4603.702574390385\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 1027,\n \"IDCompanyInvoice\": 9739,\n \"AccountName\": \"string\",\n \"GoalValue\": 1830.6929803493842\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 4551,\n \"IDCompanyInvoice\": 6382,\n \"AccountName\": \"string\",\n \"GoalValue\": 8986.257280152948\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 9821,\n \"IDTypeOrder\": 6173,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 5176.907198351674\n },\n {\n \"IDCompanyGoalTypeOrders\": 1664,\n \"IDTypeOrder\": 3914,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 9865.692681849783\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 2996,\n \"IDCompanyIntegration\": 6966,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 4557.083490555991\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 8336,\n \"IDCompanyIntegration\": 4399,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 1189.2932380841191\n }\n ]\n },\n {\n \"IDCompanyGoal\": 4818,\n \"RecordTimestamp\": \"1991-10-12T06:09:28.281Z\",\n \"IDCompany\": 1954,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 4,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"1968-01-28\",\n \"DateTo\": \"2007-06-01\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 4500,\n \"IDUser\": 8638,\n \"Login\": \"string\",\n \"GoalValue\": 7388.7143227956285\n },\n {\n \"IDCompanyGoalSalesmans\": 2477,\n \"IDUser\": 4604,\n \"Login\": \"string\",\n \"GoalValue\": 1518.9335417538841\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 7718,\n \"IDCompanyInvoice\": 6071,\n \"AccountName\": \"string\",\n \"GoalValue\": 8226.690073232425\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 2448,\n \"IDCompanyInvoice\": 5889,\n \"AccountName\": \"string\",\n \"GoalValue\": 3369.8434309781787\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 9179,\n \"IDTypeOrder\": 5098,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 2907.68891845095\n },\n {\n \"IDCompanyGoalTypeOrders\": 9280,\n \"IDTypeOrder\": 3943,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 3362.831011753573\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 5012,\n \"IDCompanyIntegration\": 9495,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 2470.280692634219\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 2918,\n \"IDCompanyIntegration\": 3352,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 3489.173442872913\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b37b99aa-a6d2-4b43-b039-2497092a9be1", "name": "Cria uma meta para a empresa", "request": { "name": "Cria uma meta para a empresa", "description": { "content": "Cria a meta principal e, conforme o `IDTypeGoal`, persiste o desdobramento por vendedor, faturador, tipo de pedido ou integração. Só o desdobramento correspondente ao `IDTypeGoal` é gravado — os demais arrays são ignorados mesmo se enviados. Bloqueia a criação quando já existe meta do mesmo tipo cuja vigência esteja contida no intervalo `DateFrom`–`DateTo` informado. Valida que `DateFrom` não seja maior que `DateTo` e que cada item do desdobramento pertença à empresa.", "type": "text/plain" }, "url": { "path": [ "goal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypeGoal\": 3,\n \"GoalName\": \"string\",\n \"DateFrom\": \"1985-12-12\",\n \"DateTo\": \"2018-10-06\",\n \"GoalSalesmans\": [\n {\n \"IDUser\": 9769,\n \"GoalValue\": 5365.266384320582\n },\n {\n \"IDUser\": 6965,\n \"GoalValue\": 3684.8481169996394\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyInvoice\": 536,\n \"GoalValue\": 3638.8870670820083\n },\n {\n \"IDCompanyInvoice\": 9594,\n \"GoalValue\": 1721.8422191430948\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDTypeOrder\": 2498,\n \"GoalValue\": 8924.06061417618\n },\n {\n \"IDTypeOrder\": 9800,\n \"GoalValue\": 664.5977903642075\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyIntegration\": 5666,\n \"GoalValue\": 885.5412181064514\n },\n {\n \"IDCompanyIntegration\": 3140,\n \"GoalValue\": 5944.40353741424\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cc6aea05-a92a-4808-b329-ad59086a28ca", "name": "Meta criada. Retorna a representação completa da meta (delegado ao `goalGet`).", "originalRequest": { "url": { "path": [ "goal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeGoal\": 3,\n \"GoalName\": \"string\",\n \"DateFrom\": \"1998-04-18\",\n \"DateTo\": \"2017-04-11\",\n \"GoalSalesmans\": [\n {\n \"IDUser\": 1084,\n \"GoalValue\": 8876.656141537416\n },\n {\n \"IDUser\": 458,\n \"GoalValue\": 839.4120894398194\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyInvoice\": 2839,\n \"GoalValue\": 5254.188934539041\n },\n {\n \"IDCompanyInvoice\": 2253,\n \"GoalValue\": 7036.247986577986\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDTypeOrder\": 4890,\n \"GoalValue\": 9816.687707740517\n },\n {\n \"IDTypeOrder\": 5966,\n \"GoalValue\": 8911.715451446513\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyIntegration\": 5904,\n \"GoalValue\": 7708.290901753647\n },\n {\n \"IDCompanyIntegration\": 2409,\n \"GoalValue\": 8839.547691289705\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyGoal\": 1196,\n \"RecordTimestamp\": \"1970-10-28T04:47:01.005Z\",\n \"IDCompany\": 1468,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 3,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"2023-05-10\",\n \"DateTo\": \"1968-04-17\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 3263,\n \"IDUser\": 9100,\n \"Login\": \"string\",\n \"GoalValue\": 3398.183917880775\n },\n {\n \"IDCompanyGoalSalesmans\": 6970,\n \"IDUser\": 2442,\n \"Login\": \"string\",\n \"GoalValue\": 1596.0433511435922\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 363,\n \"IDCompanyInvoice\": 8422,\n \"AccountName\": \"string\",\n \"GoalValue\": 9364.791200526348\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 5350,\n \"IDCompanyInvoice\": 25,\n \"AccountName\": \"string\",\n \"GoalValue\": 7205.9824576178125\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 9022,\n \"IDTypeOrder\": 8430,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 2769.203137916607\n },\n {\n \"IDCompanyGoalTypeOrders\": 9851,\n \"IDTypeOrder\": 8926,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 5970.118454606001\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 9439,\n \"IDCompanyIntegration\": 829,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 9648.200457100373\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 6273,\n \"IDCompanyIntegration\": 1052,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 9266.972125688253\n }\n ]\n },\n {\n \"IDCompanyGoal\": 1709,\n \"RecordTimestamp\": \"2006-03-25T19:28:56.572Z\",\n \"IDCompany\": 9285,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 2,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"2014-01-29\",\n \"DateTo\": \"2014-11-02\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 2724,\n \"IDUser\": 3081,\n \"Login\": \"string\",\n \"GoalValue\": 5086.529325639897\n },\n {\n \"IDCompanyGoalSalesmans\": 6860,\n \"IDUser\": 6319,\n \"Login\": \"string\",\n \"GoalValue\": 7768.7643503621875\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 6641,\n \"IDCompanyInvoice\": 82,\n \"AccountName\": \"string\",\n \"GoalValue\": 4728.368847280373\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 6792,\n \"IDCompanyInvoice\": 2168,\n \"AccountName\": \"string\",\n \"GoalValue\": 5904.856218105632\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 4323,\n \"IDTypeOrder\": 1911,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 7967.474943134383\n },\n {\n \"IDCompanyGoalTypeOrders\": 3728,\n \"IDTypeOrder\": 3112,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 2969.830664748101\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 2038,\n \"IDCompanyIntegration\": 2486,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 3880.510877450134\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 2053,\n \"IDCompanyIntegration\": 4395,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 3405.619234816639\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a14f8ace-afb8-4f20-b5ad-33d1beba9655", "name": "Possíveis causas: tipo de meta inexistente, empresa não localizada, sobreposição com meta já cadastrada, `DateFrom` maior que `DateTo`, vendedor/faturador/tipo de pedido/integração inexistentes, ou `Erro ao criar meta` quando a gravação não chega a criar nenhum registro. Prefixo `[BadRequest]`.", "originalRequest": { "url": { "path": [ "goal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDTypeGoal\": 3,\n \"GoalName\": \"string\",\n \"DateFrom\": \"1998-04-18\",\n \"DateTo\": \"2017-04-11\",\n \"GoalSalesmans\": [\n {\n \"IDUser\": 1084,\n \"GoalValue\": 8876.656141537416\n },\n {\n \"IDUser\": 458,\n \"GoalValue\": 839.4120894398194\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyInvoice\": 2839,\n \"GoalValue\": 5254.188934539041\n },\n {\n \"IDCompanyInvoice\": 2253,\n \"GoalValue\": 7036.247986577986\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDTypeOrder\": 4890,\n \"GoalValue\": 9816.687707740517\n },\n {\n \"IDTypeOrder\": 5966,\n \"GoalValue\": 8911.715451446513\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyIntegration\": 5904,\n \"GoalValue\": 7708.290901753647\n },\n {\n \"IDCompanyIntegration\": 2409,\n \"GoalValue\": 8839.547691289705\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89034ce3-c943-4d54-aae9-0b9bb242ab17", "name": "Retorna uma meta com o desdobramento por item", "request": { "name": "Retorna uma meta com o desdobramento por item", "description": { "content": "Retorna a meta principal e, conforme o tipo, popula `GoalSalesmans`, `GoalCompanyInvoices`, `GoalTypeOrders` ou `GoalCompanyIntegrations` com os valores configurados para cada vendedor, faturador, tipo de pedido ou integração.", "type": "text/plain" }, "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4190cf3c-65c0-467f-a248-8530ff5a4c67", "name": "Meta retornada. Quando inexistente, retorna lista vazia.", "originalRequest": { "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyGoal\": 1196,\n \"RecordTimestamp\": \"1970-10-28T04:47:01.005Z\",\n \"IDCompany\": 1468,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 3,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"2023-05-10\",\n \"DateTo\": \"1968-04-17\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 3263,\n \"IDUser\": 9100,\n \"Login\": \"string\",\n \"GoalValue\": 3398.183917880775\n },\n {\n \"IDCompanyGoalSalesmans\": 6970,\n \"IDUser\": 2442,\n \"Login\": \"string\",\n \"GoalValue\": 1596.0433511435922\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 363,\n \"IDCompanyInvoice\": 8422,\n \"AccountName\": \"string\",\n \"GoalValue\": 9364.791200526348\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 5350,\n \"IDCompanyInvoice\": 25,\n \"AccountName\": \"string\",\n \"GoalValue\": 7205.9824576178125\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 9022,\n \"IDTypeOrder\": 8430,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 2769.203137916607\n },\n {\n \"IDCompanyGoalTypeOrders\": 9851,\n \"IDTypeOrder\": 8926,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 5970.118454606001\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 9439,\n \"IDCompanyIntegration\": 829,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 9648.200457100373\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 6273,\n \"IDCompanyIntegration\": 1052,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 9266.972125688253\n }\n ]\n },\n {\n \"IDCompanyGoal\": 1709,\n \"RecordTimestamp\": \"2006-03-25T19:28:56.572Z\",\n \"IDCompany\": 9285,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 2,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"2014-01-29\",\n \"DateTo\": \"2014-11-02\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 2724,\n \"IDUser\": 3081,\n \"Login\": \"string\",\n \"GoalValue\": 5086.529325639897\n },\n {\n \"IDCompanyGoalSalesmans\": 6860,\n \"IDUser\": 6319,\n \"Login\": \"string\",\n \"GoalValue\": 7768.7643503621875\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 6641,\n \"IDCompanyInvoice\": 82,\n \"AccountName\": \"string\",\n \"GoalValue\": 4728.368847280373\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 6792,\n \"IDCompanyInvoice\": 2168,\n \"AccountName\": \"string\",\n \"GoalValue\": 5904.856218105632\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 4323,\n \"IDTypeOrder\": 1911,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 7967.474943134383\n },\n {\n \"IDCompanyGoalTypeOrders\": 3728,\n \"IDTypeOrder\": 3112,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 2969.830664748101\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 2038,\n \"IDCompanyIntegration\": 2486,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 3880.510877450134\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 2053,\n \"IDCompanyIntegration\": 4395,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 3405.619234816639\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3d41ce8-55d5-48d9-9366-5fa31fade334", "name": "Atualiza uma meta e seu desdobramento", "request": { "name": "Atualiza uma meta e seu desdobramento", "description": { "content": "Substitui os dados principais da meta e regrava o desdobramento. Os quatro campos principais são sempre reescritos, então omitir qualquer um deles apaga o valor atual. O desdobramento é **totalmente substituído**: os itens por vendedor, faturador, tipo de pedido e integração são apagados a cada chamada, e só o array correspondente ao `IDTypeGoal` enviado é regravado — omitir esse array deixa a meta sem nenhum desdobramento. Aplica as mesmas validações do POST, com uma diferença: a checagem de sobreposição de vigência ignora a própria meta em edição, então reenviar o mesmo intervalo já gravado não é rejeitado.", "type": "text/plain" }, "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDTypeGoal\": 3,\n \"GoalName\": \"string\",\n \"DateFrom\": \"2020-10-01\",\n \"DateTo\": \"2018-09-09\",\n \"GoalSalesmans\": [\n {\n \"IDUser\": 6984,\n \"GoalValue\": 3520.505180783502\n },\n {\n \"IDUser\": 2504,\n \"GoalValue\": 732.8263381531385\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyInvoice\": 3127,\n \"GoalValue\": 8247.329730851525\n },\n {\n \"IDCompanyInvoice\": 7892,\n \"GoalValue\": 212.11068514832564\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDTypeOrder\": 6657,\n \"GoalValue\": 5251.4757666327605\n },\n {\n \"IDTypeOrder\": 8465,\n \"GoalValue\": 8160.2480402765805\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyIntegration\": 2716,\n \"GoalValue\": 3758.4508391467853\n },\n {\n \"IDCompanyIntegration\": 7446,\n \"GoalValue\": 516.6828184222405\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7e293ace-7065-4c19-8f78-b37abe439491", "name": "Meta atualizada. Retorna a representação completa (delegado ao `goalGet`).", "originalRequest": { "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypeGoal\": 4,\n \"GoalName\": \"string\",\n \"DateFrom\": \"2008-10-26\",\n \"DateTo\": \"1973-09-16\",\n \"GoalSalesmans\": [\n {\n \"IDUser\": 8100,\n \"GoalValue\": 1702.252339644763\n },\n {\n \"IDUser\": 5954,\n \"GoalValue\": 6836.930267224988\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyInvoice\": 7938,\n \"GoalValue\": 7910.309878857746\n },\n {\n \"IDCompanyInvoice\": 6633,\n \"GoalValue\": 1138.811694963069\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDTypeOrder\": 8201,\n \"GoalValue\": 3324.7618767292406\n },\n {\n \"IDTypeOrder\": 9679,\n \"GoalValue\": 4399.05229454252\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyIntegration\": 2754,\n \"GoalValue\": 4751.282390547669\n },\n {\n \"IDCompanyIntegration\": 5251,\n \"GoalValue\": 7650.587348541233\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompanyGoal\": 1196,\n \"RecordTimestamp\": \"1970-10-28T04:47:01.005Z\",\n \"IDCompany\": 1468,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 3,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"2023-05-10\",\n \"DateTo\": \"1968-04-17\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 3263,\n \"IDUser\": 9100,\n \"Login\": \"string\",\n \"GoalValue\": 3398.183917880775\n },\n {\n \"IDCompanyGoalSalesmans\": 6970,\n \"IDUser\": 2442,\n \"Login\": \"string\",\n \"GoalValue\": 1596.0433511435922\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 363,\n \"IDCompanyInvoice\": 8422,\n \"AccountName\": \"string\",\n \"GoalValue\": 9364.791200526348\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 5350,\n \"IDCompanyInvoice\": 25,\n \"AccountName\": \"string\",\n \"GoalValue\": 7205.9824576178125\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 9022,\n \"IDTypeOrder\": 8430,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 2769.203137916607\n },\n {\n \"IDCompanyGoalTypeOrders\": 9851,\n \"IDTypeOrder\": 8926,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 5970.118454606001\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 9439,\n \"IDCompanyIntegration\": 829,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 9648.200457100373\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 6273,\n \"IDCompanyIntegration\": 1052,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 9266.972125688253\n }\n ]\n },\n {\n \"IDCompanyGoal\": 1709,\n \"RecordTimestamp\": \"2006-03-25T19:28:56.572Z\",\n \"IDCompany\": 9285,\n \"AccountName\": \"string\",\n \"IDTypeGoal\": 2,\n \"TypeGoal\": \"string\",\n \"GoalName\": \"string\",\n \"DateFrom\": \"2014-01-29\",\n \"DateTo\": \"2014-11-02\",\n \"GoalSalesmans\": [\n {\n \"IDCompanyGoalSalesmans\": 2724,\n \"IDUser\": 3081,\n \"Login\": \"string\",\n \"GoalValue\": 5086.529325639897\n },\n {\n \"IDCompanyGoalSalesmans\": 6860,\n \"IDUser\": 6319,\n \"Login\": \"string\",\n \"GoalValue\": 7768.7643503621875\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyGoalCompanyInvoices\": 6641,\n \"IDCompanyInvoice\": 82,\n \"AccountName\": \"string\",\n \"GoalValue\": 4728.368847280373\n },\n {\n \"IDCompanyGoalCompanyInvoices\": 6792,\n \"IDCompanyInvoice\": 2168,\n \"AccountName\": \"string\",\n \"GoalValue\": 5904.856218105632\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDCompanyGoalTypeOrders\": 4323,\n \"IDTypeOrder\": 1911,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 7967.474943134383\n },\n {\n \"IDCompanyGoalTypeOrders\": 3728,\n \"IDTypeOrder\": 3112,\n \"TypeOrder\": \"string\",\n \"GoalValue\": 2969.830664748101\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyGoalCompanyIntegrations\": 2038,\n \"IDCompanyIntegration\": 2486,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 3880.510877450134\n },\n {\n \"IDCompanyGoalCompanyIntegrations\": 2053,\n \"IDCompanyIntegration\": 4395,\n \"CompanyIntegration\": \"string\",\n \"GoalValue\": 3405.619234816639\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9809d08-3d59-4e2c-be87-7106cda6738c", "name": "Possíveis causas: tipo de meta inexistente, empresa não localizada, sobreposição com meta já cadastrada (a própria meta em edição é ignorada nessa checagem), `DateFrom` maior que `DateTo`, ou vendedor/faturador/tipo de pedido/integração inexistentes. Prefixo `[BadRequest]`.", "originalRequest": { "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDTypeGoal\": 4,\n \"GoalName\": \"string\",\n \"DateFrom\": \"2008-10-26\",\n \"DateTo\": \"1973-09-16\",\n \"GoalSalesmans\": [\n {\n \"IDUser\": 8100,\n \"GoalValue\": 1702.252339644763\n },\n {\n \"IDUser\": 5954,\n \"GoalValue\": 6836.930267224988\n }\n ],\n \"GoalCompanyInvoices\": [\n {\n \"IDCompanyInvoice\": 7938,\n \"GoalValue\": 7910.309878857746\n },\n {\n \"IDCompanyInvoice\": 6633,\n \"GoalValue\": 1138.811694963069\n }\n ],\n \"GoalTypeOrders\": [\n {\n \"IDTypeOrder\": 8201,\n \"GoalValue\": 3324.7618767292406\n },\n {\n \"IDTypeOrder\": 9679,\n \"GoalValue\": 4399.05229454252\n }\n ],\n \"GoalCompanyIntegrations\": [\n {\n \"IDCompanyIntegration\": 2754,\n \"GoalValue\": 4751.282390547669\n },\n {\n \"IDCompanyIntegration\": 5251,\n \"GoalValue\": 7650.587348541233\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86b568f6-e1f8-41ab-9ab1-09d460c91942", "name": "Remove uma meta", "request": { "name": "Remove uma meta", "description": { "content": "Remove a meta e, em cascata, todos os desdobramentos por vendedor, faturador, tipo de pedido e integração.", "type": "text/plain" }, "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "f086fcdd-461c-4251-8145-84096c56b075", "name": "Meta removida. Retorna o literal `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c23fd39-c411-4a5f-9910-635761fb80ba", "name": "Meta não existe. Prefixo `[BadRequest]`.", "originalRequest": { "url": { "path": [ "goal", ":idcompanygoal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanygoal", "description": "(Required) Identificador da meta." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "721711c9-f512-412f-832e-a00fbdc5ed86", "name": "Minha Empresa", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "57d8be9e-d030-476d-94d6-19e2ccc351f5", "name": "Detalha a empresa autenticada", "request": { "name": "Detalha a empresa autenticada", "description": { "content": "Retorna o cadastro completo da empresa identificada pelo subdomínio (`AccountName`) usado na chamada — todos os campos do cadastro da empresa mais os dados agregados: descrição do regime tributário (CRT), URL do logotipo (com sufixo `-thumbnail`), id da integração NFe/NFSe principal (`IDCompanyIntegration` com `IDTypeCompanyIntegration=16`), array de inscrições estaduais em `StateInscription` e array de créditos do Simples Nacional em `CompanySimplesCred`.\n\nO campo `CertificadoPassword` é sempre retornado como `null` (a senha do certificado nunca é exposta pela API).", "type": "text/plain" }, "url": { "path": [ "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f7b0dab4-2a77-4a5e-b656-b6fd3381e539", "name": "Cadastro da empresa.", "originalRequest": { "url": { "path": [ "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 2050,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 8214,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 4839,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 5062,\n \"NfeFeedStatus\": 7543,\n \"SefazAmbienteNF\": 1923,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 2435,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 2640,\n \"SefazAmbienteServiceInvoice\": 7782,\n \"ServiceInvoiceUltima\": 4020,\n \"NfseFeedStatus\": 2593,\n \"CteFeedStatus\": 1721,\n \"CertificadoBestBeforeDate\": \"1986-09-28T10:05:09.841Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 589,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 2763,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3442,\n \"GNRE\": 1365,\n \"CompanyStateInscriptionDueDay\": 1419\n },\n {\n \"IDCompanyStateInscription\": 8651,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9957,\n \"GNRE\": 7956,\n \"CompanyStateInscriptionDueDay\": 1216\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 8246,\n \"MonthYear\": \"1979-05-06T20:03:24.070Z\",\n \"PCred\": 616.3770859651274,\n \"TotalEffectiveTax\": 3616.103808954991\n },\n {\n \"IDCompanySimplesCred\": 8854,\n \"MonthYear\": \"1985-10-30T08:35:12.988Z\",\n \"PCred\": 9476.71301867404,\n \"TotalEffectiveTax\": 2486.7550482864885\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a108723e-ba47-4f3f-9cf8-700c7b539d43", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a8014c3-e7c2-44bf-9ab8-fa68ce90f494", "name": "Atualiza a empresa autenticada", "request": { "name": "Atualiza a empresa autenticada", "description": { "content": "Atualização parcial do cadastro da empresa — apenas os campos enviados são alterados. Envie ao menos um dos campos do corpo: uma requisição sem nenhum campo conhecido não é concluída e expira por tempo limite.\n\nRegras aplicadas:\n\n- `NfeSerie` e `NfceSerie` não podem ser maiores que 999. Essas duas validações acontecem antes de qualquer gravação.\n- Ao mudar `NfeSerie` ou `NfceSerie`, as notas da série anterior que ainda não foram transmitidas deixam de ser tratadas como a numeração principal.\n- Ao mudar `CompanyAddressPostalCode`, o novo CEP é consultado; se ele não for encontrado, a resposta vem com erro.\n- `CompanyAddressIbgeCityCode` só é gravado quando vem no próprio corpo da requisição. A consulta de CEP não preenche o código IBGE sozinha.\n- `CteFeedStatus = 1` é recusado quando outra empresa com o mesmo CNPJ já tem o recebimento de CT-e ativo.\n\nAtenção: as verificações de CEP e de CT-e duplicado rodam **depois** da gravação. Quando uma delas falha, a resposta vem com erro, mas os campos enviados já foram salvos — inclusive o próprio CEP inválido e o `CteFeedStatus`. Reenvie os valores anteriores para desfazer.\n\nCada alteração é registrada no histórico da empresa, com o valor anterior e o novo. A resposta traz o cadastro completo atualizado.", "type": "text/plain" }, "url": { "path": [ "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": 6300,\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"NfeRegimeTributario\": 2,\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 7920,\n \"SefazAmbienteNF\": 2,\n \"NfeFeedStatus\": 3071,\n \"NfceUltima\": 451,\n \"NfceSerie\": \"string\",\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 1,\n \"SefazAmbienteServiceInvoice\": 2,\n \"ServiceInvoiceUltima\": 7717,\n \"CteFeedStatus\": 7004\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23bd7ed2-da63-41d9-8f61-5e9be6ce1313", "name": "Cadastro atualizado.", "originalRequest": { "url": { "path": [ "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": 6300,\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"NfeRegimeTributario\": 2,\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 7920,\n \"SefazAmbienteNF\": 2,\n \"NfeFeedStatus\": 3071,\n \"NfceUltima\": 451,\n \"NfceSerie\": \"string\",\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 1,\n \"SefazAmbienteServiceInvoice\": 2,\n \"ServiceInvoiceUltima\": 7717,\n \"CteFeedStatus\": 7004\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9759,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 7477,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 9445,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 375,\n \"NfeFeedStatus\": 1612,\n \"SefazAmbienteNF\": 5550,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 1369,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 5317,\n \"SefazAmbienteServiceInvoice\": 2382,\n \"ServiceInvoiceUltima\": 9067,\n \"NfseFeedStatus\": 9065,\n \"CteFeedStatus\": 3360,\n \"CertificadoBestBeforeDate\": \"1978-09-17T12:43:29.668Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 1202,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 6874,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3232,\n \"GNRE\": 7071,\n \"CompanyStateInscriptionDueDay\": 9125\n },\n {\n \"IDCompanyStateInscription\": 5980,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9470,\n \"GNRE\": 5886,\n \"CompanyStateInscriptionDueDay\": 2674\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 1927,\n \"MonthYear\": \"1958-07-12T00:25:56.797Z\",\n \"PCred\": 3347.205035791172,\n \"TotalEffectiveTax\": 4542.188544519421\n },\n {\n \"IDCompanySimplesCred\": 4468,\n \"MonthYear\": \"1951-08-28T03:43:06.835Z\",\n \"PCred\": 4690.7482442493965,\n \"TotalEffectiveTax\": 2307.882212546515\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a493f7da-7735-4bd1-b6df-37da0e8ed5d0", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Serie NFe não pode ser maior que 999`\n- `Serie NFCe não pode ser maior que 999`\n- `Empresa não existe`\n- `CNPJ já tem recurso de CTe ativo e não pode estar em duas empresas com mesmo CNPJ`\n- `CEP não encontrado` — devolvido pela consulta de CEP quando o novo `CompanyAddressPostalCode` não é localizado.\n\nQuando a consulta de CEP falha sem devolver mensagem própria, o texto `erro consultar cep` é retornado sem o prefixo `[BadRequest]`.", "originalRequest": { "url": { "path": [ "company" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": 6300,\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"NfeRegimeTributario\": 2,\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 7920,\n \"SefazAmbienteNF\": 2,\n \"NfeFeedStatus\": 3071,\n \"NfceUltima\": 451,\n \"NfceSerie\": \"string\",\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 1,\n \"SefazAmbienteServiceInvoice\": 2,\n \"ServiceInvoiceUltima\": 7717,\n \"CteFeedStatus\": 7004\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebdf32ba-069c-4e51-93ef-6b2a7bff3a2f", "name": "Lista a empresa-matriz e suas filiais", "request": { "name": "Lista a empresa-matriz e suas filiais", "description": { "content": "Retorna a empresa-matriz autenticada e a lista de **filiais** vinculadas a ela via `CompanyMain` (que aponta para a matriz). A resposta traz os campos principais da matriz e um array `Branch[]` com os dados das filiais (id, subdomínio, CNPJ, razão social, nome fantasia, logo, certificado, série NFe/NFCe, regime tributário).", "type": "text/plain" }, "url": { "path": [ "company", "branch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "80dac6b4-7c06-48fd-a460-7bdee8b0b1fb", "name": "Dados da matriz + lista de filiais.", "originalRequest": { "url": { "path": [ "company", "branch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9387,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CertificadoBestBeforeDate\": \"1999-03-17T07:25:40.426Z\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 7079,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 7756,\n \"CompanyStatus\": 7784,\n \"CrtDescription\": \"string\",\n \"Branch\": [\n {\n \"IDCompany\": 9250,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CertificadoBestBeforeDate\": \"1951-12-24T04:56:55.930Z\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 3390,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 8403,\n \"CompanyStatus\": 4268,\n \"CrtDescription\": \"string\"\n },\n {\n \"IDCompany\": 4503,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CertificadoBestBeforeDate\": \"2018-11-16T06:40:55.519Z\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 3654,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 557,\n \"CompanyStatus\": 2778,\n \"CrtDescription\": \"string\"\n }\n ]\n },\n {\n \"IDCompany\": 1878,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CertificadoBestBeforeDate\": \"2019-08-19T12:21:28.114Z\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 1715,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 7836,\n \"CompanyStatus\": 6334,\n \"CrtDescription\": \"string\",\n \"Branch\": [\n {\n \"IDCompany\": 3345,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CertificadoBestBeforeDate\": \"2019-09-04T15:41:37.849Z\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 1825,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 54,\n \"CompanyStatus\": 3135,\n \"CrtDescription\": \"string\"\n },\n {\n \"IDCompany\": 9443,\n \"AccountName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CertificadoBestBeforeDate\": \"1976-06-13T11:15:51.438Z\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 7271,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 9884,\n \"CompanyStatus\": 2609,\n \"CrtDescription\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe83533-5db2-4b51-86cc-10c9192111de", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "branch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d00dd918-51e3-46f5-9880-99d00464fdde", "name": "Sobe ou troca o logotipo da empresa", "request": { "name": "Sobe ou troca o logotipo da empresa", "description": { "content": "Aceita duas formas de envio do logotipo:\n\n- **Upload multipart** (`multipart/form-data` com campo `file`) — sobe o arquivo direto do cliente.\n- **URL externa** (`application/json` com `{ \"Url\": \"...\" }`) — o sistema baixa a imagem da URL informada e grava no S3.\n\nA imagem é salva no bucket público do idworks (`https://public.idworks.com.br/Image/_.`) e o campo `CompanyLogoUrl` é atualizado. Resposta é um status HTTP — `200` em sucesso (corpo vazio), `404` se a empresa não existe, `400` quando a URL externa não retorna a imagem.", "type": "text/plain" }, "url": { "path": [ "company", "company-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) Arquivo de imagem (PNG/JPG)." } ] } }, "response": [ { "id": "179b6107-8fdc-45f6-80ae-2d0240594541", "name": "Logotipo aplicado (corpo vazio).", "originalRequest": { "url": { "path": [ "company", "company-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a45a6da9-68f9-4a42-9e55-c27ac5096663", "name": "Falha ao baixar imagem da URL informada. Mensagem: `[BadRequest] - erro ao baixar imagem`.", "originalRequest": { "url": { "path": [ "company", "company-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88b92dcd-01df-422a-ab13-2d33a9016f3e", "name": "Empresa não encontrada (corpo vazio).", "originalRequest": { "url": { "path": [ "company", "company-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e48949b8-45d9-4a29-9ff2-a82cb2498979", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "company-logo" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Arquivo de imagem (PNG/JPG).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e560028-26cd-44ae-8b67-439215116292", "name": "Adiciona uma inscrição estadual", "request": { "name": "Adiciona uma inscrição estadual", "description": { "content": "Cria uma inscrição estadual (IE) vinculada à empresa. Regras:\n\n- A inscrição é validada com o algoritmo oficial por UF (pacote `ie`). Quando inválida, o salvamento é bloqueado.\n- Para Minas Gerais (`State=MG`), o sistema faz padding com zeros à esquerda até 13 dígitos.\n- A inscrição não pode duplicar entre estados na mesma empresa.\n- A empresa só pode ter **uma** inscrição por estado.\n\nA resposta é o detalhe atualizado da empresa (mesmo formato de `GET /company`).", "type": "text/plain" }, "url": { "path": [ "company", "state-inscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b17647b9-9a53-4ba0-b04d-4fe1229484c6", "name": "Inscrição adicionada. Retorna o detalhe atualizado da empresa.", "originalRequest": { "url": { "path": [ "company", "state-inscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9759,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 7477,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 9445,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 375,\n \"NfeFeedStatus\": 1612,\n \"SefazAmbienteNF\": 5550,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 1369,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 5317,\n \"SefazAmbienteServiceInvoice\": 2382,\n \"ServiceInvoiceUltima\": 9067,\n \"NfseFeedStatus\": 9065,\n \"CteFeedStatus\": 3360,\n \"CertificadoBestBeforeDate\": \"1978-09-17T12:43:29.668Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 1202,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 6874,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3232,\n \"GNRE\": 7071,\n \"CompanyStateInscriptionDueDay\": 9125\n },\n {\n \"IDCompanyStateInscription\": 5980,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9470,\n \"GNRE\": 5886,\n \"CompanyStateInscriptionDueDay\": 2674\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 1927,\n \"MonthYear\": \"1958-07-12T00:25:56.797Z\",\n \"PCred\": 3347.205035791172,\n \"TotalEffectiveTax\": 4542.188544519421\n },\n {\n \"IDCompanySimplesCred\": 4468,\n \"MonthYear\": \"1951-08-28T03:43:06.835Z\",\n \"PCred\": 4690.7482442493965,\n \"TotalEffectiveTax\": 2307.882212546515\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1018506c-7ff0-4813-96d3-35221c4aecae", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Empresa não existe`\n- `Inscrição estadual não é válida`\n- `Inscrição estadual já adicionada no estado `\n- `Estado já tem configuração`", "originalRequest": { "url": { "path": [ "company", "state-inscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c99a9725-76f3-45fc-80f8-8aacd0961590", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "state-inscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47e6a693-8dc7-486f-9a1b-d474eedd1347", "name": "Atualiza uma inscrição estadual", "request": { "name": "Atualiza uma inscrição estadual", "description": { "content": "Atualização total — todos os campos do corpo são gravados. Mesmas regras de validação do `POST` (algoritmo oficial por UF, padding MG, unicidade por estado).", "type": "text/plain" }, "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "667a9afa-3bec-47f3-bd17-6d95346199a8", "name": "Inscrição atualizada.", "originalRequest": { "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9759,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 7477,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 9445,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 375,\n \"NfeFeedStatus\": 1612,\n \"SefazAmbienteNF\": 5550,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 1369,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 5317,\n \"SefazAmbienteServiceInvoice\": 2382,\n \"ServiceInvoiceUltima\": 9067,\n \"NfseFeedStatus\": 9065,\n \"CteFeedStatus\": 3360,\n \"CertificadoBestBeforeDate\": \"1978-09-17T12:43:29.668Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 1202,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 6874,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3232,\n \"GNRE\": 7071,\n \"CompanyStateInscriptionDueDay\": 9125\n },\n {\n \"IDCompanyStateInscription\": 5980,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9470,\n \"GNRE\": 5886,\n \"CompanyStateInscriptionDueDay\": 2674\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 1927,\n \"MonthYear\": \"1958-07-12T00:25:56.797Z\",\n \"PCred\": 3347.205035791172,\n \"TotalEffectiveTax\": 4542.188544519421\n },\n {\n \"IDCompanySimplesCred\": 4468,\n \"MonthYear\": \"1951-08-28T03:43:06.835Z\",\n \"PCred\": 4690.7482442493965,\n \"TotalEffectiveTax\": 2307.882212546515\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cbff9ad-4ff8-4bcf-87c4-be6cb45d4b71", "name": "Erros (prefixo `[BadRequest]`):\n- `Inscrição estadual não existe`\n- `Inscrição estadual não é válida`\n- `Inscrição estadual já adicionada no estado `", "originalRequest": { "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a87d306e-5ae0-4aa0-a3b7-72ddc219c328", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"State\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 386,\n \"GNRE\": 9063,\n \"CompanyStateInscriptionDueDay\": 4369\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26bcf7f7-e987-45ce-9a94-4890c011cf09", "name": "Remove uma inscrição estadual", "request": { "name": "Remove uma inscrição estadual", "description": { "content": "Apaga fisicamente a inscrição estadual. A resposta é o detalhe atualizado da empresa.", "type": "text/plain" }, "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "0c83f47c-d54d-4d6e-87e2-e1dcae467abf", "name": "Inscrição removida.", "originalRequest": { "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9759,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 7477,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 9445,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 375,\n \"NfeFeedStatus\": 1612,\n \"SefazAmbienteNF\": 5550,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 1369,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 5317,\n \"SefazAmbienteServiceInvoice\": 2382,\n \"ServiceInvoiceUltima\": 9067,\n \"NfseFeedStatus\": 9065,\n \"CteFeedStatus\": 3360,\n \"CertificadoBestBeforeDate\": \"1978-09-17T12:43:29.668Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 1202,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 6874,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3232,\n \"GNRE\": 7071,\n \"CompanyStateInscriptionDueDay\": 9125\n },\n {\n \"IDCompanyStateInscription\": 5980,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9470,\n \"GNRE\": 5886,\n \"CompanyStateInscriptionDueDay\": 2674\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 1927,\n \"MonthYear\": \"1958-07-12T00:25:56.797Z\",\n \"PCred\": 3347.205035791172,\n \"TotalEffectiveTax\": 4542.188544519421\n },\n {\n \"IDCompanySimplesCred\": 4468,\n \"MonthYear\": \"1951-08-28T03:43:06.835Z\",\n \"PCred\": 4690.7482442493965,\n \"TotalEffectiveTax\": 2307.882212546515\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b106761-8f84-4ba4-9c66-82e0651dfdee", "name": "Inscrição não localizada. Mensagem: `[BadRequest] - State Inscription não existe`.", "originalRequest": { "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e9e10a9-692d-4292-a8ad-52353c90a63d", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "state-inscription", ":idstateinscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idstateinscription", "description": "(Required) Identificador da inscrição estadual (`IDCompanyStateInscription`)." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c50c818a-7165-4fb3-982d-cfc1f0ce1383", "name": "Cadastra créditos do Simples Nacional para um período", "request": { "name": "Cadastra créditos do Simples Nacional para um período", "description": { "content": "Cria um registro de crédito do Simples Nacional para um mês/ano (`MonthYear`). O sistema converte a data para o primeiro dia do mês (`MonthYear`) e último dia do mês (`MonthYearTo`) automaticamente. Um período só pode ter um registro — duplicidade é bloqueada.", "type": "text/plain" }, "url": { "path": [ "company", "simples-cred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "49714f4a-2421-4d72-a6b5-5e7a6b02a076", "name": "Crédito cadastrado.", "originalRequest": { "url": { "path": [ "company", "simples-cred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9759,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 7477,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 9445,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 375,\n \"NfeFeedStatus\": 1612,\n \"SefazAmbienteNF\": 5550,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 1369,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 5317,\n \"SefazAmbienteServiceInvoice\": 2382,\n \"ServiceInvoiceUltima\": 9067,\n \"NfseFeedStatus\": 9065,\n \"CteFeedStatus\": 3360,\n \"CertificadoBestBeforeDate\": \"1978-09-17T12:43:29.668Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 1202,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 6874,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3232,\n \"GNRE\": 7071,\n \"CompanyStateInscriptionDueDay\": 9125\n },\n {\n \"IDCompanyStateInscription\": 5980,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9470,\n \"GNRE\": 5886,\n \"CompanyStateInscriptionDueDay\": 2674\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 1927,\n \"MonthYear\": \"1958-07-12T00:25:56.797Z\",\n \"PCred\": 3347.205035791172,\n \"TotalEffectiveTax\": 4542.188544519421\n },\n {\n \"IDCompanySimplesCred\": 4468,\n \"MonthYear\": \"1951-08-28T03:43:06.835Z\",\n \"PCred\": 4690.7482442493965,\n \"TotalEffectiveTax\": 2307.882212546515\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77d38845-c09b-493b-84e4-4f14ab5db3ea", "name": "Erros (prefixo `[BadRequest]`):\n- `Company não existe`\n- `Já existe configuração para este periodo`", "originalRequest": { "url": { "path": [ "company", "simples-cred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5587bc36-a321-49ea-923c-88044eea70d1", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "simples-cred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63e46fb6-6306-4a53-9dd8-66f02b10f436", "name": "Atualiza créditos do Simples Nacional", "request": { "name": "Atualiza créditos do Simples Nacional", "description": { "content": "Atualização total — todos os campos do corpo são gravados. Mesma regra de unicidade por período do `POST`.", "type": "text/plain" }, "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a3df098-9270-4f46-9421-2aecdd43b354", "name": "Crédito atualizado.", "originalRequest": { "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9759,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 7477,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 9445,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 375,\n \"NfeFeedStatus\": 1612,\n \"SefazAmbienteNF\": 5550,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 1369,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 5317,\n \"SefazAmbienteServiceInvoice\": 2382,\n \"ServiceInvoiceUltima\": 9067,\n \"NfseFeedStatus\": 9065,\n \"CteFeedStatus\": 3360,\n \"CertificadoBestBeforeDate\": \"1978-09-17T12:43:29.668Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 1202,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 6874,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3232,\n \"GNRE\": 7071,\n \"CompanyStateInscriptionDueDay\": 9125\n },\n {\n \"IDCompanyStateInscription\": 5980,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9470,\n \"GNRE\": 5886,\n \"CompanyStateInscriptionDueDay\": 2674\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 1927,\n \"MonthYear\": \"1958-07-12T00:25:56.797Z\",\n \"PCred\": 3347.205035791172,\n \"TotalEffectiveTax\": 4542.188544519421\n },\n {\n \"IDCompanySimplesCred\": 4468,\n \"MonthYear\": \"1951-08-28T03:43:06.835Z\",\n \"PCred\": 4690.7482442493965,\n \"TotalEffectiveTax\": 2307.882212546515\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33b4413e-28a6-4ed8-b6b5-dfe9c4155ce0", "name": "Erros (prefixo `[BadRequest]`):\n- `IDCompanySimplesCred não existe`\n- `Já existe configuração para este periodo`", "originalRequest": { "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1dd8446-baa4-4f1b-b77c-f69b2c7c43c5", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"MonthYear\": \"1993-09-28\",\n \"PCred\": 863.4771644806038,\n \"TotalEffectiveTax\": 6450.59526644769\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17adf099-9285-40d5-b5bc-8b066c32be2f", "name": "Remove um crédito do Simples Nacional", "request": { "name": "Remove um crédito do Simples Nacional", "description": { "content": "Apaga fisicamente o registro de crédito. A resposta é o detalhe atualizado da empresa.", "type": "text/plain" }, "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "30f7e140-a483-438f-805a-6511def5b405", "name": "Crédito removido.", "originalRequest": { "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCompany\": 9759,\n \"AccountName\": \"string\",\n \"CompanyStatus\": 7477,\n \"CompanyNameCorporateName\": \"string\",\n \"CompanyTradeName\": \"string\",\n \"CompanyCpfCnpj\": \"string\",\n \"CompanyAddressPostalCode\": \"string\",\n \"CompanyAddressStreet\": \"string\",\n \"CompanyAddressNumber\": \"string\",\n \"CompanyAddressComplement\": \"string\",\n \"CompanyAddressNeighborhood\": \"string\",\n \"CompanyAddressCity\": \"string\",\n \"CompanyAddressState\": \"string\",\n \"CompanyAddressIbgeCityCode\": \"string\",\n \"CompanyTelephone\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"WebSiteUrl\": \"string\",\n \"CompanyLogoUrl\": \"string\",\n \"CompanyLogoUrlThumbnail\": \"string\",\n \"NfeRegimeTributario\": 9445,\n \"CrtDescription\": \"string\",\n \"NfeSerie\": \"string\",\n \"NfeUltima\": 375,\n \"NfeFeedStatus\": 1612,\n \"SefazAmbienteNF\": 5550,\n \"NfceSerie\": \"string\",\n \"NfceUltima\": 1369,\n \"NfceCSC\": \"string\",\n \"NfceCSCid\": \"string\",\n \"SefazAmbienteNFC\": 5317,\n \"SefazAmbienteServiceInvoice\": 2382,\n \"ServiceInvoiceUltima\": 9067,\n \"NfseFeedStatus\": 9065,\n \"CteFeedStatus\": 3360,\n \"CertificadoBestBeforeDate\": \"1978-09-17T12:43:29.668Z\",\n \"CertificadoIssuer1\": \"string\",\n \"CertificadoIssuer2\": \"string\",\n \"CertificadoPassword\": \"string\",\n \"IDCompanyIntegration\": 1202,\n \"NfModNfDescription\": \"string\",\n \"StateInscription\": [\n {\n \"IDCompanyStateInscription\": 6874,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 3232,\n \"GNRE\": 7071,\n \"CompanyStateInscriptionDueDay\": 9125\n },\n {\n \"IDCompanyStateInscription\": 5980,\n \"State\": \"string\",\n \"StateName\": \"string\",\n \"StateInscription\": \"string\",\n \"NFeComments\": \"string\",\n \"NfeDifalIndFinal\": 9470,\n \"GNRE\": 5886,\n \"CompanyStateInscriptionDueDay\": 2674\n }\n ],\n \"CompanySimplesCred\": [\n {\n \"IDCompanySimplesCred\": 1927,\n \"MonthYear\": \"1958-07-12T00:25:56.797Z\",\n \"PCred\": 3347.205035791172,\n \"TotalEffectiveTax\": 4542.188544519421\n },\n {\n \"IDCompanySimplesCred\": 4468,\n \"MonthYear\": \"1951-08-28T03:43:06.835Z\",\n \"PCred\": 4690.7482442493965,\n \"TotalEffectiveTax\": 2307.882212546515\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f634c00-dcb6-4e75-a064-6c4d008dc707", "name": "Crédito não localizado. Mensagem: `[BadRequest] - IDCompanySimplesCred não existe`.", "originalRequest": { "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e372d4c-86a4-4c45-89eb-538d94727241", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "simples-cred", ":idcompanysimplescred" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcompanysimplescred", "description": "(Required) Identificador do crédito do Simples." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a920c21d-86fe-4064-8b29-0f8ef97293ee", "name": "Importa o certificado digital da empresa", "request": { "name": "Importa o certificado digital da empresa", "description": { "content": "Importa um arquivo de certificado digital A1 (`.pfx`) com a senha informada. O arquivo é enviado como `multipart/form-data` no campo `certificado` e a senha vai na query `Password`. O sistema valida o certificado, confere que o CNPJ do certificado bate com o da empresa (8 primeiros dígitos), extrai a data de validade (`CertificadoBestBeforeDate`) e o emissor (`CertificadoIssuer1`/`CertificadoIssuer2`) e o armazena de forma segura para uso na assinatura de notas fiscais (NFe/NFCe/NFSe/CTe).\n\n**Erros possíveis:** `O arquivo não esta no formato .pfx`; `Não foi possivel ler o certificado, verificar senha`; `Certificado inválido: não foi possível extrair o CNPJ do certificado`; `CNPJ do certificado () diferente do CNPJ da empresa ()`.", "type": "text/plain" }, "url": { "path": [ "company", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "03c70554-60d3-4866-943e-4a9d26d3293d", "name": "Certificado importado.", "originalRequest": { "url": { "path": [ "company", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "30f743a8-a7f9-4243-9a42-7291bec43032", "name": "Erros de validação do certificado (prefixo `[BadRequest]`).", "originalRequest": { "url": { "path": [ "company", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf386e29-bc64-4c81-be15-eddd0c5efc80", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "company", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5475a648-17e0-4b83-9dcf-0d3669bc0e66", "name": "Modalidades de Transporte", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9029937a-7985-49db-bd5e-79a9ca19491a", "name": "Lista modalidades de transportadora", "request": { "name": "Lista modalidades de transportadora", "description": { "content": "Retorna as modalidades de transportadora cadastradas pela empresa, ordenadas por nome. Cada modalidade descreve a forma como uma transportadora opera (Rodoviário, Aéreo, Marítimo, Fluvial, Próprio, Motoboy, Drone, etc.) e fica disponível para seleção no cadastro do fornecedor que opera como transportadora.", "type": "text/plain" }, "url": { "path": [ "carrier", "modal" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDCarrierModal", "value": "2232", "description": "Filtra por identificador único da modalidade." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d7072ffc-be79-481e-96c6-5e4986ecadc0", "name": "Lista de modalidades da empresa.", "originalRequest": { "url": { "path": [ "carrier", "modal" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCarrierModal", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierModal\": 969,\n \"IDCompany\": 5007,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n },\n {\n \"IDCarrierModal\": 5923,\n \"IDCompany\": 5647,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11a86b7-4154-420e-b1cf-b8124c1ded0e", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "modal" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDCarrierModal", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "471e67cd-6cad-44ab-bc68-b788b97fd526", "name": "Cadastra uma modalidade", "request": { "name": "Cadastra uma modalidade", "description": { "content": "Cria uma modalidade de transportadora na empresa autenticada. O nome (`CarrierModal`) precisa ser único dentro da empresa — o sistema bloqueia o cadastro de outra modalidade com o mesmo nome. A resposta é a lista atualizada de modalidades.", "type": "text/plain" }, "url": { "path": [ "carrier", "modal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cefadbc9-533b-414c-81e4-2c0925ac21d1", "name": "Modalidade criada. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "carrier", "modal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierModal\": 969,\n \"IDCompany\": 5007,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n },\n {\n \"IDCarrierModal\": 5923,\n \"IDCompany\": 5647,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4d7a86a-3b3b-4f19-8a13-51b9119f1d02", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Já existe uma Modalidade com essa conta`\n- `Empresa não existe`", "originalRequest": { "url": { "path": [ "carrier", "modal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a74578e6-bd47-4473-9e58-f303776486be", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "modal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "446da02d-9a68-4a10-a210-7342e015a95b", "name": "Atualiza uma modalidade", "request": { "name": "Atualiza uma modalidade", "description": { "content": "Atualiza o nome da modalidade. Mesma regra de unicidade do `POST` — o novo nome não pode bater com outra modalidade já cadastrada na mesma empresa.", "type": "text/plain" }, "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "39bc9751-b9bd-4d63-a476-5bc4ef6022fb", "name": "Modalidade atualizada. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierModal\": 969,\n \"IDCompany\": 5007,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n },\n {\n \"IDCarrierModal\": 5923,\n \"IDCompany\": 5647,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ada6324-b0fc-4d15-9ce7-405f415975a7", "name": "Erros de validação (prefixo `[BadRequest]`):\n- `Modalidade não existe`\n- `Já existe uma Modalidade com essa conta`", "originalRequest": { "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4a63e5e-6815-4ad1-9754-6e7bf75a643a", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CarrierModal\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1181ebde-3511-4b98-8ea5-5dfcef6bbac4", "name": "Exclui uma modalidade", "request": { "name": "Exclui uma modalidade", "description": { "content": "**Exclusão física** — a modalidade é apagada do banco. O sistema bloqueia a exclusão em duas situações: (1) **existe alguma transportadora** (fornecedor com `IDCarrierModal` apontando para esta) — é preciso remover/trocar a modalidade no cadastro da transportadora; (2) **existe configuração no de/para de transportadora** em `HubCarrier` apontando para esta.\n\nA resposta em sucesso é a lista atualizada de modalidades.", "type": "text/plain" }, "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7913241e-e5eb-4733-91ac-a1396c853eff", "name": "Modalidade excluída. Retorna a lista atualizada.", "originalRequest": { "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDCarrierModal\": 969,\n \"IDCompany\": 5007,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n },\n {\n \"IDCarrierModal\": 5923,\n \"IDCompany\": 5647,\n \"AccountName\": \"string\",\n \"CarrierModal\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3311a2ed-f36b-4ab4-b6ef-3c710108fe36", "name": "Bloqueios (prefixo `[BadRequest]`):\n- `Modalidade não existe`\n- `Há transportadora com essa modalidade, remover no cadastro da transportadora`\n- `Modalidade esta configurada no de/para de transportadora`", "originalRequest": { "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ad465d7-baec-4b57-ba34-59b914f2864f", "name": "Erro interno (prefixo `Error:`).", "originalRequest": { "url": { "path": [ "carrier", "modal", ":idcarriermodal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idcarriermodal", "description": "(Required) Identificador da modalidade de transportadora." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "42494006-ee81-4fd0-bb91-7f6f4a29d4eb", "name": "Movimentação de Estoque", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f01524fe-7833-4511-b546-708ebf311db5", "name": "Lista movimentações de estoque", "request": { "name": "Lista movimentações de estoque", "description": { "content": "Lista as movimentações de estoque com filtros por SKU, armazém, lote, período e dados do pedido de origem. O parâmetro `Type` troca o modo de consulta e o formato de cada item da resposta.\n\n`TypeSkuMovement` é `Saída` para `IDTypeMovement=1` e `Entrada` para `IDTypeMovement=0`.\n\n`TypeMovement` é derivado das vinculações da movimentação, nesta ordem de precedência: `Transferência endereço` quando há movimentação de origem `IDOriginIDSkuMovement`; `Ajuste saldo estoque` quando há ajuste de saldo `IDStockKeepingUnitInventory`; `Inventário` quando há apuração de inventário `IDStockKeepingUnitInventorySummary`; `Recebimento` quando há recebimento `IDPurchase`; quando há pedido `IDOrder`, `Transferência CD` se o tipo do pedido é de transferência entre centros de distribuição (`IsTransfer=1`) ou `Venda` caso contrário; `Produção` quando há produção `IDStockKeepingUnitProduction`. Na listagem padrão (sem `Type`) os três primeiros vínculos não são devolvidos, então ali `TypeMovement` só assume `Recebimento`, `Transferência CD`, `Venda`, `Produção` ou vazio — a classificação completa aparece nos modos `Kardex`, `KardexLocation`, `KardexBatch`, `SkuInbound` e `SkuOutbound`.\n\n`Login` traz o usuário responsável pelo ajuste de saldo ou pela transferência de endereço. Também só vem preenchido nos modos `Kardex`, `KardexLocation`, `KardexBatch`, `SkuInbound` e `SkuOutbound`; na listagem padrão volta sempre vazio.\n\nO modo `SkuFiscalConciliation` devolve o resultado sem esse enriquecimento — `TypeMovement`, `TypeSkuMovement` e `Login` não vêm nesse modo.\n\nCom `IncludeCategory=1` cada item ganha a categoria do SKU — nome `Category` e caminho completo `CategoryTree`. Só a listagem padrão devolve `IDCategory`, então nos demais valores de `Type` os dois campos voltam vazios.", "type": "text/plain" }, "url": { "path": [ "sku", "movement" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Type", "value": "Kardex", "description": "Modo de operacao. Quando ausente, retorna a listagem padrao. Valores aceitos: `Kardex` (ou `kardex`), `KardexLocation`, `KardexBatch`, `SkuInbound`, `SkuOutbound`, `SkuFiscalConciliation`. O shape da resposta muda conforme o `Type`." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Numero da pagina (offset = `Page * 1000` na listagem padrao, `Page * 8000` em `Kardex`/`KardexLocation`/`KardexBatch`, `Page * 1000` em `SkuInbound`/`SkuOutbound`)." }, { "disabled": false, "key": "OrderBy", "value": "ASC", "description": "Ordenação por data da movimentação `RecordTimestamp`. `ASC` (mais antigos primeiro) ou `DESC` (mais recentes primeiro). Padrão `ASC`. Aplica-se apenas aos modos `Kardex`, `KardexLocation`, `KardexBatch`, `SkuInbound` e `SkuOutbound` — a listagem padrão sempre devolve em ordem crescente de `IDSkuMovement` e o modo `SkuFiscalConciliation` ignora o parâmetro." }, { "disabled": false, "key": "IDSku", "value": "string", "description": "SKU. Aceita um ou vários códigos separados por vírgula ou espaço (ex.: `33895,398` ou `33895 398`). Obrigatório quando `Type` é `Kardex`, `KardexLocation`, `SkuInbound`, `SkuOutbound` ou `SkuFiscalConciliation`." }, { "disabled": false, "key": "IDStockKeepingUnitWarehouse", "value": "2232", "description": "Armazém da movimentação. Obrigatório quando `Type=Kardex` (ou `kardex`)." }, { "disabled": false, "key": "IDStockKeepingUnitLocation", "value": "2232", "description": "Endereço físico. Obrigatório quando `Type=KardexLocation`." }, { "disabled": false, "key": "IDCompany", "value": "2232", "description": "Conta a filtrar (em multi-empresa). Quando ausente, usa a conta autenticada." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Início do intervalo de data da movimentação (`YYYY-MM-DD`)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Fim do intervalo de data da movimentação (`YYYY-MM-DD`). O sistema acrescenta automaticamente `23:59:59` ao final." }, { "disabled": false, "key": "SkuName", "value": "string", "description": "Nome do produto (busca parcial — `LIKE`)." }, { "disabled": false, "key": "BarCode", "value": "string", "description": "Código de barras do SKU." }, { "disabled": false, "key": "IDBrand", "value": "2232", "description": "Marca do produto." }, { "disabled": false, "key": "SupplierCode", "value": "string", "description": "Código do SKU usado pelo fornecedor (busca parcial — `LIKE`)." }, { "disabled": false, "key": "IDSupplier", "value": "2232", "description": "Fornecedor (quando origem é recebimento)." }, { "disabled": false, "key": "Package", "value": "string", "description": "Embalagem cadastrada no SKU." }, { "disabled": false, "key": "IDSkuCompany", "value": "string", "description": "Código de referência do SKU (busca parcial — `LIKE`)." }, { "disabled": false, "key": "IDSkuHub", "value": "string", "description": "Código do SKU no canal de venda (`IDSkuHub`)." }, { "disabled": false, "key": "IDSkuMovement", "value": "2232", "description": "Identificador específico de uma movimentação." }, { "disabled": false, "key": "BalanceChange", "value": "1", "description": "Filtra apenas movimentações que alteram o saldo (`1`) ou que não alteram (`0`)." }, { "disabled": false, "key": "IDTypeMovement", "value": "1", "description": "Sentido da movimentação. `0` = entrada, `1` = saída." }, { "disabled": false, "key": "IDTypeFulfillmentNonconformity", "value": "1", "description": "Tipo de não conformidade no fulfillment." }, { "disabled": false, "key": "ConsumerNameCorporateName", "value": "string", "description": "Nome ou razão social do cliente do pedido (busca parcial)." }, { "disabled": false, "key": "ConsumerCpfCnpj", "value": "string", "description": "CPF/CNPJ do cliente (busca parcial)." }, { "disabled": false, "key": "ConsumerEmail", "value": "string", "description": "E-mail do cliente (busca parcial)." }, { "disabled": false, "key": "Order", "value": "string", "description": "Número/identificador do pedido (busca exata)." }, { "disabled": false, "key": "OrderFrom", "value": "string", "description": "Origem do pedido (`OrderFrom`)." }, { "disabled": false, "key": "IDOrder", "value": "2232", "description": "Pedido específico." }, { "disabled": false, "key": "IDConsumer", "value": "2232", "description": "Cliente específico." }, { "disabled": false, "key": "NfeNumber", "value": "2232", "description": "Número da NF-e vinculada." }, { "disabled": false, "key": "IDSalesChannel", "value": "2232", "description": "Canal de venda (`IDSalesChannel`)." }, { "disabled": false, "key": "IDCompanyIntegration", "value": "2232", "description": "Integração de venda (`CompanyIntegration`)." }, { "disabled": false, "key": "IDStatusOrder", "value": "2232", "description": "Status do pedido." }, { "disabled": false, "key": "IDStatusInvoice", "value": "2232", "description": "Status da NF-e." }, { "disabled": false, "key": "IDCarrier", "value": "2232", "description": "Transportadora do pedido." }, { "disabled": false, "key": "IDOrderType", "value": "2232", "description": "Tipo do pedido." }, { "disabled": false, "key": "ShippingState", "value": "string", "description": "UF de entrega do pedido." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Empresa faturadora do pedido." }, { "disabled": false, "key": "InvoiceDateFrom", "value": "1980-02-08", "description": "Início do intervalo da data de emissão da NF-e." }, { "disabled": false, "key": "InvoiceDateTo", "value": "1980-02-08", "description": "Fim do intervalo da data de emissão da NF-e (acrescenta `23:59:59`)." }, { "disabled": false, "key": "ShippingDateFrom", "value": "1980-02-08", "description": "Início do intervalo da data de envio." }, { "disabled": false, "key": "ShippingDateTo", "value": "1980-02-08", "description": "Fim do intervalo da data de envio." }, { "disabled": false, "key": "ValueOrderFrom", "value": "478.75460817372374", "description": "Valor mínimo do pedido." }, { "disabled": false, "key": "ValueOrderTo", "value": "478.75460817372374", "description": "Valor máximo do pedido." }, { "disabled": false, "key": "OrderDateFrom", "value": "1980-02-08", "description": "Início do intervalo da data de criação do pedido." }, { "disabled": false, "key": "OrderDateTo", "value": "1980-02-08", "description": "Fim do intervalo da data de criação do pedido (acrescenta `23:59:59`)." }, { "disabled": false, "key": "IncludeValueDashboard", "value": "1", "description": "Filtra por tipo de pedido marcado como `Incluir valor dashboard`." }, { "disabled": false, "key": "BatchComments", "value": "string", "description": "Descrição/Comentários do lote (busca exata)." }, { "disabled": false, "key": "SinceDateLastRecordModification", "value": "1978-04-10T08:52:42.717Z", "description": "Retorna apenas movimentações com `DateLastRecordModification >=` a data informada (`YYYY-MM-DD HH:MM:SS`). Útil para sincronização incremental." }, { "disabled": false, "key": "IDBatch", "value": "2232", "description": "Lote (`IDBatch`). Obrigatorio quando `Type=KardexBatch`. Nos demais modos, quando informado, restringe a movimentacao ao lote." }, { "disabled": false, "key": "IncludeCategory", "value": "1", "description": "Quando `1`, acrescenta a categoria do SKU a cada item — nome da categoria `Category` e caminho completo `CategoryTree` no formato `Pai -> Filha -> Neta`. Só vem preenchido na listagem padrão, que é o único modo que devolve `IDCategory`; nos demais valores de `Type` os dois campos voltam `null`. Padrão `0`." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b24bb31b-25fe-415d-8c5a-e9db99779720", "name": "Lista de movimentações conforme o `Type` requisitado.", "originalRequest": { "url": { "path": [ "sku", "movement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "Kardex" }, { "key": "Page", "value": "2232" }, { "key": "OrderBy", "value": "ASC" }, { "key": "IDSku", "value": "string" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDCompany", "value": "2232" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "SkuName", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "IDBrand", "value": "2232" }, { "key": "SupplierCode", "value": "string" }, { "key": "IDSupplier", "value": "2232" }, { "key": "Package", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "IDSkuHub", "value": "string" }, { "key": "IDSkuMovement", "value": "2232" }, { "key": "BalanceChange", "value": "1" }, { "key": "IDTypeMovement", "value": "1" }, { "key": "IDTypeFulfillmentNonconformity", "value": "1" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "ConsumerEmail", "value": "string" }, { "key": "Order", "value": "string" }, { "key": "OrderFrom", "value": "string" }, { "key": "IDOrder", "value": "2232" }, { "key": "IDConsumer", "value": "2232" }, { "key": "NfeNumber", "value": "2232" }, { "key": "IDSalesChannel", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDStatusOrder", "value": "2232" }, { "key": "IDStatusInvoice", "value": "2232" }, { "key": "IDCarrier", "value": "2232" }, { "key": "IDOrderType", "value": "2232" }, { "key": "ShippingState", "value": "string" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "InvoiceDateFrom", "value": "1980-02-08" }, { "key": "InvoiceDateTo", "value": "1980-02-08" }, { "key": "ShippingDateFrom", "value": "1980-02-08" }, { "key": "ShippingDateTo", "value": "1980-02-08" }, { "key": "ValueOrderFrom", "value": "478.75460817372374" }, { "key": "ValueOrderTo", "value": "478.75460817372374" }, { "key": "OrderDateFrom", "value": "1980-02-08" }, { "key": "OrderDateTo", "value": "1980-02-08" }, { "key": "IncludeValueDashboard", "value": "1" }, { "key": "BatchComments", "value": "string" }, { "key": "SinceDateLastRecordModification", "value": "1978-04-10T08:52:42.717Z" }, { "key": "IDBatch", "value": "2232" }, { "key": "IncludeCategory", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"AccountName\": \"string\",\n \"IDSkuMovement\": 5780,\n \"IDSku\": 6175,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Brand\": \"string\",\n \"CostSet\": 9079.119432943318,\n \"IDTypeMovement\": 0,\n \"TypeSkuMovement\": \"Entrada\",\n \"TypeMovement\": \"string\",\n \"RecordTimestamp\": \"1956-01-07T02:12:24.197Z\",\n \"DateLastRecordModification\": \"1977-11-01T12:37:31.536Z\",\n \"Quantity\": 234.37630041317715,\n \"BalanceChange\": 0,\n \"IDStatusSku\": 0,\n \"IDStockKeepingUnitWarehouse\": 4733,\n \"WarehouseName\": \"string\",\n \"IDBatch\": 7543,\n \"BatchComments\": \"string\",\n \"BestBeforeDate\": \"1984-06-02\",\n \"ManufacturingDate\": \"2009-10-19\",\n \"Comments\": \"string\",\n \"IDOrder\": 1967,\n \"Order\": \"string\",\n \"IDPurchase\": 4684,\n \"IDStockKeepingUnitProduction\": 1487,\n \"IDOriginIDSkuMovement\": 6768,\n \"IDStockKeepingUnitInventory\": 6147,\n \"IDStockKeepingUnitInventorySummary\": 5650,\n \"IDTypeFulfillmentNonconformity\": 6,\n \"TypeFulfillmentNonconformity\": \"string\",\n \"QuantityNonconformity\": 2533.088014180327,\n \"PriceSelling\": 2618.3090773244853,\n \"PriceSellingTotal\": 21.569316215404033,\n \"ValueCost\": 9102.915141447384,\n \"ValueCostTotal\": 2943.5468788737553,\n \"ValueCostUnitPurchase\": 4787.428163481171,\n \"NfeIpiValue\": 9565.602605949061,\n \"NfeIcmsSTValue\": 4889.7365871099055,\n \"NfeFcpSTValue\": 9585.681738556128,\n \"ValueDiscount\": 9947.3819254178,\n \"NfeCFOP\": \"string\",\n \"NfeNumber\": 1988,\n \"NfeDhEmi\": \"1992-09-09T09:44:30.957Z\",\n \"IDStatusInvoice\": 7585,\n \"StatusInvoice\": \"string\",\n \"IDStatusOrder\": 4034,\n \"StatusOrder\": \"string\",\n \"TypeOrder\": \"string\",\n \"IDOrderType\": 2443,\n \"OrderFrom\": \"string\",\n \"IDCompanyIntegration\": 3271,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyInvoice\": 5233,\n \"CompanyInvoiceNameCorporateName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"IDConsumer\": 6400,\n \"ShippingState\": \"string\",\n \"InvoiceFinishTimestamp\": \"1954-03-10T10:13:05.426Z\",\n \"CheckinTimestamp\": \"2003-02-18T22:21:42.980Z\",\n \"Login\": \"string\",\n \"IsTransfer\": 0,\n \"IDCategory\": 2500,\n \"AbcCurve\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"Category\": \"string\",\n \"CategoryTree\": \"string\",\n \"IDSupplier\": 2020,\n \"NfeIpiValueUnit\": 1078.3681146796775,\n \"NfeIcmsSTValueUnit\": 5932.766921041195,\n \"NfeFcpSTValueUnit\": 8325.601150115199,\n \"ValueDiscountUnit\": 5555.7583182215085\n },\n {\n \"AccountName\": \"string\",\n \"IDSkuMovement\": 4510,\n \"IDSku\": 1887,\n \"SkuName\": \"string\",\n \"IDSkuCompany\": \"string\",\n \"BarCode\": \"string\",\n \"Brand\": \"string\",\n \"CostSet\": 6461.043644882678,\n \"IDTypeMovement\": 0,\n \"TypeSkuMovement\": \"Entrada\",\n \"TypeMovement\": \"string\",\n \"RecordTimestamp\": \"1979-03-01T04:59:57.732Z\",\n \"DateLastRecordModification\": \"2025-02-10T16:49:28.337Z\",\n \"Quantity\": 6553.230197320303,\n \"BalanceChange\": 0,\n \"IDStatusSku\": 1,\n \"IDStockKeepingUnitWarehouse\": 3271,\n \"WarehouseName\": \"string\",\n \"IDBatch\": 1241,\n \"BatchComments\": \"string\",\n \"BestBeforeDate\": \"1993-09-16\",\n \"ManufacturingDate\": \"2026-03-13\",\n \"Comments\": \"string\",\n \"IDOrder\": 2716,\n \"Order\": \"string\",\n \"IDPurchase\": 7681,\n \"IDStockKeepingUnitProduction\": 1442,\n \"IDOriginIDSkuMovement\": 1492,\n \"IDStockKeepingUnitInventory\": 8272,\n \"IDStockKeepingUnitInventorySummary\": 4249,\n \"IDTypeFulfillmentNonconformity\": 6,\n \"TypeFulfillmentNonconformity\": \"string\",\n \"QuantityNonconformity\": 7822.352348622888,\n \"PriceSelling\": 1052.8131534783558,\n \"PriceSellingTotal\": 5739.694854105577,\n \"ValueCost\": 1542.145154236454,\n \"ValueCostTotal\": 4065.68344819658,\n \"ValueCostUnitPurchase\": 3115.7742986648905,\n \"NfeIpiValue\": 2174.5305978019023,\n \"NfeIcmsSTValue\": 6999.387699913346,\n \"NfeFcpSTValue\": 1187.1824885489723,\n \"ValueDiscount\": 4185.16284801548,\n \"NfeCFOP\": \"string\",\n \"NfeNumber\": 5484,\n \"NfeDhEmi\": \"1953-12-04T08:33:31.232Z\",\n \"IDStatusInvoice\": 9778,\n \"StatusInvoice\": \"string\",\n \"IDStatusOrder\": 6911,\n \"StatusOrder\": \"string\",\n \"TypeOrder\": \"string\",\n \"IDOrderType\": 4677,\n \"OrderFrom\": \"string\",\n \"IDCompanyIntegration\": 2956,\n \"CompanyIntegration\": \"string\",\n \"IDCompanyInvoice\": 4853,\n \"CompanyInvoiceNameCorporateName\": \"string\",\n \"AccountNameInvoice\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"IDConsumer\": 8215,\n \"ShippingState\": \"string\",\n \"InvoiceFinishTimestamp\": \"2025-02-27T22:07:09.315Z\",\n \"CheckinTimestamp\": \"2018-08-09T14:21:12.457Z\",\n \"Login\": \"string\",\n \"IsTransfer\": 0,\n \"IDCategory\": 5609,\n \"AbcCurve\": \"string\",\n \"MainImageThumbnailURL\": \"string\",\n \"Category\": \"string\",\n \"CategoryTree\": \"string\",\n \"IDSupplier\": 8804,\n \"NfeIpiValueUnit\": 2963.221566303078,\n \"NfeIcmsSTValueUnit\": 1457.0912218975106,\n \"NfeFcpSTValueUnit\": 596.3688242745202,\n \"ValueDiscountUnit\": 2958.628853161336\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80f01410-9d85-4709-8237-cb90a0c912f2", "name": "Falha de validação. Possíveis mensagens:\n- `[BadRequest] - Precisa informar o armazem e sku` — `Type=Kardex` sem `IDSku`/`IDStockKeepingUnitWarehouse`.\n- `[BadRequest] - Precisa informar o endereço e sku` — `Type=KardexLocation` sem `IDSku`/`IDStockKeepingUnitLocation`.\n- `[BadRequest] - Precisa informar o lote` — `Type=KardexBatch` sem `IDBatch`.", "originalRequest": { "url": { "path": [ "sku", "movement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "Kardex" }, { "key": "Page", "value": "2232" }, { "key": "OrderBy", "value": "ASC" }, { "key": "IDSku", "value": "string" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDCompany", "value": "2232" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "SkuName", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "IDBrand", "value": "2232" }, { "key": "SupplierCode", "value": "string" }, { "key": "IDSupplier", "value": "2232" }, { "key": "Package", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "IDSkuHub", "value": "string" }, { "key": "IDSkuMovement", "value": "2232" }, { "key": "BalanceChange", "value": "1" }, { "key": "IDTypeMovement", "value": "1" }, { "key": "IDTypeFulfillmentNonconformity", "value": "1" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "ConsumerEmail", "value": "string" }, { "key": "Order", "value": "string" }, { "key": "OrderFrom", "value": "string" }, { "key": "IDOrder", "value": "2232" }, { "key": "IDConsumer", "value": "2232" }, { "key": "NfeNumber", "value": "2232" }, { "key": "IDSalesChannel", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDStatusOrder", "value": "2232" }, { "key": "IDStatusInvoice", "value": "2232" }, { "key": "IDCarrier", "value": "2232" }, { "key": "IDOrderType", "value": "2232" }, { "key": "ShippingState", "value": "string" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "InvoiceDateFrom", "value": "1980-02-08" }, { "key": "InvoiceDateTo", "value": "1980-02-08" }, { "key": "ShippingDateFrom", "value": "1980-02-08" }, { "key": "ShippingDateTo", "value": "1980-02-08" }, { "key": "ValueOrderFrom", "value": "478.75460817372374" }, { "key": "ValueOrderTo", "value": "478.75460817372374" }, { "key": "OrderDateFrom", "value": "1980-02-08" }, { "key": "OrderDateTo", "value": "1980-02-08" }, { "key": "IncludeValueDashboard", "value": "1" }, { "key": "BatchComments", "value": "string" }, { "key": "SinceDateLastRecordModification", "value": "1978-04-10T08:52:42.717Z" }, { "key": "IDBatch", "value": "2232" }, { "key": "IncludeCategory", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a988ca3-7ee4-47d1-b26f-cf525e2a5059", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "movement" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Type", "value": "Kardex" }, { "key": "Page", "value": "2232" }, { "key": "OrderBy", "value": "ASC" }, { "key": "IDSku", "value": "string" }, { "key": "IDStockKeepingUnitWarehouse", "value": "2232" }, { "key": "IDStockKeepingUnitLocation", "value": "2232" }, { "key": "IDCompany", "value": "2232" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "SkuName", "value": "string" }, { "key": "BarCode", "value": "string" }, { "key": "IDBrand", "value": "2232" }, { "key": "SupplierCode", "value": "string" }, { "key": "IDSupplier", "value": "2232" }, { "key": "Package", "value": "string" }, { "key": "IDSkuCompany", "value": "string" }, { "key": "IDSkuHub", "value": "string" }, { "key": "IDSkuMovement", "value": "2232" }, { "key": "BalanceChange", "value": "1" }, { "key": "IDTypeMovement", "value": "1" }, { "key": "IDTypeFulfillmentNonconformity", "value": "1" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "ConsumerEmail", "value": "string" }, { "key": "Order", "value": "string" }, { "key": "OrderFrom", "value": "string" }, { "key": "IDOrder", "value": "2232" }, { "key": "IDConsumer", "value": "2232" }, { "key": "NfeNumber", "value": "2232" }, { "key": "IDSalesChannel", "value": "2232" }, { "key": "IDCompanyIntegration", "value": "2232" }, { "key": "IDStatusOrder", "value": "2232" }, { "key": "IDStatusInvoice", "value": "2232" }, { "key": "IDCarrier", "value": "2232" }, { "key": "IDOrderType", "value": "2232" }, { "key": "ShippingState", "value": "string" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "InvoiceDateFrom", "value": "1980-02-08" }, { "key": "InvoiceDateTo", "value": "1980-02-08" }, { "key": "ShippingDateFrom", "value": "1980-02-08" }, { "key": "ShippingDateTo", "value": "1980-02-08" }, { "key": "ValueOrderFrom", "value": "478.75460817372374" }, { "key": "ValueOrderTo", "value": "478.75460817372374" }, { "key": "OrderDateFrom", "value": "1980-02-08" }, { "key": "OrderDateTo", "value": "1980-02-08" }, { "key": "IncludeValueDashboard", "value": "1" }, { "key": "BatchComments", "value": "string" }, { "key": "SinceDateLastRecordModification", "value": "1978-04-10T08:52:42.717Z" }, { "key": "IDBatch", "value": "2232" }, { "key": "IncludeCategory", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cf85cba-24c0-4c1a-baa4-649735c26a58", "name": "Transfere quantidade entre armazéns/endereços", "request": { "name": "Transfere quantidade entre armazéns/endereços", "description": { "content": "Move quantidade de um SKU entre dois armazéns ou dois endereços/lotes, gerando **duas movimentações vinculadas** (saída na origem, entrada no destino). O custo unitário usado em ambas é o custo médio do armazém de origem — ou o valor de `CostSet` quando a parametrização `UseCostFromCostSet` está ativa.\n\nOrigem e destino precisam estar no **mesmo Centro de Distribuição**. O SKU precisa estar ativo e ser do tipo Sku, Matéria-prima ou Uso e consumo.\n\n**Modos de transferência:**\n- **Entre armazéns** — envie `IDStockKeepingUnitWarehouseFrom` + `IDStockKeepingUnitWarehouseTo`. O sistema consome lotes na ordem FIFO (mais antigo primeiro) até completar `Quantity`. Para SKU sem rastreabilidade usa o lote padrão.\n- **Entre lotes/endereços** — envie `IDBatchFrom` + (`IDBatchTo` **ou** `IDStockKeepingUnitLocationTo`). Quando vier só `IDStockKeepingUnitLocationTo`, o sistema procura um lote compatível no destino (mesma validade/fabricação/comentário) e o reutiliza; se não existir, cria um novo lote. Com a parametrização `KeepUniqueBatchForFiscalConciliation` ativa, **sempre cria um novo lote no destino**.\n\n**Validações:**\n- Se a quantidade total do lote origem for menor que `Quantity`, devolve `[BadRequest] - Quantidade total insuficiente para transferencia`. Pode ser contornado ativando `AllowNegativeBalanceTransfer` ou, no fluxo entre lotes/endereços, enviando `IgnoreBalance=1`.\n- Em transferência entre endereços com SKU rastreável, se o endereço destino já tem o mesmo SKU em lote divergente (validade/fabricação/comentário diferentes) e a parametrização `AllowSameItemDifferentBatchSameLocation` está inativa, devolve `[BadRequest] - Item possui lotes divergentes no endereço de destino`.\n\n**Efeitos colaterais:**\n- Atualiza o saldo agregado do SKU no armazém de destino e, quando o saldo do SKU nesse armazém fica negativo em algum ponto da linha do tempo, dispara o recálculo de custo do SKU.\n- Reprocessa pedidos no armazém de destino com status \"Falta produto\" e equivalentes (`IDStatusOrder` `11`, `12` e `24`), limpando `QuantityNonconformity` à medida que a quantidade transferida cobre as faltas, e devolvendo o pedido a `IDStatusOrder = 1` (Fechado) quando todos os itens voltam a ter saldo. Cada alteração gera evento de pedido (`IDEvent = 35`). No fluxo entre lotes/endereços entram as não conformidades `1`, `2`, `5` e `6`; no fluxo entre armazéns, apenas `5` e `6`.\n- Publica a notificação `SkuBalanceTransfer` para o webhook da empresa.\n\n**Resposta:** depende do fluxo. Na transferência **entre lotes/endereços**, por padrão devolve as duas movimentações criadas e, com `BatchResponse=1`, devolve a lista de lotes do SKU. Na transferência **entre armazéns**, a resposta é **sempre** a lista de lotes do SKU — `BatchResponse` não é considerado nesse fluxo.", "type": "text/plain" }, "url": { "path": [ "sku", "movement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "BatchResponse", "value": "1", "description": "Quando `1`, a resposta troca de array de movimentações para a lista de lotes do SKU. Padrão `0`. Vale apenas no fluxo entre lotes/endereços (`IDBatchFrom` + `IDBatchTo` ou `IDStockKeepingUnitLocationTo`) — a transferência entre armazéns devolve a lista de lotes independentemente deste parâmetro." }, { "disabled": false, "key": "IgnoreBalance", "value": "1", "description": "Quando `1`, ignora a validação de saldo na transferência por lote (mesma semântica de `AllowNegativeBalanceTransfer`, mas pontual). Vale apenas no fluxo `IDBatchFrom` + (`IDBatchTo` | `IDStockKeepingUnitLocationTo`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDSku\": 6336,\n \"Quantity\": 5982.829152835547,\n \"IDStockKeepingUnitWarehouseFrom\": 1819,\n \"IDStockKeepingUnitWarehouseTo\": 8429,\n \"IDBatchFrom\": 3635,\n \"IDBatchTo\": 577,\n \"IDStockKeepingUnitLocationTo\": 8849,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e46d59ce-0832-4f1d-8940-162ae4d6d53d", "name": "Transferência criada. No fluxo entre lotes/endereços retorna as duas movimentações criadas, ou a lista de lotes do SKU quando `BatchResponse=1`. No fluxo entre armazéns retorna sempre a lista de lotes do SKU.", "originalRequest": { "url": { "path": [ "sku", "movement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "BatchResponse", "value": "1" }, { "key": "IgnoreBalance", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 6336,\n \"Quantity\": 5982.829152835547,\n \"IDStockKeepingUnitWarehouseFrom\": 1819,\n \"IDStockKeepingUnitWarehouseTo\": 8429,\n \"IDBatchFrom\": 3635,\n \"IDBatchTo\": 577,\n \"IDStockKeepingUnitLocationTo\": 8849,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDSkuMovement\": 8327,\n \"IDSku\": 9433,\n \"IDTypeMovement\": 1,\n \"IDStatusSku\": 0,\n \"Quantity\": 3761.8132084664467,\n \"ValueCostTotal\": 3962.7984630122914,\n \"IDStockKeepingUnitWarehouse\": 2794,\n \"IDBatch\": 7376,\n \"IDOriginIDSkuMovement\": 5139,\n \"Comments\": \"string\",\n \"RecordTimestamp\": \"2022-06-29T14:24:08.119Z\",\n \"IDStockKeepingUnitLocation\": 5289,\n \"BestBeforeDate\": \"2016-04-24\",\n \"ManufacturingDate\": \"1996-07-22\"\n },\n {\n \"IDSkuMovement\": 9353,\n \"IDSku\": 2284,\n \"IDTypeMovement\": 0,\n \"IDStatusSku\": 4,\n \"Quantity\": 5048.790503914791,\n \"ValueCostTotal\": 2670.3269817105047,\n \"IDStockKeepingUnitWarehouse\": 8236,\n \"IDBatch\": 2620,\n \"IDOriginIDSkuMovement\": 8772,\n \"Comments\": \"string\",\n \"RecordTimestamp\": \"2013-10-25T16:13:44.901Z\",\n \"IDStockKeepingUnitLocation\": 1116,\n \"BestBeforeDate\": \"2025-05-21\",\n \"ManufacturingDate\": \"1974-12-31\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbad0969-4532-42a6-9bf3-719be848351b", "name": "Falha de validação. Possíveis mensagens:\n- `[BadRequest] - Quantidade precisa ser maior que zero` — `Quantity` ausente ou zero.\n- `[BadRequest] - SKU não existe` — `IDSku` inválido, de outra conta, inativo, ou item cujo tipo não é Sku, Matéria-prima ou Uso e consumo.\n- `[BadRequest] - Item não é do tipo SKU, matéria prima ou insumo` — o tipo do item não é Sku, Matéria-prima ou Uso e consumo.\n- `[BadRequest] - Lote origem não existe` — `IDBatchFrom` inválido.\n- `[BadRequest] - Lote destino não existe` — `IDBatchTo` inválido.\n- `[BadRequest] - Endereço destino não existe` — `IDStockKeepingUnitLocationTo` inválido.\n- `[BadRequest] - Armazém origem não existe` / `[BadRequest] - Armazém destino não existe` — armazém inválido ou de outra empresa.\n- `[BadRequest] - Centro de distribuição de origem diferente do destino` — armazéns/endereços em CDs diferentes.\n- `[BadRequest] - Item possui lotes divergentes no endereço de destino e não pode ser transferido` — bloqueio quando `AllowSameItemDifferentBatchSameLocation` está inativo.\n- `[BadRequest] - Quantidade total insuficiente para transferencia: Origem: X Transferência: Y` — saldo insuficiente (libere com `AllowNegativeBalanceTransfer` ou `IgnoreBalance=1`).\n- `[BadRequest] - Quantidade insuficiente para transferência` — não há lote disponível para consumir no armazém de origem.", "originalRequest": { "url": { "path": [ "sku", "movement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "BatchResponse", "value": "1" }, { "key": "IgnoreBalance", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 6336,\n \"Quantity\": 5982.829152835547,\n \"IDStockKeepingUnitWarehouseFrom\": 1819,\n \"IDStockKeepingUnitWarehouseTo\": 8429,\n \"IDBatchFrom\": 3635,\n \"IDBatchTo\": 577,\n \"IDStockKeepingUnitLocationTo\": 8849,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afb1ba8b-f506-4bb5-ac8e-82c870f07757", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "sku", "movement", "transfer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "BatchResponse", "value": "1" }, { "key": "IgnoreBalance", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDSku\": 6336,\n \"Quantity\": 5982.829152835547,\n \"IDStockKeepingUnitWarehouseFrom\": 1819,\n \"IDStockKeepingUnitWarehouseTo\": 8429,\n \"IDBatchFrom\": 3635,\n \"IDBatchTo\": 577,\n \"IDStockKeepingUnitLocationTo\": 8849,\n \"Comments\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a049222e-2a04-4b6e-8714-ef859a7973de", "name": "Módulos Contratados", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d32e4497-aedf-4071-bd42-3da10af51a5e", "name": "Lista os módulos contratados pela empresa com seus privilégios", "request": { "name": "Lista os módulos contratados pela empresa com seus privilégios", "description": { "content": "Retorna os grupos de módulos disponíveis, cada um com a lista de módulos contratados pela empresa e os privilégios associados a cada módulo. Usado para montar a árvore de permissões do perfil de acesso.", "type": "text/plain" }, "url": { "path": [ "company", "module" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ed030c3b-acab-4439-b711-ac15828ac321", "name": "Módulos retornados.", "originalRequest": { "url": { "path": [ "company", "module" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"Module\": [\n {\n \"ModuleGroupDescription\": \"string\",\n \"ModuleDescription\": \"string\",\n \"IDModule\": 9765,\n \"Privilege\": [\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 4738,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 9959,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n },\n {\n \"ModuleGroupDescription\": \"string\",\n \"ModuleDescription\": \"string\",\n \"IDModule\": 1916,\n \"Privilege\": [\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 8828,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 744,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"Module\": [\n {\n \"ModuleGroupDescription\": \"string\",\n \"ModuleDescription\": \"string\",\n \"IDModule\": 3102,\n \"Privilege\": [\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 3680,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 7110,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n },\n {\n \"ModuleGroupDescription\": \"string\",\n \"ModuleDescription\": \"string\",\n \"IDModule\": 8,\n \"Privilege\": [\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 8282,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n },\n {\n \"UserPrivilege\": \"string\",\n \"IDUserPrivilege\": 691,\n \"PrivilegeDescription\": \"string\",\n \"KeyWords\": \"string\"\n }\n ]\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "292efdc5-011c-42cb-99b1-164c4c49ef22", "name": "NF-e / NFC-e", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fbea83db-a4af-4b1c-b30e-2f3608b067ee", "name": "Lista NFs (NF-e modelos 55/65)", "request": { "name": "Lista NFs (NF-e modelos 55/65)", "description": { "content": "Lista as NFs (`NfCompany`) emitidas pelas empresas do grupo da conta autenticada (`IDCompany = company`), com pedido (`Orders`), faturador (`Company`), status (`TypeStatusInvoice`), tipo de operação (`NfTpNf`), tipo de emissão (`NfTpEmis`), finalidade (`NfFin`), modelo (`NfModNf`) e processo SEFAZ (`NfProcessCode`) já resolvidos. Paginação fixa em **5000 registros por página** (`Page=N` → offset `N*5000`).\n\n**Modo \"com pedidos pendentes\"** — quando `IDStatusInvoice` contém `0` (Pendente), o resultado inclui também os pedidos que ainda **não têm NF emitida** como entradas adicionais com `IDNfCompany=NULL`, `NfeNumber=NULL`, `NfeSerie=NULL` e `StatusInvoice=\"Pendente\"`. Permite que a tela mostre tanto NFs já emitidas quanto pedidos aguardando emissão.\n\n**Busca rápida `Search`** — casa contra `NfeNumber`, `IDOrder` (apenas valores ≥ `IDOrderThreeMonthsAgo` ), `Order` e `NfeChaveAcesso` (apenas quando a chave tem mais de 40 dígitos).", "type": "text/plain" }, "url": { "path": [ "invoice" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDNfCompany", "value": "2232", "description": "Filtra pelo id da NF." }, { "disabled": false, "key": "IDOrder", "value": "2232", "description": "Filtra pelo id interno do pedido." }, { "disabled": false, "key": "Order", "value": "string", "description": "Filtra pelo número do pedido." }, { "disabled": false, "key": "NfeNumber", "value": "2232", "description": "Filtra pelo número exato da NF." }, { "disabled": false, "key": "NfeNumberFrom", "value": "string", "description": "Início da faixa de número de NF (apenas dígitos)." }, { "disabled": false, "key": "NfeNumberTo", "value": "string", "description": "Fim da faixa de número de NF." }, { "disabled": false, "key": "NfeSerie", "value": "2232", "description": "Série da NF." }, { "disabled": false, "key": "IDStatusInvoice", "value": "string", "description": "Status da NF (`IDStatusInvoice`). Aceita CSV. **`0` (Pendente) na lista ativa o modo \"pedidos pendentes\"** descrito na descrição do endpoint." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra pelo faturador (id da empresa)." }, { "disabled": false, "key": "CompanyCpfCnpjInvoice", "value": "string", "description": "Filtra pelo CNPJ do faturador (apenas dígitos)." }, { "disabled": false, "key": "NfeChaveAcesso", "value": "string", "description": "Chave de acesso da NF (44 dígitos)." }, { "disabled": false, "key": "NfetpEmis", "value": "2232", "description": "Tipo de emissão (`NfetpEmis` — normal, contingência, etc.)." }, { "disabled": false, "key": "FinNFe", "value": "2232", "description": "Finalidade da NFe (`FinNFe` — normal, complementar, ajuste, devolução)." }, { "disabled": false, "key": "NfTpNf", "value": "2232", "description": "Tipo da NF (entrada/saída, `NfTpNf`)." }, { "disabled": false, "key": "NfedhEmiFrom", "value": "1980-02-08", "description": "Data inicial de emissão da NF." }, { "disabled": false, "key": "NfedhEmiTo", "value": "1980-02-08", "description": "Data final de emissão da NF (concatenada com ` 23:59:59`)." }, { "disabled": false, "key": "ConsumerNameCorporateName", "value": "string", "description": "Filtra pelo nome/razão social do cliente do pedido." }, { "disabled": false, "key": "ConsumerCpfCnpj", "value": "string", "description": "Filtra pelo CPF/CNPJ do cliente." }, { "disabled": false, "key": "ShippingState", "value": "string", "description": "Filtra pela UF de destino." }, { "disabled": false, "key": "NoOrder", "value": "1", "description": "`1` filtra apenas NFs sem pedido vinculado (numerações reservadas via `POST /invoice`)." }, { "disabled": false, "key": "Search", "value": "string", "description": "Busca rápida — aplica `OR` em `NfeNumber`, `IDOrder`, `Order` e `NfeChaveAcesso` (esta última só quando ≥ 40 dígitos). Limita pedidos a `IDOrder ≥ IDOrderThreeMonthsAgo`." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Página (offset = `Page * 5000`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "49ba3d60-62d4-4fb5-b85a-d40e60768e50", "name": "Lista combinada de NFs e (quando `IDStatusInvoice` inclui `0`) pedidos sem NF.", "originalRequest": { "url": { "path": [ "invoice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDNfCompany", "value": "2232" }, { "key": "IDOrder", "value": "2232" }, { "key": "Order", "value": "string" }, { "key": "NfeNumber", "value": "2232" }, { "key": "NfeNumberFrom", "value": "string" }, { "key": "NfeNumberTo", "value": "string" }, { "key": "NfeSerie", "value": "2232" }, { "key": "IDStatusInvoice", "value": "string" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "CompanyCpfCnpjInvoice", "value": "string" }, { "key": "NfeChaveAcesso", "value": "string" }, { "key": "NfetpEmis", "value": "2232" }, { "key": "FinNFe", "value": "2232" }, { "key": "NfTpNf", "value": "2232" }, { "key": "NfedhEmiFrom", "value": "1980-02-08" }, { "key": "NfedhEmiTo", "value": "1980-02-08" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "ShippingState", "value": "string" }, { "key": "NoOrder", "value": "1" }, { "key": "Search", "value": "string" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDNfCompany\": 7738,\n \"IDCompany\": 9938,\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 2177,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyCpfCnpjInvoice\": \"string\",\n \"IDOrder\": 7008,\n \"Order\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"NfeNumber\": 1365,\n \"NfeSerie\": 2610,\n \"NfeModelo\": 2408,\n \"NfModNfDescription\": \"string\",\n \"NfeChaveAcesso\": \"string\",\n \"NfedhEmi\": \"1968-04-27T06:22:21.626Z\",\n \"NfecStat\": 8827,\n \"NfProcessDescription\": \"string\",\n \"NfetpEmis\": 3645,\n \"NfetpEmisDescription\": \"string\",\n \"FinNfeDescription\": \"string\",\n \"NfTpNfDescription\": \"string\",\n \"IDStatusInvoice\": 3549,\n \"StatusInvoice\": \"string\",\n \"ValueNF\": 5299.727788781672,\n \"IDFile\": 449\n },\n {\n \"IDNfCompany\": 6139,\n \"IDCompany\": 5756,\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 5264,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CompanyCpfCnpjInvoice\": \"string\",\n \"IDOrder\": 2259,\n \"Order\": \"string\",\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"NfeNumber\": 7979,\n \"NfeSerie\": 7234,\n \"NfeModelo\": 5824,\n \"NfModNfDescription\": \"string\",\n \"NfeChaveAcesso\": \"string\",\n \"NfedhEmi\": \"2014-05-24T06:11:04.047Z\",\n \"NfecStat\": 7056,\n \"NfProcessDescription\": \"string\",\n \"NfetpEmis\": 9322,\n \"NfetpEmisDescription\": \"string\",\n \"FinNfeDescription\": \"string\",\n \"NfTpNfDescription\": \"string\",\n \"IDStatusInvoice\": 7432,\n \"StatusInvoice\": \"string\",\n \"ValueNF\": 5564.090322661894,\n \"IDFile\": 4926\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46da25f3-19c4-41b3-b4cf-e6c50e9ff3d7", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "invoice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDNfCompany", "value": "2232" }, { "key": "IDOrder", "value": "2232" }, { "key": "Order", "value": "string" }, { "key": "NfeNumber", "value": "2232" }, { "key": "NfeNumberFrom", "value": "string" }, { "key": "NfeNumberTo", "value": "string" }, { "key": "NfeSerie", "value": "2232" }, { "key": "IDStatusInvoice", "value": "string" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "CompanyCpfCnpjInvoice", "value": "string" }, { "key": "NfeChaveAcesso", "value": "string" }, { "key": "NfetpEmis", "value": "2232" }, { "key": "FinNFe", "value": "2232" }, { "key": "NfTpNf", "value": "2232" }, { "key": "NfedhEmiFrom", "value": "1980-02-08" }, { "key": "NfedhEmiTo", "value": "1980-02-08" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "ShippingState", "value": "string" }, { "key": "NoOrder", "value": "1" }, { "key": "Search", "value": "string" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "492e0ac1-7f4a-4440-8df1-89fdce6c7dc8", "name": "Reserva/registra numeração de NF sem pedido", "request": { "name": "Reserva/registra numeração de NF sem pedido", "description": { "content": "Cria um registro `NfCompany` apenas com `IDCompanyInvoice`, `NfeSerie`, `NfeNumber` e `NfeModelo` (sem `IDOrder`). Usado pelo botão **Gerar Numeração NF** da tela — quando a empresa precisa **registrar** um número manualmente (ex.: número emitido fora do sistema que precisa entrar para manter a sequência) ou **reservar** um número futuro. Valida que o `IDCompanyInvoice` pertence ao grupo da empresa (`CompanyMain`) e que a tupla (`IDCompanyInvoice`, `NfeSerie`, `NfeNumber`, `NfeModelo`) ainda não existe.", "type": "text/plain" }, "url": { "path": [ "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDCompanyInvoice\": 8763,\n \"NfeSerie\": 2530,\n \"NfeNumber\": 7144,\n \"NfeModelo\": 55\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6094f788-2636-4d81-b6ae-b39b578fa135", "name": "Numeração registrada. Corpo: string `\"sucesso\"`.", "originalRequest": { "url": { "path": [ "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyInvoice\": 8763,\n \"NfeSerie\": 2530,\n \"NfeNumber\": 7144,\n \"NfeModelo\": 55\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca654b87-e0e3-4f1f-98e0-52e6bbbfb882", "name": "`[BadRequest] - Já existe essa NF e Serie para a empresa emissora`; `[BadRequest] - Erro ao adicionar numeração`.", "originalRequest": { "url": { "path": [ "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyInvoice\": 8763,\n \"NfeSerie\": 2530,\n \"NfeNumber\": 7144,\n \"NfeModelo\": 55\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7f41db0-b480-4c96-b00b-25ed4b9a0bb0", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDCompanyInvoice\": 8763,\n \"NfeSerie\": 2530,\n \"NfeNumber\": 7144,\n \"NfeModelo\": 55\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74e8f306-61f2-4067-a2f6-e9efa6ed0018", "name": "Inutiliza NF", "request": { "name": "Inutiliza NF", "description": { "content": "Inutiliza na SEFAZ uma NF que **não chegou a ser emitida** (número \"queimado\" / sequência sem uso), marcando-a como `Inutilizada` no status fiscal. Usado pelo modal **Inutilizar NF** da tela. Body coleta justificativa (mínimo 15 caracteres pela regra da SEFAZ).", "type": "text/plain" }, "url": { "path": [ "invoice", ":idnfcompany", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idnfcompany", "description": "(Required) Id da NF (`IDNfCompany`) a inutilizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Comments\": \"stringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ba4dcaf6-0851-4d92-a64e-0c12d8985415", "name": "NF inutilizada.", "originalRequest": { "url": { "path": [ "invoice", ":idnfcompany", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idnfcompany", "description": "(Required) Id da NF (`IDNfCompany`) a inutilizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"stringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c17491a4-18d8-4dbf-8c2b-7452a2d5f469", "name": "Erros propagados pela SEFAZ ou validação interna do processo de retaguarda. Shape não confirmado.", "originalRequest": { "url": { "path": [ "invoice", ":idnfcompany", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idnfcompany", "description": "(Required) Id da NF (`IDNfCompany`) a inutilizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"stringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e625cea-f88f-4f8a-8107-eae68dd9e353", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "invoice", ":idnfcompany", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idnfcompany", "description": "(Required) Id da NF (`IDNfCompany`) a inutilizar." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Comments\": \"stringstringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a3d024e-5e88-4b5b-a8a2-9a3306f6d80b", "name": "Gera o DANFE (PDF) ou retorna o XML de uma nota fiscal", "request": { "name": "Gera o DANFE (PDF) ou retorna o XML de uma nota fiscal", "description": { "content": "Gera dinamicamente o documento auxiliar da nota fiscal (DANFE em PDF) a partir do XML da nota, ou devolve o próprio XML quando `Type=XML`. O endpoint cobre vários cenários — NF-e modelo 55, NFCe modelo 65, CFe-SAT modelo 59, e eventos de NF-e (carta de correção, inutilização e cancelamento), escolhendo o renderizador adequado conforme o modelo fiscal do documento e o tipo do arquivo.\n\nA origem do XML é controlada por `Folder`: `Invoice` (notas emitidas pela empresa, localizadas por `File` = `IDFile` ou por `IDOrder`), `Inbound` com `Origin=Purchase` (XML recebido em pedido de compra) ou `Inbound` com `Origin=Feed` (XML capturado pelo monitor de notas). O PDF inclui o logotipo da empresa quando configurado.\n\nA resposta é binária (`application/pdf` ou `application/xml`), não JSON.", "type": "text/plain" }, "url": { "path": [ "invoice", "danfe" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "Folder", "value": "Invoice", "description": "(Required) Origem do XML. `Invoice` para notas emitidas pela empresa; `Inbound` para XMLs recebidos (combinar com `Origin`)." }, { "disabled": false, "key": "File", "value": "string", "description": "Quando `Folder=Invoice`, identifica o arquivo pelo `IDFile`. Quando `Folder=Inbound`, identifica pela chave de acesso da NF-e. Pelo menos um entre `File` e `IDOrder` é obrigatório." }, { "disabled": false, "key": "IDOrder", "value": "string", "description": "Identificador do pedido cuja nota fiscal será impressa (alternativa a `File`)." }, { "disabled": false, "key": "Origin", "value": "Feed", "description": "Quando `Folder=Inbound`, define a origem do XML: `Purchase` (recebido em pedido de compra) ou `Feed` (monitor de notas)." }, { "disabled": false, "key": "Type", "value": "XML", "description": "Quando `XML`, devolve o arquivo XML cru em vez do PDF do DANFE." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": null }, "response": [ { "id": "50d99679-af55-4ebe-bbb1-d78e8e710690", "name": "PDF do DANFE (Content-Type `application/pdf`) ou arquivo XML (Content-Type herdado, `Content-Disposition: attachment`).", "originalRequest": { "url": { "path": [ "invoice", "danfe" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Folder", "value": "Invoice" }, { "key": "File", "value": "string" }, { "key": "IDOrder", "value": "string" }, { "key": "Origin", "value": "Feed" }, { "key": "Type", "value": "XML" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/xml" } ], "body": "\n(string)", "cookie": [], "_postman_previewlanguage": "xml" }, { "id": "5ae45cff-4e57-4b48-a510-a62ddffd3c1f", "name": "Validação ou arquivo não localizado. Mensagens: `Precisa enviar o querystring Folder`; `Precisa enviar o querystring File ou IDOrder`; `Arquivo não encontrado`; `Arquivo não encontrado S3`; `Pedido não localizado` (no fluxo público de tracking).", "originalRequest": { "url": { "path": [ "invoice", "danfe" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "Folder", "value": "Invoice" }, { "key": "File", "value": "string" }, { "key": "IDOrder", "value": "string" }, { "key": "Origin", "value": "Feed" }, { "key": "Type", "value": "XML" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e0fd19b-2cb4-4e36-8fd1-046ad50d5fc8", "name": "Gera DANFEs em lote", "request": { "name": "Gera DANFEs em lote", "description": { "content": "Recebe uma lista de pedidos/notas e dispara a geração em lote dos DANFEs, gerando um único PDF com todas as notas. Útil para imprimir várias notas de uma vez a partir da listagem de pedidos.\n\nA empresa autenticada (resolvida pelo subdomínio) é expandida para todas as filiais relacionadas — o lote pode percorrer notas de qualquer empresa do grupo.\n\nO corpo é um array de `IDOrder`. A resposta é binária — um único `application/pdf` com as DANFEs das notas principais (`Main=1`) dos pedidos, concatenadas.", "type": "text/plain" }, "url": { "path": [ "invoice", "danfe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ea87c735-1969-42f3-8bc7-f447d149d7c4", "name": "Lote processado. Conteúdo retornado depende do processo `ServiceInvoice::DanfeBulk` (contrato não confirmado).", "originalRequest": { "url": { "path": [ "invoice", "danfe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a30afd7f-e4e6-44c9-bdb6-38115c675ee8", "name": "Validação. Mensagens: `Precisa enviar os pedidos no corpo`; `Empresa não localizada`.", "originalRequest": { "url": { "path": [ "invoice", "danfe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "578b2ec6-9c0a-4965-9c2e-fd99f3be9a93", "name": "Gera o DANFE NFCe (modelo 65), recibo não fiscal ou via TEF", "request": { "name": "Gera o DANFE NFCe (modelo 65), recibo não fiscal ou via TEF", "description": { "content": "Gera o documento auxiliar do consumidor (DANFE NFCe modelo 65) para um pedido. O comportamento muda conforme os parâmetros:\n- Sem `OnlyTEFReceipt` e com `InvoiceType=1` (default): emite o cupom fiscal NFCe.\n- Com `InvoiceType=2`: emite um recibo não fiscal correspondente ao pedido.\n- Com `InvoiceType=3`: emite o cupom de troca/devolução (não fiscal) do pedido.\n- Com `OnlyTEFReceipt=1`: concatena os recibos de TEF (loja e/ou comprador) registrados na intenção de venda informada — útil para reimprimir comprovantes de cartão.\n\nA resposta é binária (PDF do cupom/recibo) ou texto bruto (recibos TEF).", "type": "text/plain" }, "url": { "path": [ "invoice", "danfe65" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDOrder", "value": "string", "description": "(Required) Identificador do pedido a imprimir." }, { "disabled": false, "key": "InvoiceType", "value": "1", "description": "`1` (default) imprime o cupom fiscal NFCe; `2` imprime o recibo não fiscal; `3` imprime o cupom de troca/devolução (não fiscal)." }, { "disabled": false, "key": "OrderGift", "value": "1", "description": "Quando `1`, gera o cupom em modo presente (sem valores)." }, { "disabled": false, "key": "IDOrderIntention", "value": "2232", "description": "Identificador da intenção de venda (PDV). Usado para localizar pagamentos TEF e para vincular o cupom à intenção." }, { "disabled": false, "key": "OnlyTEFReceipt", "value": "1", "description": "Quando `1`, devolve apenas os recibos TEF da intenção informada — não emite cupom fiscal." }, { "disabled": false, "key": "TEFReceiptStore", "value": "1", "description": "Quando `OnlyTEFReceipt=1`, inclui o recibo do estabelecimento (via loja)." }, { "disabled": false, "key": "TEFReceiptBuyer", "value": "1", "description": "Quando `OnlyTEFReceipt=1`, inclui o recibo do comprador (via cliente)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": null }, "response": [ { "id": "01049979-4d51-4c71-8e38-fbc776d99c0c", "name": "Cupom fiscal NFCe (PDF), recibo/cupom não fiscal, ou texto concatenado dos recibos TEF, dependendo dos parâmetros.", "originalRequest": { "url": { "path": [ "invoice", "danfe65" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDOrder", "value": "string" }, { "key": "InvoiceType", "value": "1" }, { "key": "OrderGift", "value": "1" }, { "key": "IDOrderIntention", "value": "2232" }, { "key": "OnlyTEFReceipt", "value": "1" }, { "key": "TEFReceiptStore", "value": "1" }, { "key": "TEFReceiptBuyer", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fe8b0580-a259-4943-865e-d8c46901cf54", "name": "Validação ou pedido não localizado. Mensagens: `necessário selecionar um pedido`; `Pedido não encontrado`.", "originalRequest": { "url": { "path": [ "invoice", "danfe65" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDOrder", "value": "string" }, { "key": "InvoiceType", "value": "1" }, { "key": "OrderGift", "value": "1" }, { "key": "IDOrderIntention", "value": "2232" }, { "key": "OnlyTEFReceipt", "value": "1" }, { "key": "TEFReceiptStore", "value": "1" }, { "key": "TEFReceiptBuyer", "value": "1" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "468b9536-7345-46af-9646-94d3f6becd29", "name": "NFS-e", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0895885c-a79a-4098-a1c6-4a9ab191dd19", "name": "Lista NFS-e (ServiceOrder)", "request": { "name": "Lista NFS-e (ServiceOrder)", "description": { "content": "Lista as NFS-e (`ServiceOrder`) cadastradas pela empresa autenticada, com `StatusInvoice` (de `TypeStatusInvoice`), `CityName`/`State` (de `IBGECityCode`), `ServiceDescription` (de `NfsServiceCode` quando cadastrado para o município), faturador (`IDCompanyInvoice` + `AccountNameInvoice` + `CompanyNameCorporateNameInvoice`), `NfsValue` computado como `NfsServiceQuantity * NfsServiceUnitValue` e `ValuePaid` (soma de `Value` em `AccountsPayableReceivable` vinculadas). Paginação fixa em **1000 registros por página** (`Page=N` → offset `N*1000`).\n\nFiltros são opcionais e combinados com `AND`. Janelas de data usam `BETWEEN` com `' 23:59:59'` apendado ao limite superior.", "type": "text/plain" }, "url": { "path": [ "invoice-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "IDServiceOrder", "value": "2232", "description": "Id interno da NFS-e." }, { "disabled": false, "key": "IDConsumer", "value": "2232", "description": "Id do cliente vinculado (`IDConsumer`)." }, { "disabled": false, "key": "ConsumerNameCorporateName", "value": "string", "description": "Busca parcial (`LIKE`) por nome/razão social do cliente." }, { "disabled": false, "key": "ConsumerCpfCnpj", "value": "string", "description": "Busca parcial (`LIKE`) por CPF/CNPJ do cliente. Apenas dígitos." }, { "disabled": false, "key": "NfsNumber", "value": "string", "description": "Número da NFS-e (apenas dígitos)." }, { "disabled": false, "key": "IDStatusInvoice", "value": "2232", "description": "Filtra pelo status da NF (`IDStatusInvoice`)." }, { "disabled": false, "key": "IDCompanyInvoice", "value": "2232", "description": "Filtra pelo faturador (id da empresa)." }, { "disabled": false, "key": "DateFrom", "value": "1980-02-08", "description": "Data inicial de criação (`RecordTimestamp ≥`)." }, { "disabled": false, "key": "DateTo", "value": "1980-02-08", "description": "Data final de criação (com `' 23:59:59'` apendado)." }, { "disabled": false, "key": "NfsDateFrom", "value": "1980-02-08", "description": "Data inicial de emissão (`NfsDate`)." }, { "disabled": false, "key": "NfsDateTo", "value": "1980-02-08", "description": "Data final de emissão." }, { "disabled": false, "key": "Page", "value": "2232", "description": "Página (offset = `Page * 1000`)." } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "187dc5f2-70fe-4cc1-a66f-c95de230ccab", "name": "Lista de NFS-e.", "originalRequest": { "url": { "path": [ "invoice-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDServiceOrder", "value": "2232" }, { "key": "IDConsumer", "value": "2232" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "NfsNumber", "value": "string" }, { "key": "IDStatusInvoice", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "NfsDateFrom", "value": "1980-02-08" }, { "key": "NfsDateTo", "value": "1980-02-08" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDServiceOrder\": 7398,\n \"RecordTimestamp\": \"1955-08-08T16:49:49.093Z\",\n \"IDCompany\": 7551,\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 6302,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CityCode\": 5356,\n \"CityName\": \"string\",\n \"State\": \"string\",\n \"IDConsumer\": 4226,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"IDAddress\": 8510,\n \"NfsDate\": \"1989-10-19T20:23:31.668Z\",\n \"NfsServiceCode\": \"string\",\n \"ServiceDescription\": \"string\",\n \"IDStatusInvoice\": 1744,\n \"StatusInvoice\": \"string\",\n \"NfsNumber\": 8800,\n \"NfsVerificationCode\": \"string\",\n \"NfsValue\": 696.119662379695,\n \"ValuePaid\": 3623.7487437765312\n },\n {\n \"IDServiceOrder\": 630,\n \"RecordTimestamp\": \"1997-08-17T14:49:01.830Z\",\n \"IDCompany\": 2954,\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 4804,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CityCode\": 153,\n \"CityName\": \"string\",\n \"State\": \"string\",\n \"IDConsumer\": 7087,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"IDAddress\": 4629,\n \"NfsDate\": \"1976-06-25T21:47:20.524Z\",\n \"NfsServiceCode\": \"string\",\n \"ServiceDescription\": \"string\",\n \"IDStatusInvoice\": 461,\n \"StatusInvoice\": \"string\",\n \"NfsNumber\": 2746,\n \"NfsVerificationCode\": \"string\",\n \"NfsValue\": 1447.750217888073,\n \"ValuePaid\": 8781.29153641488\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92109c6d-32d1-4a67-80c2-45d7feb55e6f", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "invoice-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "IDServiceOrder", "value": "2232" }, { "key": "IDConsumer", "value": "2232" }, { "key": "ConsumerNameCorporateName", "value": "string" }, { "key": "ConsumerCpfCnpj", "value": "string" }, { "key": "NfsNumber", "value": "string" }, { "key": "IDStatusInvoice", "value": "2232" }, { "key": "IDCompanyInvoice", "value": "2232" }, { "key": "DateFrom", "value": "1980-02-08" }, { "key": "DateTo", "value": "1980-02-08" }, { "key": "NfsDateFrom", "value": "1980-02-08" }, { "key": "NfsDateTo", "value": "1980-02-08" }, { "key": "Page", "value": "2232" } ], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f27c95d-4991-4627-80d5-2fb707a2f4bc", "name": "Cria NFS-e (modal Nova NF de Serviço)", "request": { "name": "Cria NFS-e (modal Nova NF de Serviço)", "description": { "content": "Cria uma NFS-e em status **Pendente** (`IDStatusInvoice=0`). Pré-condições verificadas pelo sistema: empresa precisa ter `Inscrição Municipal` cadastrada (`CompanyCityInscription`); endereço completo cadastrado (`CompanyAddressIbgeCityCode`); o município emite NFS-e (`NfseIssue = 1`). Quando `IDCompanyInvoice` informado, valida que pertence à empresa principal (`CompanyMain`).\n\nApós criar a NFS-e, **não emite** automaticamente — a emissão é uma ação subsequente (`POST /invoice-service/{idserviceorder}/invoice`).", "type": "text/plain" }, "url": { "path": [ "invoice-service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 6738,\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 2381,\n \"NfsServiceUnitValue\": 7586.617601990389,\n \"IDAddress\": 6051,\n \"IDOrder\": 9219,\n \"IDCompanyInvoice\": 251,\n \"NfsComments\": \"string\",\n \"NfsIRRFRetentionValue\": 7055.249770016368,\n \"NfsPISRetentionValue\": 9280.700951719882,\n \"NfsCOFINSRetentionValue\": 4493.334082661322,\n \"NfsCSLLRetentionValue\": 5591.044980558458,\n \"NfsISSAliquot\": 727.294647973673\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bab2b8e4-ffd4-4d95-b223-b673c20b2cd4", "name": "NFS-e criada. Devolve o detalhe (formato similar ao GET).", "originalRequest": { "url": { "path": [ "invoice-service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 6738,\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 2381,\n \"NfsServiceUnitValue\": 7586.617601990389,\n \"IDAddress\": 6051,\n \"IDOrder\": 9219,\n \"IDCompanyInvoice\": 251,\n \"NfsComments\": \"string\",\n \"NfsIRRFRetentionValue\": 7055.249770016368,\n \"NfsPISRetentionValue\": 9280.700951719882,\n \"NfsCOFINSRetentionValue\": 4493.334082661322,\n \"NfsCSLLRetentionValue\": 5591.044980558458,\n \"NfsISSAliquot\": 727.294647973673\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"IDServiceOrder\": 3447,\n \"RecordTimestamp\": \"1972-03-30T21:52:36.645Z\",\n \"IDCompany\": 6545,\n \"AccountName\": \"string\",\n \"IDCompanyInvoice\": 7146,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"CityCode\": 634,\n \"CityName\": \"string\",\n \"State\": \"string\",\n \"IDConsumer\": 7592,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"IDAddress\": 3502,\n \"NfsDate\": \"2019-09-15T09:54:42.416Z\",\n \"NfsServiceCode\": \"string\",\n \"ServiceDescription\": \"string\",\n \"IDStatusInvoice\": 3360,\n \"StatusInvoice\": \"string\",\n \"NfsNumber\": 8029,\n \"NfsVerificationCode\": \"string\",\n \"NfsValue\": 1173.793335496307,\n \"ValuePaid\": 4387.7027796567745\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe14660b-f3ec-4731-8316-0fe92cfd639e", "name": "`[BadRequest] - Faturador não existe`; `[BadRequest] - Obrigatório preencher a inscrição municipal no cadastro da empresa`; `[BadRequest] - Obrigatório preencher o endereço completo no cadastro da empresa`; `[BadRequest] - Cliente não existe`; `[BadRequest] - Município não emite NFS-e`.", "originalRequest": { "url": { "path": [ "invoice-service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 6738,\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 2381,\n \"NfsServiceUnitValue\": 7586.617601990389,\n \"IDAddress\": 6051,\n \"IDOrder\": 9219,\n \"IDCompanyInvoice\": 251,\n \"NfsComments\": \"string\",\n \"NfsIRRFRetentionValue\": 7055.249770016368,\n \"NfsPISRetentionValue\": 9280.700951719882,\n \"NfsCOFINSRetentionValue\": 4493.334082661322,\n \"NfsCSLLRetentionValue\": 5591.044980558458,\n \"NfsISSAliquot\": 727.294647973673\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f78da579-4e24-47bb-ae0e-6c5687f87f39", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "invoice-service" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 6738,\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 2381,\n \"NfsServiceUnitValue\": 7586.617601990389,\n \"IDAddress\": 6051,\n \"IDOrder\": 9219,\n \"IDCompanyInvoice\": 251,\n \"NfsComments\": \"string\",\n \"NfsIRRFRetentionValue\": 7055.249770016368,\n \"NfsPISRetentionValue\": 9280.700951719882,\n \"NfsCOFINSRetentionValue\": 4493.334082661322,\n \"NfsCSLLRetentionValue\": 5591.044980558458,\n \"NfsISSAliquot\": 727.294647973673\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "721143f8-1b59-48ba-924d-9ee6279ab164", "name": "Exclui NFS-e (ação Deletar da linha)", "request": { "name": "Exclui NFS-e (ação Deletar da linha)", "description": { "content": "Exclui definitivamente uma NFS-e, junto com o histórico e as contas a receber vinculadas a ela; boletos que apontavam para a nota ficam sem vínculo. A exclusão é bloqueada quando o status da nota não é `0` Pendente nem `1` Erro — Enviada, Emitida, Processando e Cancelada não podem ser excluídas — ou quando existe conta a receber vinculada já `2` Paga ou `3` Paga Parcialmente.", "type": "text/plain" }, "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "0f3bdf44-ccef-4780-a6d8-1e8d53af6e27", "name": "NFS-e excluída. Corpo: string `\"Sucesso\"`.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"Sucesso\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b87dedc-82e3-4d63-a806-918295d2238f", "name": "`[BadRequest] - Status nota fiscal não excluir NFSe` — a NFS-e só pode ser excluída enquanto está em `0` Pendente ou `1` Erro; qualquer status acima bloqueia, inclusive `2` Enviada, `3` Emitida, `4` Processando e `7` Cancelada. `[BadRequest] - Nota fiscal já tem pagamento baixado e não pode ser excluído` — existe título vinculado em `2` Pago ou `3` Pago Parcialmente.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "682e385a-d50f-4b3c-ade7-35201a1664db", "name": "`[NotFound] - NFSe não existe`.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4be8c2a8-b687-4050-bea8-814d9a08557e", "name": "Erro interno.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f77400d-d3ae-40ee-9301-44b1d30773cf", "name": "Detalha uma NFS-e", "request": { "name": "Detalha uma NFS-e", "description": { "content": "Retorna os dados completos de uma NFS-e (cabeçalho fiscal, cliente, endereço, retenções, serviço, status), com o histórico de eventos (`Events`), as contas a receber vinculadas (`Payments`) e URLs assinadas para baixar o XML e a DANFSE em PDF.", "type": "text/plain" }, "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Identificador da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5223d768-f159-4980-b681-fe3677a37a90", "name": "NFS-e encontrada.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Identificador da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDServiceOrder\": 4333,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"2005-05-12T19:41:27.677Z\",\n \"IDCompany\": 2310,\n \"CityCode\": 6680,\n \"CityName\": \"string\",\n \"State\": \"st\",\n \"IDConsumer\": 4082,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"IDAddress\": 4190,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"IDCompanyInvoice\": 6971,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"NfsComments\": \"string\",\n \"NfsDate\": \"1953-10-02T14:42:32.076Z\",\n \"NfsServiceCode\": \"string\",\n \"ServiceDescription\": \"string\",\n \"NfsServiceQuantity\": 7202,\n \"NfsServiceUnitValue\": 8884.181766445094,\n \"NfsValue\": 5892.214020436626,\n \"NfsIRRFRetentionValue\": 6871.696604867226,\n \"NfsPISRetentionValue\": 7883.478962956123,\n \"NfsCOFINSRetentionValue\": 2322.867866890237,\n \"NfsCSLLRetentionValue\": 2845.1723346208314,\n \"NfsISSAliquot\": 9935.791736306655,\n \"ReceiptNumber\": \"string\",\n \"RpsNumber\": 7357,\n \"NfsNumber\": 9349,\n \"NfsVerificationCode\": \"string\",\n \"NfsCancelDate\": \"2000-05-14T21:08:28.012Z\",\n \"NfsCancelDescription\": \"string\",\n \"NfsChaveAcesso\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"IDStatusInvoice\": 8195,\n \"StatusInvoice\": \"string\",\n \"NfsNBS\": \"string\",\n \"NfsNBSDescription\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCClassTribName\": \"string\",\n \"NfsCClassTribDescription\": \"string\",\n \"NfsCstIbsCbs\": \"string\",\n \"NfsCstIbsCbsDescription\": \"string\",\n \"NfsPRedIBS\": 7108.976520416192,\n \"NfsPRedCBS\": 6785.163607863689,\n \"NfsCIndOp\": \"string\",\n \"NfsCIndOpIBSLocation\": \"string\",\n \"NfsIndFinal\": 0,\n \"IDOrder\": 9757,\n \"ValuePaid\": 2219.485909171299,\n \"UrlFileXml\": \"string\",\n \"UrlFileDanfe\": \"string\",\n \"Events\": [\n {\n \"RecordTimestamp\": \"1982-02-17T03:05:44.351Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2006-11-01T11:37:32.274Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n }\n ],\n \"Payments\": [\n {\n \"IDAccountPayableReceivable\": 1688,\n \"PaymentDescription\": \"string\",\n \"Category\": 6794,\n \"Installment\": 2078,\n \"InstallmentTotal\": 5674,\n \"DateDue\": \"2004-12-23\",\n \"Value\": 6490.493438468812,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 1996,\n \"IDConsumer\": 1464,\n \"IDTypeAccountPayableReceivable\": 9960,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 7656,\n \"IDStatusAccountPayableReceivable\": 1,\n \"IDBankAccountForecast\": 2734,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 6817,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 1812\n },\n {\n \"IDAccountPayableReceivable\": 3292,\n \"PaymentDescription\": \"string\",\n \"Category\": 3902,\n \"Installment\": 84,\n \"InstallmentTotal\": 4165,\n \"DateDue\": \"1979-03-18\",\n \"Value\": 5809.950257697238,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 2747,\n \"IDConsumer\": 3373,\n \"IDTypeAccountPayableReceivable\": 7572,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 9608,\n \"IDStatusAccountPayableReceivable\": 5,\n \"IDBankAccountForecast\": 649,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 3444,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 3163\n }\n ]\n },\n {\n \"IDServiceOrder\": 4034,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"2003-07-17T07:45:23.341Z\",\n \"IDCompany\": 6723,\n \"CityCode\": 9771,\n \"CityName\": \"string\",\n \"State\": \"st\",\n \"IDConsumer\": 7236,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"IDAddress\": 4502,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"IDCompanyInvoice\": 3483,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"NfsComments\": \"string\",\n \"NfsDate\": \"1992-02-07T00:51:34.287Z\",\n \"NfsServiceCode\": \"string\",\n \"ServiceDescription\": \"string\",\n \"NfsServiceQuantity\": 4011,\n \"NfsServiceUnitValue\": 8598.863056239223,\n \"NfsValue\": 3004.185410212128,\n \"NfsIRRFRetentionValue\": 575.6270153165422,\n \"NfsPISRetentionValue\": 147.61729003528677,\n \"NfsCOFINSRetentionValue\": 2007.5260972970898,\n \"NfsCSLLRetentionValue\": 3572.34393201463,\n \"NfsISSAliquot\": 7248.118349371777,\n \"ReceiptNumber\": \"string\",\n \"RpsNumber\": 6130,\n \"NfsNumber\": 5284,\n \"NfsVerificationCode\": \"string\",\n \"NfsCancelDate\": \"1982-09-09T10:38:40.318Z\",\n \"NfsCancelDescription\": \"string\",\n \"NfsChaveAcesso\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"IDStatusInvoice\": 8740,\n \"StatusInvoice\": \"string\",\n \"NfsNBS\": \"string\",\n \"NfsNBSDescription\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCClassTribName\": \"string\",\n \"NfsCClassTribDescription\": \"string\",\n \"NfsCstIbsCbs\": \"string\",\n \"NfsCstIbsCbsDescription\": \"string\",\n \"NfsPRedIBS\": 5943.991577850472,\n \"NfsPRedCBS\": 8821.656822500592,\n \"NfsCIndOp\": \"string\",\n \"NfsCIndOpIBSLocation\": \"string\",\n \"NfsIndFinal\": 0,\n \"IDOrder\": 6045,\n \"ValuePaid\": 6826.1251220778795,\n \"UrlFileXml\": \"string\",\n \"UrlFileDanfe\": \"string\",\n \"Events\": [\n {\n \"RecordTimestamp\": \"1987-07-10T18:22:37.398Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n },\n {\n \"RecordTimestamp\": \"2003-07-27T02:41:35.823Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n }\n ],\n \"Payments\": [\n {\n \"IDAccountPayableReceivable\": 2014,\n \"PaymentDescription\": \"string\",\n \"Category\": 7499,\n \"Installment\": 7733,\n \"InstallmentTotal\": 4512,\n \"DateDue\": \"1994-11-18\",\n \"Value\": 9400.138733350575,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 5283,\n \"IDConsumer\": 3397,\n \"IDTypeAccountPayableReceivable\": 6257,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 9998,\n \"IDStatusAccountPayableReceivable\": 5,\n \"IDBankAccountForecast\": 8162,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 7978,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 8676\n },\n {\n \"IDAccountPayableReceivable\": 1196,\n \"PaymentDescription\": \"string\",\n \"Category\": 8886,\n \"Installment\": 2769,\n \"InstallmentTotal\": 5044,\n \"DateDue\": \"1965-08-08\",\n \"Value\": 5914.482220525246,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 895,\n \"IDConsumer\": 7962,\n \"IDTypeAccountPayableReceivable\": 8705,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 8197,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDBankAccountForecast\": 9964,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 2160,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 9577\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d893fb6-cb11-4902-a8fb-9ac442c2769f", "name": "Atualiza uma NFS-e", "request": { "name": "Atualiza uma NFS-e", "description": { "content": "Atualiza os dados de uma NFS-e antes da emissão. A operação só é permitida enquanto o status estiver em Pendente ou Erro (`IDStatusInvoice <= 1`). Calcula automaticamente as retenções (IRRF, CSLL, PIS, COFINS) quando o valor da retenção é enviado como `null` e a empresa tem percentual configurado, copia dados do cliente e do endereço escolhidos para a nota, e registra o histórico de alterações. Exige inscrição municipal e endereço completo cadastrados na empresa, e que o município emita NFS-e.", "type": "text/plain" }, "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Identificador da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 3599,\n \"IDAddress\": 3186,\n \"IDCompanyInvoice\": 2007,\n \"NfsComments\": \"string\",\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 309,\n \"NfsServiceUnitValue\": 775.6709782397464,\n \"NfsIRRFRetentionValue\": 5009.271379584828,\n \"NfsPISRetentionValue\": 1579.226141175447,\n \"NfsCOFINSRetentionValue\": 3561.2488767893137,\n \"NfsCSLLRetentionValue\": 9772.108031287278,\n \"NfsISSAliquot\": 7343.251412464402,\n \"NfsNBS\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCIndOp\": \"string\",\n \"NfsIndFinal\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "509e14c9-c567-4bdd-b887-c0843d4e4afa", "name": "NFS-e atualizada. Retorna o detalhe completo (mesmo schema do `GET`).", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Identificador da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 3599,\n \"IDAddress\": 3186,\n \"IDCompanyInvoice\": 2007,\n \"NfsComments\": \"string\",\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 309,\n \"NfsServiceUnitValue\": 775.6709782397464,\n \"NfsIRRFRetentionValue\": 5009.271379584828,\n \"NfsPISRetentionValue\": 1579.226141175447,\n \"NfsCOFINSRetentionValue\": 3561.2488767893137,\n \"NfsCSLLRetentionValue\": 9772.108031287278,\n \"NfsISSAliquot\": 7343.251412464402,\n \"NfsNBS\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCIndOp\": \"string\",\n \"NfsIndFinal\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"IDServiceOrder\": 8932,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1970-10-09T11:22:29.182Z\",\n \"IDCompany\": 6368,\n \"CityCode\": 3603,\n \"CityName\": \"string\",\n \"State\": \"st\",\n \"IDConsumer\": 1117,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"IDAddress\": 2991,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"IDCompanyInvoice\": 5446,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"NfsComments\": \"string\",\n \"NfsDate\": \"1969-01-04T13:59:49.079Z\",\n \"NfsServiceCode\": \"string\",\n \"ServiceDescription\": \"string\",\n \"NfsServiceQuantity\": 8136,\n \"NfsServiceUnitValue\": 7071.205562932608,\n \"NfsValue\": 4780.403000000087,\n \"NfsIRRFRetentionValue\": 9531.16563319316,\n \"NfsPISRetentionValue\": 1893.6882185108584,\n \"NfsCOFINSRetentionValue\": 8854.90435166345,\n \"NfsCSLLRetentionValue\": 2191.8276823304427,\n \"NfsISSAliquot\": 7723.607683900779,\n \"ReceiptNumber\": \"string\",\n \"RpsNumber\": 9996,\n \"NfsNumber\": 5400,\n \"NfsVerificationCode\": \"string\",\n \"NfsCancelDate\": \"1950-11-14T13:00:28.841Z\",\n \"NfsCancelDescription\": \"string\",\n \"NfsChaveAcesso\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"IDStatusInvoice\": 4469,\n \"StatusInvoice\": \"string\",\n \"NfsNBS\": \"string\",\n \"NfsNBSDescription\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCClassTribName\": \"string\",\n \"NfsCClassTribDescription\": \"string\",\n \"NfsCstIbsCbs\": \"string\",\n \"NfsCstIbsCbsDescription\": \"string\",\n \"NfsPRedIBS\": 603.2249154359959,\n \"NfsPRedCBS\": 5626.111956534869,\n \"NfsCIndOp\": \"string\",\n \"NfsCIndOpIBSLocation\": \"string\",\n \"NfsIndFinal\": 0,\n \"IDOrder\": 6916,\n \"ValuePaid\": 9119.583569440201,\n \"UrlFileXml\": \"string\",\n \"UrlFileDanfe\": \"string\",\n \"Events\": [\n {\n \"RecordTimestamp\": \"1954-09-10T05:01:31.086Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n },\n {\n \"RecordTimestamp\": \"1966-05-01T03:35:48.517Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n }\n ],\n \"Payments\": [\n {\n \"IDAccountPayableReceivable\": 9917,\n \"PaymentDescription\": \"string\",\n \"Category\": 7938,\n \"Installment\": 7189,\n \"InstallmentTotal\": 7810,\n \"DateDue\": \"1975-08-23\",\n \"Value\": 7874.925917758606,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 2205,\n \"IDConsumer\": 7480,\n \"IDTypeAccountPayableReceivable\": 8356,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 5566,\n \"IDStatusAccountPayableReceivable\": 3,\n \"IDBankAccountForecast\": 1063,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 2969,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 122\n },\n {\n \"IDAccountPayableReceivable\": 737,\n \"PaymentDescription\": \"string\",\n \"Category\": 8849,\n \"Installment\": 7980,\n \"InstallmentTotal\": 1024,\n \"DateDue\": \"1985-10-16\",\n \"Value\": 5316.294594262794,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 7538,\n \"IDConsumer\": 278,\n \"IDTypeAccountPayableReceivable\": 1553,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 381,\n \"IDStatusAccountPayableReceivable\": 2,\n \"IDBankAccountForecast\": 5489,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 4477,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 6092\n }\n ]\n },\n {\n \"IDServiceOrder\": 6171,\n \"AccountName\": \"string\",\n \"RecordTimestamp\": \"1955-07-29T00:42:47.503Z\",\n \"IDCompany\": 2458,\n \"CityCode\": 9809,\n \"CityName\": \"string\",\n \"State\": \"st\",\n \"IDConsumer\": 6270,\n \"ConsumerNameCorporateName\": \"string\",\n \"ConsumerCpfCnpj\": \"string\",\n \"ConsumerEmail\": \"string\",\n \"ConsumerTelephone\": \"string\",\n \"IDAddress\": 4895,\n \"ShippingStreet\": \"string\",\n \"ShippingNumber\": \"string\",\n \"ShippingComplement\": \"string\",\n \"ShippingNeighborhood\": \"string\",\n \"ShippingCity\": \"string\",\n \"ShippingState\": \"st\",\n \"ShippingPostalCode\": \"string\",\n \"ShippingReceiverName\": \"string\",\n \"IDCompanyInvoice\": 8188,\n \"AccountNameInvoice\": \"string\",\n \"CompanyNameCorporateNameInvoice\": \"string\",\n \"NfsComments\": \"string\",\n \"NfsDate\": \"2008-03-12T05:43:28.660Z\",\n \"NfsServiceCode\": \"string\",\n \"ServiceDescription\": \"string\",\n \"NfsServiceQuantity\": 7715,\n \"NfsServiceUnitValue\": 3454.932360007945,\n \"NfsValue\": 3456.95964412122,\n \"NfsIRRFRetentionValue\": 9121.339160042347,\n \"NfsPISRetentionValue\": 8697.215897906122,\n \"NfsCOFINSRetentionValue\": 4169.008491751622,\n \"NfsCSLLRetentionValue\": 9666.317345875432,\n \"NfsISSAliquot\": 3408.365050293205,\n \"ReceiptNumber\": \"string\",\n \"RpsNumber\": 2146,\n \"NfsNumber\": 2039,\n \"NfsVerificationCode\": \"string\",\n \"NfsCancelDate\": \"1956-09-22T07:02:29.741Z\",\n \"NfsCancelDescription\": \"string\",\n \"NfsChaveAcesso\": \"string\",\n \"CompanyCityInscription\": \"string\",\n \"IDStatusInvoice\": 9231,\n \"StatusInvoice\": \"string\",\n \"NfsNBS\": \"string\",\n \"NfsNBSDescription\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCClassTribName\": \"string\",\n \"NfsCClassTribDescription\": \"string\",\n \"NfsCstIbsCbs\": \"string\",\n \"NfsCstIbsCbsDescription\": \"string\",\n \"NfsPRedIBS\": 205.89576467906488,\n \"NfsPRedCBS\": 8233.221181945242,\n \"NfsCIndOp\": \"string\",\n \"NfsCIndOpIBSLocation\": \"string\",\n \"NfsIndFinal\": 1,\n \"IDOrder\": 2905,\n \"ValuePaid\": 9633.31160197985,\n \"UrlFileXml\": \"string\",\n \"UrlFileDanfe\": \"string\",\n \"Events\": [\n {\n \"RecordTimestamp\": \"1956-05-28T13:18:18.875Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n },\n {\n \"RecordTimestamp\": \"1988-10-01T14:50:27.436Z\",\n \"Comments\": \"string\",\n \"Event\": \"string\",\n \"RecordUserCreated\": \"string\",\n \"Status\": \"string\"\n }\n ],\n \"Payments\": [\n {\n \"IDAccountPayableReceivable\": 9747,\n \"PaymentDescription\": \"string\",\n \"Category\": 4117,\n \"Installment\": 397,\n \"InstallmentTotal\": 232,\n \"DateDue\": \"1990-11-27\",\n \"Value\": 7339.866030853955,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 6365,\n \"IDConsumer\": 4291,\n \"IDTypeAccountPayableReceivable\": 7299,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 3296,\n \"IDStatusAccountPayableReceivable\": 4,\n \"IDBankAccountForecast\": 5630,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 3607,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 6504\n },\n {\n \"IDAccountPayableReceivable\": 6993,\n \"PaymentDescription\": \"string\",\n \"Category\": 2637,\n \"Installment\": 9395,\n \"InstallmentTotal\": 5630,\n \"DateDue\": \"1992-10-24\",\n \"Value\": 4458.340603608885,\n \"TID\": \"string\",\n \"NSU\": \"string\",\n \"IDTypePayment\": 3449,\n \"IDConsumer\": 1874,\n \"IDTypeAccountPayableReceivable\": 4056,\n \"TypeAccountPaybleDescription\": \"string\",\n \"IDTypeDocument\": 6360,\n \"IDStatusAccountPayableReceivable\": 6,\n \"IDBankAccountForecast\": 3271,\n \"Bank\": \"string\",\n \"BankSlipBarCode\": \"string\",\n \"BankSlipUrl\": \"string\",\n \"IDCompanyIntegration\": 5869,\n \"CompanyIntegration\": \"string\",\n \"DaysDue\": 4038\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34971f2a-858c-4724-ae2a-58d68d00a530", "name": "Validação falhou. Mensagens reais: `[BadRequest] - Status nota fiscal não permite edição`, `[BadRequest] - Obrigatório preencher a inscrição municipal no cadastro da empresa`, `[BadRequest] - Obrigatório preencher o endereço completo no cadastro da empresa`, `[BadRequest] - Município não possui integração de emissão de NFSe`, `[BadRequest] - Cliente não existe`, `[BadRequest] - Endereço não existe`, `[BadRequest] - Faturador não existe`, `[BadRequest] - Código serviço não existe`, `[BadRequest] - NBS não existe`, `[BadRequest] - Código Indicador de Operação não existe`, `[BadRequest] - Código de Classificação tributária não existe`.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Identificador da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 3599,\n \"IDAddress\": 3186,\n \"IDCompanyInvoice\": 2007,\n \"NfsComments\": \"string\",\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 309,\n \"NfsServiceUnitValue\": 775.6709782397464,\n \"NfsIRRFRetentionValue\": 5009.271379584828,\n \"NfsPISRetentionValue\": 1579.226141175447,\n \"NfsCOFINSRetentionValue\": 3561.2488767893137,\n \"NfsCSLLRetentionValue\": 9772.108031287278,\n \"NfsISSAliquot\": 7343.251412464402,\n \"NfsNBS\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCIndOp\": \"string\",\n \"NfsIndFinal\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eaefe4ee-2315-44ae-a304-d496fbfd35bf", "name": "NFS-e não encontrada: `[NotFound] - NFSe não existe`.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Identificador da NFS-e." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"IDConsumer\": 3599,\n \"IDAddress\": 3186,\n \"IDCompanyInvoice\": 2007,\n \"NfsComments\": \"string\",\n \"NfsServiceCode\": \"string\",\n \"NfsServiceQuantity\": 309,\n \"NfsServiceUnitValue\": 775.6709782397464,\n \"NfsIRRFRetentionValue\": 5009.271379584828,\n \"NfsPISRetentionValue\": 1579.226141175447,\n \"NfsCOFINSRetentionValue\": 3561.2488767893137,\n \"NfsCSLLRetentionValue\": 9772.108031287278,\n \"NfsISSAliquot\": 7343.251412464402,\n \"NfsNBS\": \"string\",\n \"NfsCClassTrib\": \"string\",\n \"NfsCIndOp\": \"string\",\n \"NfsIndFinal\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68649349-91cd-4996-89bb-c9eae7efb780", "name": "Emite a NFS-e na prefeitura (Mais Ações)", "request": { "name": "Emite a NFS-e na prefeitura (Mais Ações)", "description": { "content": "Dispara a emissão da NFS-e identificada por `idserviceorder`: conecta ao webservice da prefeitura, valida e devolve o número/protocolo da nota emitida. Mensagens de erro (validação local ou rejeição da prefeitura) são prefixadas com `[BadRequest]`.\n\nValida que a NFS-e existe e pertence à empresa autenticada antes de emitir.", "type": "text/plain" }, "url": { "path": [ "invoice-service", ":idserviceorder", "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e a emitir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "99a7c80e-4595-4038-a045-8800c92106cb", "name": "Retorno do processo de retaguarda (geralmente o objeto da NFS-e atualizado com `NfsNumber`, `NfsVerificationCode`, `IDStatusInvoice`).", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder", "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e a emitir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": true,\n \"key_1\": 4623,\n \"key_2\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72d7f3a7-9a57-4cfb-9393-31f5dba91960", "name": "`[BadRequest] - ` (validação ou rejeição da prefeitura).", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder", "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e a emitir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errorMessage\": \"[BadRequest] - Fornecedor ou cliente precisa ser preenchido (apenas um dos dois)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9867157f-49d1-4f0c-9f49-ee0908bf141f", "name": "`[NotFound] - NFSe não existe`.", "originalRequest": { "url": { "path": [ "invoice-service", ":idserviceorder", "invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2232", "key": "idserviceorder", "description": "(Required) Id da NFS-e a emitir." }, { "description": "Nome da conta idworks do cliente (use \"teste\" para a conta de demonstração).", "type": "any", "value": "{{AccountName}}", "key": "AccountName" }, { "description": "Versão da API", "type": "any", "value": "{{basePath}}", "key": "basePath" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/