• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/wmsx (WMSX)/Serviço Mobile para Coletor de Dados (mobile)
Mais pesquisados:Customização, Tutorial, Documentação

Serviço Mobile para Coletor de Dados (mobile)

9 views 0 09/11/2026 integrador

2.0info: 0.11.0 Serviço Mobile para Coletor de Dados description: Serviço API Mobile Coletor de Dados x-senior-domain: Gestão de Armazenagem x-senior-domain-path: wmsx x-senior-service-path: mobile 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/wmsxsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /mobile/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviç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: – status properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/queries/context: post: description: Contexto do usuário incluindo menu tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: locale: type: string description: Locale para resolver textos internacionalizados. Ex: en-US responses: 200: description: Ok schema: type: object required: – version – menu properties: type: string description: Versão da API menu: type: array items: type: object allOf: – #/definitions/menuItem minimum: 1 description: Menu com os itens do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Contexto do usuário incluindo menu tags: – Queries x-senior-visibility: PRIVATE parameters: – name: locale description: Locale para resolver textos internacionalizados. Ex: en-US in: query type: string responses: 200: description: Ok schema: type: object required: – version – menu properties: type: string description: Versão da API menu: type: array items: type: object allOf: – #/definitions/menuItem minimum: 1 description: Menu com os itens do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/queries/hasCheckTaskInProgress: post: description: Verifica se tem inspeção em andamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type properties: type: type: string allOf: – #/definitions/checkType description: Tipo de validação esperada filter: type: object allOf: – #/definitions/wmsContextFilter description: Contexto padrão do WMS responses: 200: description: Ok schema: type: object allOf: – #/definitions/checkTask 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/queries/startCheck: post: description: Inicia a próxima validação disponível para execução no coletor ou informa por id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type properties: type: type: string allOf: – #/definitions/checkType description: Tipo de validação esperada filter: type: object allOf: – #/definitions/wmsContextFilter description: Contexto padrão do WMS referenceId: type: string description: Identificador da operação específica que deve ser validada responses: 200: description: Ok schema: type: object allOf: – #/definitions/checkTask 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/queries/getPendingCheck: post: description: Consulta as checagens pendentes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type properties: type: type: string allOf: – #/definitions/checkType description: Tipo de checagem esperada filter: type: object allOf: – #/definitions/wmsContextFilter description: Contexto padrão do WMS offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Identifica a quantidade de itens a ser obtido na página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents 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/checkTask minimum: 1 description: Lista de Checagens Pendente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/queries/receiptCheckinFilters: post: description: Consulta de Filtros OR para Conferência de Entrada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/receiptCheckinFiltersInput responses: 200: description: Ok schema: type: object required: – receivingTypes – docks properties: receivingTypes: type: array items: type: object allOf: – #/definitions/codeLabel minimum: 1 description: Lista de Tipos de Recebimento docks: type: array items: type: object allOf: – #/definitions/codeLabel minimum: 1 description: Lista de Docas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de Filtros OR para Conferência de Entrada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: warehouseCode description: Código do Armazém in: query type: string – name: ownerCode description: Código do Depositante in: query type: string responses: 200: description: Ok schema: type: object required: – receivingTypes – docks properties: receivingTypes: type: array items: type: object allOf: – #/definitions/codeLabel minimum: 1 description: Lista de Tipos de Recebimento docks: type: array items: type: object allOf: – #/definitions/codeLabel minimum: 1 description: Lista de Docas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/queries/receiptsForCheckin: post: description: Consulta de Ordens de Recebimento para Conferência de Entrada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/receiptsForCheckinInput responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents 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/receiptsForCheckinItem minimum: 1 description: Lista de depositantes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de Ordens de Recebimento para Conferência de Entrada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Numero da página in: query type: integer format: int64 – name: size description: Identifica a quantidade de itens a ser obtido na página in: query type: integer format: int64 – name: warehouseId description: Identificador do Armazém in: query type: string – name: ownerId description: Identificador do Depositante in: query type: string – name: document description: Número do Documento in: query type: string – name: dockId description: Código / Endereço da Doca in: query type: string – name: receivingTypeId description: Identificador do Tipo de Recebimento in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents 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/receiptsForCheckinItem minimum: 1 description: Lista de depositantes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/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 /mobile/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 /mobile/actions/checkLpnEligibility: post: description: Verificar elegibilidade da LPN para um operação do Wms tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lpnCode properties: lpnCode: type: string description: Código da LPN operationType: type: string allOf: – #/definitions/operationType description: Tipo da operação. Quando não informado valida apenas a existencia do LPN operationCode: type: string description: Código da operação. Ex: Código OR / Número Pedido responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente. 401: description: Usuário ou senha inválido. 403: description: Permissão negada 409: description: Um de erro é apresentada ao usuário indicando que a LPN não é elegivel. default: description: Error response schema: #/definitions/genericError /mobile/apis/warehouse: get: description: Armazéns do WMS tags: – APIS x-senior-visibility: PUBLIC 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/warehouseFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/apis/warehouse/{id}: get: description: Armazéns do WMS tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/warehouseFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /mobile/apis/ui/{id}: get: description: Interface com Usuário tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/uiFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: uiMode: type: string enum: – Screen – Flow description: Tipo de pessoa: * `Screen` – Tela Única * `Flow` – Fluxo de telas upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down operationType: type: string enum: – ReceivingCheckin – ReceivingAllocation – Inventory – ShipmentSeparation – ShipmentCheckout description: Tipos de Operação WMS do Coletor: * `ReceivingCheckin` – Recebimento Conferencia * `ReceivingAllocation` – Recebimento Alocação * `Inventory` – Inventário * `ShipmentSeparation` – Expedição Separação * `ShipmentCheckout` – Expedição Conferência checkType: type: string enum: – QualityInspection description: Tipos de Validação disponíveis no Coletor: * `QualityInspection` – Inspeção de Qualidade checkTaskStatus: type: string enum: – PENDING – IN_PROGRESS – COMPLETED – CANCELLED description: Situação da tarefa de checagem: * `PENDING` – Aguardando execução * `IN_PROGRESS` – Em execução por um operador * `COMPLETED` – Execução concluída * `CANCELLED` – Tarefa cancelada 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 warehouse: description: Armazem type: object required: – code – name properties: id: type: string description: Identificador único para buscar tela code: type: string description: Definição da Interface name: type: string description: Nome do Armazém wmsContextFilter: description: Filtro padrão de contexto do WMS type: object properties: warehouseId: type: string description: Identificador do Armazém ownerId: type: string description: Identificador do Depositante basicInfo: description: Informações básicas de uma entidade do domínio type: object properties: id: type: string description: Identificador único, normalmente UUID code: type: string description: Código description: type: string description: Descrição checkTask: description: Validação a ser executada pelo coletor type: object required: – id – status – items properties: id: type: string description: Identificador único, normalmente UUID status: type: string allOf: – #/definitions/checkTaskStatus description: Status da Tarefa de Checagem description: type: string description: Descrição da Tarefa username: type: string description: Usuário da tarefa warehouse: type: object allOf: – #/definitions/basicInfo description: Armazém owner: type: object allOf: – #/definitions/basicInfo description: Depositante place: type: object allOf: – #/definitions/basicInfo description: Local de armazenagem batch: type: object allOf: – #/definitions/basicInfo description: Lote product: type: object allOf: – #/definitions/basicInfo description: Produto items: type: array items: type: object allOf: – #/definitions/checkItem minimum: 1 description: Itens que devem ser validados checkItem: description: Item que deve ser validado pelo operador type: object required: – key – expectedValue properties: key: type: string description: Chave lógica do item dentro da validação expectedValue: type: string description: Valor esperado definition: description: Definição da Tela type: object properties: initial_state: type: string format: byte description: Mapa Chave Valor com estado inicial da tela state_loaders: type: array items: type: object allOf: – #/definitions/stateLoader description: Carregadores executados para carregar valores dinamicos no estado antes do primeiro step single: type: object allOf: – #/definitions/view description: Tela única steps: type: array items: type: object allOf: – #/definitions/view description: Vária tela como passos de um fluxo stateLoader: description: Carregador para buscar valores dinamicos do estado do fluxo type: object required: – endpoint – method – assignResponseTo properties: endpoint: type: string description: Endpoint que será chamado method: type: string description: Método HTTP da chamada body: type: string format: byte description: Payload enviado na chamada assignResponseTo: type: string description: Variável do estado que receberá a resposta template: description: Definição do Template da Tela type: object required: – id properties: id: type: string description: ID do template content: type: string format: byte description: Conteudo do Template view: description: Representa um tela ou parte dela no caso dos steps type: object required: – id – label – fields – include – skipIf – rules properties: id: type: string description: ID do elemento label: type: string description: Label fields: type: array items: type: string minimum: 1 description: Campos da Tela order: type: integer format: int64 description: Ordenação do fluxo (ignorado se modo = screen) include: type: string description: Referência para arquivo com template da ui skipIf: type: string description: Condição para fluxo pula um passo rules: type: array items: type: string format: byte minimum: 1 description: Regras desta visão/passo menuItem: description: Item de menu, podendo ser agrupador ou item navegável type: object required: – label – children properties: label: type: string description: Texto exibido no menu icon: type: string description: Ícone exibido no menu children: type: array items: type: object allOf: – #/definitions/menuItem minimum: 1 description: Subitens do menu path: type: object allOf: – #/definitions/menuPath description: Destino de navegação quando o item abre uma tela/widget featureFlag: type: string description: Indica alguma feature pode torna ativo o menu menuPath: description: Caminho de navegação do item de menu type: object required: – category – menuId properties: category: type: string description: Categoria do destino. Exemplo: widget menuId: type: string description: Identificador da tela/widget no mobile flowId: type: string description: Identificador do fluxo dinâmico, quando aplicável receiptCheckinFiltersInput: description: Filtros do Recebimento type: object properties: warehouseCode: type: string description: Código do Armazém ownerCode: type: string description: Código do Depositante codeLabel: description: Tipo Genérico para Retornar Code e Label type: object required: – code – label properties: code: type: string description: Código label: type: string description: Descrição receiptsForCheckinInput: description: Entrada de Dados para Consulta de OR type: object properties: offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Identifica a quantidade de itens a ser obtido na página default: 10 warehouseId: type: string description: Identificador do Armazém ownerId: type: string description: Identificador do Depositante document: type: string description: Número do Documento dockId: type: string description: Código / Endereço da Doca receivingTypeId: type: string description: Identificador do Tipo de Recebimento receiptsForCheckinItem: description: Recebimento para checkin type: object required: – id – receiptNumber – documentDescription – documents – status properties: id: type: string description: Identificador receiptNumber: type: string description: Número do Recebimento documentDescription: type: string description: Descrição dos Documentos da OR documents: type: array items: type: string minimum: 1 description: Lista de Documentos status: type: object allOf: – #/definitions/codeLabel description: Status do OR dockName: type: string description: Nome da Doca 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. 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 warehouseFacadeOutput: description: Armazéns do WMS type: object required: – code – name properties: id: type: string description: Identificador único para buscar tela code: type: string description: Definição da Interface name: type: string description: Nome do Armazém uiFacade: description: Interface com Usuário type: object required: – definition properties: id: type: string description: Identificador único para buscar tela definition: type: object allOf: – #/definitions/definition description: Definição da Interface templates: type: array items: type: object allOf: – #/definitions/template description: Template de telas 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

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação