integration

2.0info: 1.6.0 integration description: Integração com o ERPX – WMS br strong ATENÇÃO: /strong Este serviço está em fase de validação com o piloto e pode sofrer alterações. x-senior-domain: ERPX – WMS x-senior-domain-path: erpx_wms x-senior-service-path: integration 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/erpx_wmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /integration/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 – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 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 – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/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 /integration/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/resetSchema: post: description: Realiza a limpeza da base de dados, mantendo somente os dados padrões (conforme carga inicial) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/events/orderReceiptPendingConference: post: description: Evento que indica a pendência de conferência de uma ordem de recebimento br strong ATENÇÃO: /strong Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – branch – document – items properties: externalId: type: string description: ID da ordem de recebimento branch: type: object allOf: – #/definitions/branch description: Filial document: type: object allOf: – #/definitions/document description: Documento items: type: array items: type: object allOf: – #/definitions/item minimum: 1 description: Itens responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/orderReceiptConferenceSuccess: post: description: Evento que indica a conclusão da conferência de uma ordem de recebimento. br strong ATENÇÃO: /strong Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – externalId properties: ticket: type: string description: Ticket retornado pela api de conferencia externalId: type: string description: ID da ordem de recebimento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/orderReceiptConferenceError: post: description: Evento que indica erro na conferência de uma ordem de recebimento. br strong ATENÇÃO: /strong Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – externalId – errorMessage properties: ticket: type: string description: Ticket retornado pela api de conferencia externalId: type: string description: id da ordem de recebimento errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/orderReceiptCanceled: post: description: Evento que indica o cancelamento da ordem de recebimento. br strong ATENÇÃO: /strong Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentId properties: externalId: type: string description: Id da ordem de recebimento documentId: type: string description: Id do documento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/apis/returnOrderReceiptConference: post: description: Retorno da conferência de recebimento de ordem br strong ATENÇÃO: /strong Esta API está em fase de validação com o piloto e pode sofrer alterações. tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/returnOrderReceiptConferenceFacadeInput responses: 200: description: Ok schema: #/definitions/returnOrderReceiptConferenceFacadeOutput 400: description: Requisição inválida, parâmetros obrigatórios não fornecidos ou campo informado incorretamente 401: description: Usuário não autenticado 403: description: Usuário sem permissão 404: description: Registro não encontrado pelo ID ERPX ou código de negócio fornecido default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down condition: type: string enum: – GOOD – DAMAGED description: Condição: * `GOOD` – Bom * `DAMAGED` – Avariado documentType: type: string enum: – INCOMING_INVOICE – PRODUCTION_ORDER description: Tipo de documento: * `INCOMING_INVOICE` – Nota Fiscal de Entrada * `PRODUCTION_ORDER` – Ordem de Produção 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 checkData: description: healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck branch: description: Filial type: object required: – documentNumber – name properties: documentNumber: type: string description: Número (CPF, CNPJ ou NIF) name: type: string description: Nome tradeName: type: string description: Nome fantasia stateRegistration: type: string description: Inscrição estadual zipCode: type: string description: CEP address: type: string description: Logradouro addressNumber: type: string description: Número do endereço addressComplement: type: string description: Complemento do endereço neighborhood: type: string description: Bairro city: type: string description: Cidade state: type: string description: UF document: description: Documento type: object required: – type properties: type: type: string allOf: – #/definitions/documentType description: Tipo number: type: string description: Número documento dateDocument: type: string format: date description: Data do documento invoice: type: object allOf: – #/definitions/invoice description: Nota de entrada productionOrder: type: object allOf: – #/definitions/productionOrder description: Ordem de produção invoice: description: Nota de entrada type: object required: – accessKey – series – noteType – supplier properties: accessKey: type: string description: Chave de acesso series: type: string description: Série noteType: type: string description: Tipo (Compra, Devolucao, Importacao) supplier: type: object allOf: – #/definitions/supplier description: Fornecedor supplier: description: Fornecedor type: object required: – documentNumber – name – tradeName properties: documentNumber: type: string description: Número (CPF, CNPJ ou NIF) name: type: string description: Nome tradeName: type: string description: Nome fantasia stateRegistration: type: string description: Inscrição estadual productionOrder: description: Ordem de produção type: object required: – labelType properties: labelType: type: string description: Tipo de etiqueta (Refugo, SubProduto, Produto, etc) item: description: Itens da ordem de recebimento type: object required: – externalItemId – product – warehouse – unitOfMeasure – expectedQuantity properties: externalItemId: type: string description: ID da integração product: type: object allOf: – #/definitions/product description: Produto warehouse: type: object allOf: – #/definitions/warehouse description: Depósito cfop: type: object allOf: – #/definitions/cfop description: CFOP unitOfMeasure: type: object allOf: – #/definitions/unitOfMeasure description: Unidade de medida expectedQuantity: type: string description: Quantidade esperada unitPrice: type: string description: Preço unitário barcode: type: string description: Código de barras freeBarcode: type: string description: Código de barras livre gtin: type: string description: GTIN do produto batches: type: array items: type: object allOf: – #/definitions/batch description: Lotes series: type: array items: type: object allOf: – #/definitions/series description: Séries product: description: Produto type: object required: – code – description properties: code: type: string description: Código do produto description: type: string description: Descrição do produto warehouse: description: Depósito type: object required: – code – description properties: code: type: string description: Código do depósito description: type: string description: Descrição do depósito cfop: description: CFOP type: object required: – code – description properties: code: type: string description: Código do CFOP description: type: string description: Descrição do CFOP unitOfMeasure: description: Unidade de medida type: object required: – code – description properties: code: type: string description: Código description: type: string description: Descrição batch: description: Lote type: object required: – code – quantity properties: code: type: string description: Código quantity: type: string description: Quantidade manufactureDate: type: string format: date description: Data de fabricação expirationDate: type: string format: date description: Data de validade series: description: Série type: object required: – code properties: code: type: string description: Código manufactureDate: type: string format: date description: Data de fabricação expirationDate: type: string format: date description: Data de validade itemOrderReceipt: description: Item da ordem de recebimento type: object required: – externalItemId properties: externalItemId: type: string description: Identificador externo product: type: object allOf: – #/definitions/product description: Produto warehouse: type: object allOf: – #/definitions/warehouse description: Depósito quantities: type: array items: type: object allOf: – #/definitions/quantity description: Quantidades quantity: description: Detalhes da quantidade type: object required: – condition – quantity properties: condition: type: string allOf: – #/definitions/condition description: Condição recebida quantity: type: string description: Quantidade recebida observation: type: string description: Observação batches: type: array items: type: object allOf: – #/definitions/batch description: Lotes recebidos series: type: array items: type: object allOf: – #/definitions/series description: Séries recebidas 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 returnOrderReceiptConferenceFacadeInput: description: Retorno da conferência de recebimento de ordem br strong ATENÇÃO: /strong Esta API está em fase de validação com o piloto e pode sofrer alterações. type: object required: – externalId – document – items properties: externalId: type: string description: ID da ordem de recebimento document: type: object allOf: – #/definitions/document description: Documento items: type: array items: type: object allOf: – #/definitions/itemOrderReceipt minimum: 1 description: Itens conferidos na ordem de recebimento returnOrderReceiptConferenceFacadeOutput: description: Retorno da conferência de recebimento de ordem br strong ATENÇÃO: /strong Esta API está em fase de validação com o piloto e pode sofrer alterações. type: object required: – ticket properties: ticket: type: string description: Ticket para recebimento do retorno via evento 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