2.0info: 1.1.2 Recebimento description: Eventos e Potnos de Extensão do WMS – Recebimento x-senior-domain: Camada de Customização do WMS x-senior-domain-path: wms_custom x-senior-service-path: receivement contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/wms_customsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /receivement/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: 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: default: description: Error response schema: #/definitions/genericError /receivement/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /receivement/actions/createReceivement: post: description: Cadastrar/Alterar Recebimento THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – armazem – depositante – doca – usuario properties: armazem: type: object allOf: #/definitions/entidade description: Armazém depositante: type: object allOf: #/definitions/entidade description: Depositante doca: type: object allOf: #/definitions/local description: Doca usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/deleteReceivement: post: description: Excluir Recebimento THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – usuario – data properties: idOr: type: integer format: int64 description: id da OR usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/linkInvoice: post: description: Vincular/Desvincular Nota Fiscal ao Recebimento THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – armazem – depositante – notasFiscais – usuario – acao properties: idOr: type: integer format: int64 description: Id da OR armazem: type: object allOf: #/definitions/entidade description: Armazém depositante: type: object allOf: #/definitions/entidade description: Depositante notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais usuario: type: object allOf: #/definitions/usuario description: Usuário acao: type: string allOf: – #/definitions/linkedAction description: Ação responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/ignoreCount: post: description: Ignorar Contagem THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – armazem – usuario – contagens properties: idOr: type: integer format: int64 description: Id da Or armazem: type: object allOf: #/definitions/entidade description: Armazém usuario: type: object allOf: #/definitions/usuario description: Usuário contagens: type: array items: type: object allOf: #/definitions/contagem minimum: 1 description: Contagens responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/releaseWithDivergence: post: description: Liberar Conferência com Divergência THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – armazem – usuario – motivo – ocorrencias properties: idOr: type: integer format: int64 description: Id da OR armazem: type: object allOf: #/definitions/entidade description: Armazém usuario: type: object allOf: #/definitions/usuario description: Usuário motivo: type: string description: Motivo ocorrencias: type: array items: type: object allOf: #/definitions/ocorrencia minimum: 1 description: Ocorrências responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/enableRecount: post: description: Habilitar Recontagem THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – armazem – usuario properties: idOr: type: integer format: int64 description: Id da OR armazem: type: object allOf: #/definitions/entidade description: Armazém usuario: type: object allOf: #/definitions/usuario description: Usuário volume: type: integer format: int64 description: Volume responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/generateBatchesAllocationMaps: post: description: Gerar Lotes e Mapa Alocação THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – armazem – depositate – usuario – notasFiscais – contagens properties: idOr: type: integer format: int64 description: Id da OR armazem: type: object allOf: #/definitions/entidade description: Armazém depositate: type: object allOf: #/definitions/entidade description: Depositante usuario: type: object allOf: #/definitions/usuario description: Usuário notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais contagens: type: array items: type: object allOf: #/definitions/contagem minimum: 1 description: Contagens responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/reverseAllocation: post: description: Estornar Recebimento THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – usuario – data properties: idOr: type: integer format: int64 description: id da OR usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/deleteBatches: post: description: Excluir Lotes da Recebimento THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – usuario – data properties: idOr: type: integer format: int64 description: id da OR usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/backlistCorrection: post: description: Correção do Backlist THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – usuario – acao – backlists properties: idOr: type: integer format: int64 description: id da OR usuario: type: object allOf: #/definitions/usuario description: Usuário acao: type: string allOf: – #/definitions/correctionAction description: Ação backlists: type: array items: type: object allOf: #/definitions/backlist minimum: 1 description: Lista de Backlist responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /receivement/actions/restoreBacklistBackup: post: description: Restaurar Backup do Backlist THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOr – usuario – backlists properties: idOr: type: integer format: int64 description: id da OR usuario: type: object allOf: #/definitions/usuario description: Usuário backlists: type: array items: type: object allOf: #/definitions/backlist minimum: 1 description: Lista de Backlist responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError definitions: linkedAction: description: Ação ao vincular Nota Fiscal type: string enum: – Linked – Unlinked batchState: description: Estado do Lote type: string enum: – Normal – Danificado – Vencido correctionAction: description: Ação da Correção do BackList type: string enum: – Start – Finish 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 entidade: description: Entidade type: object required: – cnpj properties: cnpj: type: string description: CNPJ ie: type: string description: Inscrição Estadual local: description: Local type: object required: – idArmazem – idLocal properties: idArmazem: type: integer format: int64 description: Id Armazém idLocal: type: string description: Id Local setor: type: object allOf: #/definitions/setor description: Setor regiao: type: object allOf: #/definitions/regiao description: Região usuario: description: Usuário type: object required: – nomeUsuario properties: nomeUsuario: type: string description: Nome Usuário loginSeniorX: type: string description: Login SeniorX notaFiscal: description: Nota Fiscal type: object required: – numero properties: numero: type: integer format: int64 description: Número da Nota Fiscal serie: type: string description: Série da Nota Fiscal numPedido: type: string description: Número do Pedido do Fornecedor produto: description: Produto type: object required: – idProduto – codProduto – descricao properties: idProduto: type: integer format: int64 description: Id do Produto codProduto: type: string description: Código do Produto descricao: type: string description: Descrição embalagem: description: Embalagem type: object required: – barra – descrReduzida – fator properties: barra: type: string description: Barra descrReduzida: type: string description: Descrição Reduzida fator: type: integer format: int64 description: Fator de Conversão lote: description: Lote type: object required: – idLote – produto – embalagem – estado – qtde – depositante properties: idLote: type: integer format: int64 description: Id do Lote produto: type: object allOf: #/definitions/produto description: Produto loteIndustria: type: string description: Lote Indústria embalagem: type: object allOf: #/definitions/embalagem description: Embalagem dtFabricacao: type: string format: date-time description: Data de Fabricação dtVencimento: type: string format: date-time description: Data de Vencimento estado: type: string allOf: – #/definitions/batchState description: Estado do Lote qtde: type: integer format: int64 description: Quantidade depositante: type: object allOf: #/definitions/entidade description: Depositante notaFiscal: type: array items: type: object allOf: #/definitions/notaFiscal description: Nota Fiscal setor: description: Setor type: object required: – idSetor – descricao properties: idSetor: type: integer format: int64 description: Id do Setor descricao: type: string description: Descrição regiao: description: Região type: object required: – idRegiao – descricao properties: idRegiao: type: integer format: int64 description: Id da Região descricao: type: string description: Descrição mapaAlocacao: description: Mapa Alocação type: object required: – idAlocacao – local – lote properties: idAlocacao: type: integer format: int64 description: Id da Alocação local: type: object allOf: #/definitions/local description: Local lote: type: object allOf: #/definitions/lote description: Lote ocorrencia: description: Ocorrência type: object required: – produto – embalagem – status – descricao properties: produto: type: object allOf: #/definitions/produto description: Produto embalagem: type: object allOf: #/definitions/embalagem description: Embalagem status: type: string description: Status descricao: type: string description: Descrição contagem: description: Contagem type: object required: – produto – embalagem – qtde – estado properties: produto: type: object allOf: #/definitions/produto description: Produto embalagem: type: object allOf: #/definitions/embalagem description: Embalagem qtde: type: integer format: int64 description: Quantidade loteIndustria: type: string description: Lote Indústria dtFabricacao: type: string format: date-time description: Data de Fabricação dtVencimento: type: string format: date-time description: Data de Vencimento estado: type: string allOf: – #/definitions/batchState description: Estado do Lote volume: type: integer format: int64 description: Volume barraContentor: type: string description: Barra Contentor backlist: description: Backlist type: object required: – notaFiscal – produto – embalagem – loteIndustria – qtde properties: notaFiscal: type: object allOf: #/definitions/notaFiscal description: Nota Fiscal produto: type: object allOf: #/definitions/produto description: Produto embalagem: type: object allOf: #/definitions/embalagem description: Embalagem loteIndustria: type: string description: Lote Indústria qtde: type: integer format: int64 description: Quantidade dtFabricacao: type: string format: date-time description: Data de Fabricação dtVencimento: type: string format: date-time description: Data de Vencimento 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 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