2.0info: 1.4.0 Integração WMS description: Serviço para integração do YMS com WMS x-senior-domain: Integrações do YMS x-senior-domain-path: yms_int x-senior-service-path: wms contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/yms_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /wms/queries/isStartAllowedByThirdParty: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaId properties: agendaId: type: string description: ID do agendamento responses: 200: description: Ok schema: type: object allOf: – #/definitions/validationOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: agendaId description: ID do agendamento in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/validationOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/findDocuments: post: description: Busca Documentos Fiscais no WMS pela chave tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: documentType: type: string allOf: – #/definitions/documentType description: Tipo de Documento documentKeys: type: array items: type: string description: Chave do Documento Fiscal invoices: type: array items: type: object allOf: – #/definitions/invoiceHeader description: Cabeçalho da Nora Fiscal logistcUnitName: type: string description: Nome da Empresa ou Armazem size: type: integer format: int64 description: Tamanho da página de resultados default: 10 offset: type: integer format: int64 description: Offset da página de resultador default: 0 purchaseOrder: type: string description: Ordem de Compra responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/document description: Conteúdo dos docuemntos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/getSystemIntegration: post: description: Retorna o tipo de sistema que esta configurado para integração tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – system – code properties: system: type: string allOf: – #/definitions/wmsSystem description: Tipo de Sistema Integrador code: type: integer format: int64 description: Código do Sistema 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o tipo de sistema que esta configurado para integração tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – system – code properties: system: type: string allOf: – #/definitions/wmsSystem description: Tipo de Sistema Integrador code: type: integer format: int64 description: Código do Sistema 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/cancelScheduleByDocument: post: description: Cancela as agendas vinculadas à chave (key) do documento (que pode ser ordem de compra, nota fiscal, entreoutros).\nDesde que o agendamento tenha um dos seguintes status:\nAguardando Confirmação, Agendado, Rejeitado ou Aguardando Confirmação do Solicitante.\nCaso o agendamento esteja em qualquer outro status, o cancelamento não será realizado,\nretornando quais agendas foram canceladas ou não e o motivo.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – key properties: key: type: string description: Chave identificadora do documento, correspondente ao campo key da entidade documento,\nque geralmente será o código da nota fiscal ou da ordem de compra. observation: type: string description: Este campo permite a inclusão de uma observação para o cancelamento do agendamento, o preenchimento não é obrigatório. responses: 200: description: Ok schema: type: object required: – canceledSchedules properties: canceledSchedules: type: array items: type: object allOf: – #/definitions/canceledSchedule minimum: 1 description: Lista de agendas que foram canceladas, incluindo detalhes sobre o status de cancelamento e o motivo correspondente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Cancela as agendas vinculadas à chave (key) do documento (que pode ser ordem de compra, nota fiscal, entreoutros).\nDesde que o agendamento tenha um dos seguintes status:\nAguardando Confirmação, Agendado, Rejeitado ou Aguardando Confirmação do Solicitante.\nCaso o agendamento esteja em qualquer outro status, o cancelamento não será realizado,\nretornando quais agendas foram canceladas ou não e o motivo.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: key description: Chave identificadora do documento, correspondente ao campo key da entidade documento,\nque geralmente será o código da nota fiscal ou da ordem de compra. in: query required: true type: string – name: observation description: Este campo permite a inclusão de uma observação para o cancelamento do agendamento, o preenchimento não é obrigatório. in: query type: string responses: 200: description: Ok schema: type: object required: – canceledSchedules properties: canceledSchedules: type: array items: type: object allOf: – #/definitions/canceledSchedule minimum: 1 description: Lista de agendas que foram canceladas, incluindo detalhes sobre o status de cancelamento e o motivo correspondente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/operatingHours: post: description: Retorna os cronogramas operacionais disponíveis por código de tipo de agendamento, planta e data tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – schedulingTypeCode – operatingDate – plantId properties: schedulingTypeCode: type: string description: Código do tipo de agendamento no WMS operatingDate: type: string format: date description: A data em que se deseja verificar os horários de operação plantId: type: string description: ID ou CNPJ da planta responses: 200: description: Ok schema: type: object properties: schedules: type: array items: type: object allOf: – #/definitions/OperatingHoursSchedule description: Available schedules for the given date 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os cronogramas operacionais disponíveis por código de tipo de agendamento, planta e data tags: – Queries x-senior-visibility: PRIVATE parameters: – name: schedulingTypeCode description: Código do tipo de agendamento no WMS in: query required: true type: string – name: operatingDate description: A data em que se deseja verificar os horários de operação in: query required: true type: string format: date – name: plantId description: ID ou CNPJ da planta in: query required: true type: string responses: 200: description: Ok schema: type: object properties: schedules: type: array items: type: object allOf: – #/definitions/OperatingHoursSchedule description: Available schedules for the given date 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/exportDocument: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/exportLogWmsIntegracao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/exportDadosColeta: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/exportAgenda: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/validarOrdemRecebimento: post: description: Valida se o WMS tem uma ordem de recebimento associada a agenda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaId properties: agendaId: type: string description: ID do agendamento responses: 200: description: Ok schema: type: object allOf: – #/definitions/validationOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/checkIn: post: description: Checkin WMS – Refaz busca dos documentos presentes no agendamento e sinaliza sisteam externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – schedulingId properties: schedulingId: type: string description: ID do agendamento responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/document description: Conteúdo dos documentos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/notifyVehicleRelease: post: description: Recebe notificação do WMS sobre liberação de veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentKey – status properties: documentKey: type: string description: ID do agendamento YMS status: type: string description: Status da liberação (LIBERADO) dataHoraControle: type: string description: Data e hora do controle note: type: string description: Observações adicionais responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Confirmação do processamento message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/createDriver: post: description: Garante cadastro do motorista no YMS por CPF: busca primeiro e cria somente quando não existir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cpf – name properties: cpf: type: string description: CPF do motorista name: type: string description: Nome completo do motorista rg: type: string description: RG do motorista responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/createAgendaFromColeta: post: description: Cria uma agenda no YMS a partir dos dados de uma coleta gerada no WMS. **IMPORTANTE:** Este endpoint é idempotente – se já existir uma agenda para o número de coleta informado, retornará a agenda existente ao invés de criar uma nova, evitando duplicações. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – numeroColeta – tipoAgendamento – cnpjPlanta properties: numeroColeta: type: string description: Número da Coleta no WMS – Identificador único da coleta gerada no sistema WMS tipoAgendamento: type: string description: Tipo de Agendamento – Descrição do tipo (ex: EXPEDICAO, RECEBIMENTO, CROSS-DOCKING) cnpjPlanta: type: string description: CNPJ da Planta – CNPJ da unidade logística (armazém/CD) onde ocorrerá a operação dataEsperadaColeta: type: string format: date description: Data Esperada da Coleta – Data prevista para a operação (formato: YYYY-MM-DD) horaEsperadaColeta: type: string description: Hora Esperada da Coleta – Hora prevista para início da operação (formato: HH:mm:ss) motorista: type: object allOf: – #/definitions/dadosMotorista description: Dados do Motorista – CPF, nome completo, RG e CNH do motorista (agregado ou interno) parceiro: type: object allOf: – #/definitions/dadosTransportadora description: Dados da Transportadora/Parceiro – CNPJ, código e nome fantasia da transportadora placaVeiculo: type: string description: Placa do Veículo – Placa do veículo que realizará o transporte (formato: AAA-0000 ou AAA0A00) documentos: type: array items: type: object allOf: – #/definitions/dadosDocumento description: Documentos Fiscais – Lista de notas fiscais vinculadas à coleta (chave de acesso, número e série) observacao: type: string description: Observações – Informações adicionais sobre a coleta (doca, rua de expedição, contato, etc) responses: 200: description: Ok schema: type: object required: – agendaId – codigoAgenda – numeroColeta properties: agendaId: type: string description: UUID da Agenda – Identificador único da agenda criada no YMS (deve ser armazenado no WMS) codigoAgenda: type: integer format: int64 description: Código da Agenda – Número sequencial legivel da agenda no YMS numeroColeta: type: string description: Número da Coleta – Confirmação do número da coleta WMS processada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/updateAgendaFromColeta: post: description: Atualiza uma agenda existente no YMS com dados modificados da coleta no WMS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaId – numeroColeta properties: agendaId: type: string description: UUID da Agenda – Identificador único retornado na criação (agendaId) numeroColeta: type: string description: Número da Coleta – Número da coleta no WMS para rastreamento dataEsperadaColeta: type: string format: date description: Nova Data Esperada – Atualização da data prevista (se houver reagendamento) horaEsperadaColeta: type: string description: Nova Hora Esperada – Atualização da hora prevista (se houver reagendamento) motorista: type: object allOf: – #/definitions/dadosMotorista description: Dados do Motorista – Substitui o motorista vinculado à agenda (se houver troca) placaVeiculo: type: string description: Placa do Veículo – Atualiza a placa do veículo (se houver troca de veículo) documentosAdicionar: type: array items: type: object allOf: – #/definitions/dadosDocumento description: Documentos a Adicionar – Novas notas fiscais que foram incluídas na coleta WMS documentosRemover: type: array items: type: object allOf: – #/definitions/dadosDocumentoRemover description: Documentos a Remover – Identificação das notas fiscais que foram removidas da coleta WMS (pode usar chaveAcesso OU numeroDocumento+serieDocumento) observacao: type: string description: Observações – Atualização de informações adicionais sobre a coleta responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/cancelAgendaFromColeta: post: description: Cancela uma agenda no YMS quando a coleta é excluída ou cancelada no WMS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaId – numeroColeta – motivo properties: agendaId: type: string description: UUID da Agenda – Identificador único retornado na criação (agendaId) numeroColeta: type: string description: Número da Coleta – Número da coleta no WMS para rastreamento motivo: type: string description: Motivo do Cancelamento – Justificativa do cancelamento da coleta no WMS responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/importDocument: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/importLogWmsIntegracao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/importDadosColeta: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/actions/importAgenda: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/signals/logCleanupSignal: post: description: Sinal para limpeza dos logs de integração WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – retentionDays properties: retentionDays: type: integer format: int64 description: Número de dias para manter os logs (registros mais antigos serão removidos) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /wms/events/importDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/events/exportDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/events/importLogWmsIntegracaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/events/exportLogWmsIntegracaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/events/importDadosColetaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/events/exportDadosColetaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/events/importAgendaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/events/exportAgendaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /wms/entities/document: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/document/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocument responses: 200: description: Ok schema: #/definitions/editDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/document/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/logWmsIntegracao: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/logWmsIntegracao responses: 200: description: The created resource schema: #/definitions/logWmsIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/logWmsIntegracao responses: 200: description: The created resource schema: #/definitions/logWmsIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/logWmsIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/logWmsIntegracao/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLogWmsIntegracao responses: 200: description: Ok schema: #/definitions/editLogWmsIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/logWmsIntegracao responses: 200: description: Ok schema: #/definitions/logWmsIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/logWmsIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/logWmsIntegracao/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/logWmsIntegracao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/dadosColeta: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dadosColeta responses: 200: description: The created resource schema: #/definitions/dadosColeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dadosColeta responses: 200: description: The created resource schema: #/definitions/dadosColeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dadosColeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/dadosColeta/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDadosColeta responses: 200: description: Ok schema: #/definitions/editDadosColeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dadosColeta responses: 200: description: Ok schema: #/definitions/dadosColeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dadosColeta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /wms/entities/dadosColeta/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dadosColeta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: tipoMotorista: type: string enum: – PROPRIO – AGREGADO – TERCEIRO description: Tipo de Motorista – Classificação do vínculo empregatício: * `PROPRIO` – Motorista Próprio – Funcionário direto da empresa * `AGREGADO` – Motorista Agregado – Prestador de serviço com vínculo * `TERCEIRO` – Motorista Terceiro – Motorista de empresa terceirizada wmsSystem: type: string enum: – NONE – SENIOR – WIS – ALCIS – SENIOR_CONNECT – PARTNER – SENIOR_ERP – GENERIC description: Define o WMS integrador: * `NONE` – 0) Nenhum * `SENIOR` – 1) WMS Senior Silt * `WIS` – 2) Wis * `ALCIS` – 3) Alcis * `SENIOR_CONNECT` – 4) Integração Senior Connect * `PARTNER` – 5) Parceiro * `SENIOR_ERP` – 6) Parceiro * `GENERIC` – 99) Outro Sistema WMS documentType: type: string enum: – INBOUND – OUTBOUND description: Tipo de Documento: * `INBOUND` – Recebimento * `OUTBOUND` – Expedição statusAgendamento: type: string enum: – AGUARDANDO_CONFIRMACAO – AGUARDANDO_CONFIRMACAO_SOLICITANTE – AGENDADO – REJEITADO – CANCELADO – EM_EXECUCAO – CONCLUIDO – AGUARDANDO_INTEGRACAO – REJEITADO_POR_INTEGRACAO – AGUARDANDO_POR_VALIDACAO – REJEITADO_POR_VALIDACAO – ERRO_INTEGRACAO description: Status da Agenda: * `AGUARDANDO_CONFIRMACAO` – Aguardando Confirmação * `AGUARDANDO_CONFIRMACAO_SOLICITANTE` – Aguardando Confirmação Solicitante * `AGENDADO` – Agendado * `REJEITADO` – Rejeitado * `CANCELADO` – Cancelado * `EM_EXECUCAO` – Em execução * `CONCLUIDO` – Concluído * `AGUARDANDO_INTEGRACAO` – Agenda está aguardando a resposta de uma integração com terceiros * `REJEITADO_POR_INTEGRACAO` – Agenda não pode ser executada porque houve um erro com a integração com terceiros * `AGUARDANDO_POR_VALIDACAO` – Agenda esta aguardando por validação * `REJEITADO_POR_VALIDACAO` – Agenda rejeitada pela regras de validação da agenda * `ERRO_INTEGRACAO` – Quando há um erro de integração invoiceCondition: type: string enum: – AUTHORIZED – PARTIAL_AUTHORIZED – MANUAL_AUTHORIZED – DEVOLUTION – REJECTED – DIVERGENCE userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim document: description: Representa um documento fiscal associado a agenda do YMS type: object required: – schedulingId – key properties: id: type: string format: uuid description: Identificador schedulingId: type: string format: uuid description: ID do agendamento type: type: string allOf: – #/definitions/documentType description: Tipo de Documento key: type: string description: Chave do Documento invoiceKey: type: string description: Chave da Nota Fiscal invoiceNumber: type: string description: Número da Nota presente no documento invoiceSerialNumber: type: string description: Número da Serie da Nota presente no documento systemIntegration: type: string allOf: – #/definitions/wmsSystem description: Sistema WMS Integrado logistcUnitName: type: string description: Unidade Logistica – Empresa ou Armazem logistcUnitDocument: type: string description: Código Documento que identica Unidade Logistica: CNPJ/CPF/CODIGO ownerName: type: string description: Nome do Depositante ownerDocument: type: string description: Código Documento que identica o Depositante: CNPJ/CPF partnerName: type: string description: Nome do Parceiro partnerDocument: type: string description: Código Documento que identica o Parceiro CNPJ/CPF notes: type: string description: Observações Adicionais code: type: string description: Identificador da Documento no WMS invoiceCondition: type: string allOf: – #/definitions/invoiceCondition description: Status do Documento cnpjEmitente: type: string description: Documento do Parceiro Emitente (CNPJ/CPF) razaoSocialEmitente: type: string description: Nome do Parceiro Emitente cnpjCpfDestinatario: type: string description: Documento do Destinatário (CNPJ/CPF) nomeRazaoSocialDestinatario: type: string description: Nome do Destinatário enderecoDestinatario: type: string description: Endereço Completo do Destinatário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocument: type: object required: – id allOf: – #/definitions/document logWmsIntegracao: description: Registra logs de integração entre WMS e YMS type: object required: – nome – entradaEm properties: id: type: string format: uuid description: Identificador nome: type: string description: Nome do endpoint/operação entradaEm: type: string format: date-time description: Data e hora de entrada da requisição saidaEm: type: string format: date-time description: Data e hora de saída da resposta entrada: type: string maxLength: 100000 description: Payload de entrada (requisição) saida: type: string maxLength: 100000 description: Payload de saída (resposta) stackTrace: type: string maxLength: 100000 description: Stack trace em caso de erro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editLogWmsIntegracao: type: object required: – id allOf: – #/definitions/logWmsIntegracao dadosColeta: description: Armazena dados da coleta WMS vinculados à agenda do YMS type: object required: – agendaId – numeroColeta properties: id: type: string format: uuid description: Identificador técnico agendaId: type: string format: uuid description: ID da Agenda no YMS – Referência para a agenda criada (chave de negócio) numeroColeta: type: string description: Número da Coleta no WMS – Identificador da coleta no sistema WMS createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDadosColeta: type: object required: – id allOf: – #/definitions/dadosColeta agenda: description: Entidade externa Agenda type: object required: – descricao – status – dataEsperadaAgendamento properties: id: type: string format: uuid description: Id da Agenda codigo: type: integer format: int64 description: Código identificador da agenda descricao: type: string description: Descrição do Agendamento status: type: string description: Status Agendamento dataEsperadaAgendamento: type: string format: date-time description: Data Esperada de Inicio do Agendamento motoristaId: type: string format: uuid description: ID do Motorista veiculoId: type: string format: uuid description: ID do Veículo extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: canceledSchedule: description: Retorno das agendas canceladas, incluindo o motivo caso alguma agenda não tenha sido cancelada. type: object required: – code – isCanceled properties: code: type: integer format: int64 description: Código da agenda isCanceled: type: boolean description: Campo que informa se a agenda foi cancelada ou não message: type: string description: Informa se o cancelamento foi bem-sucedido e, caso não tenha sido, o motivo da falha. invoiceHeader: description: Cabeçalho Nota Fiscal type: object properties: number: type: string description: Número da Nota presente no documento serialNumber: type: string description: Número da Nota presente no documento partnerDocument: type: string description: Código Documento que identifica CNPJ/CPF validationOutput: description: Resultado de um endpoint de validação type: object required: – aprovado properties: aprovado: type: boolean description: se está tudo certo messages: type: string format: byte description: Mensagem de erro, se tiver dadosMotorista: description: Dados do Motorista – Informações cadastrais do motorista (agregado ou interno) provenientes do WMS type: object required: – cpf – nome properties: cpf: type: string description: CPF do Motorista – Número do CPF (somente números, sem pontos ou traços) nome: type: string description: Nome Completo – Nome completo do motorista conforme documento rg: type: string description: RG – Número do Registro Geral (Carteira de Identidade) tipoMotorista: type: string allOf: – #/definitions/tipoMotorista description: Tipo de Motorista – Classificação: Próprio, Agregado ou Terceiro (padrão: Terceiro se não informado) dadosTransportadora: description: Dados da Transportadora/Parceiro – Informações cadastrais da transportadora provenientes do WMS type: object required: – cpfCnpj – nome properties: cpfCnpj: type: string description: CNPJ/CPF da Transportadora – Número do CNPJ ou CPF (somente números, sem pontos, traços ou barras) nome: type: string description: Nome Fantasia – Razão social ou nome fantasia da transportadora dadosDocumento: description: Dados do Documento Fiscal – Informações da nota fiscal vinculada à coleta provenientes do WMS type: object required: – chaveAcesso – numeroDocumento – serieDocumento properties: chaveAcesso: type: string description: Chave de Acesso – Chave de acesso da NF-e (44 dígitos) para identificação única do documento numeroDocumento: type: string description: Número do Documento – Número sequencial da nota fiscal serieDocumento: type: string description: Série do Documento – Série da nota fiscal cnpjEmitente: type: string description: Documento do Parceiro Emitente (CNPJ/CPF) razaoSocialEmitente: type: string description: Nome do Parceiro Emitente cnpjCpfDestinatario: type: string description: Documento do Destinatário (CNPJ/CPF) nomeRazaoSocialDestinatario: type: string description: Nome do Destinatário enderecoDestinatario: type: string description: Endereço Completo do Destinatário razaoSocialUnidade: type: string description: Nome da Unidade Logística cnpjCpfUnidade: type: string description: Documento da Unidade Logística (CNPJ/CPF) dadosDocumentoRemover: description: Dados para Remoção de Documento – Identificação do documento a ser removido (informar pelo menos um campo) type: object properties: chaveAcesso: type: string description: Chave de Acesso – Chave de acesso da NF-e (44 dígitos) numeroDocumento: type: string description: Número do Documento – Número sequencial da nota fiscal serieDocumento: type: string description: Série do Documento – Série da nota fiscal motorista: description: Dados mínimos do motorista referenciado pela agenda type: object properties: id: type: string description: Identificador do motorista nome: type: string description: Nome completo do motorista veiculo: description: Representação mínima de um veículo type: object properties: id: type: string description: Identificador do veículo placa: type: string description: Placa do veículo composicaoVeiculo: description: Composição de veículo com primário e secundários type: object properties: primario: type: object allOf: – #/definitions/veiculo description: Veículo primário da composição OperatingHoursSchedule: description: Representa um horário de funcionamento disponível type: object required: – schedule – available properties: schedule: type: string description: Horário no formato HH:mm:ss available: type: integer format: int64 description: Disponível notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage