2.0info: 0.21.2 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/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/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/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/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/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/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: 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/document responses: 200: description: Ok schema: #/definitions/document 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 definitions: wmsSystem: description: Define o WMS integrador type: string enum: – NONE – SENIOR – WIS – ALCIS – SENIOR_CONNECT – GENERIC documentType: description: Tipo de Documento type: string enum: – INBOUND – OUTBOUND statusAgendamento: description: Status da Agenda 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 invoiceCondition: description: type: string enum: – AUTHORIZED – PARTIAL_AUTHORIZED – MANUAL_AUTHORIZED – DEVOLUTION – REJECTED userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 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 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE