flexyfeeddatabase

2.0info: 2.0.15 flexyfeeddatabase description: Marketplace | Backend do Serviço de integração com a Flexy x-senior-domain: marketplace x-senior-domain-path: marketplace x-senior-service-path: flexyfeeddatabase 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/marketplacesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /flexyfeeddatabase/queries/getProduct: post: description: Consulta da entidade Produto paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: referenceCode: type: string description: Código de Referência do Produto containsInTheName: type: string description: Contém no Nome orderByName: type: boolean description: Ordenar por Nome default: false fromCreatedAt: type: string description: Data de Criação (de) yyyy-mm-dd default: 2018-01-01 toCreatedAt: type: string description: Data de Criação (até) yyyy-mm-dd fromUpdatedAt: type: string description: Data de Atualização (de) yyyy-mm-dd default: 2018-01-01 toUpdatedAt: type: string description: Data de Atualização (até) yyyy-mm-dd limit: type: integer format: int64 description: Limite de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: product: type: array items: type: object allOf: – #/definitions/products description: Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Produto paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceCode description: Código de Referência do Produto in: query type: string – name: containsInTheName description: Contém no Nome in: query type: string – name: orderByName description: Ordenar por Nome in: query type: boolean – name: fromCreatedAt description: Data de Criação (de) yyyy-mm-dd in: query type: string – name: toCreatedAt description: Data de Criação (até) yyyy-mm-dd in: query type: string – name: fromUpdatedAt description: Data de Atualização (de) yyyy-mm-dd in: query type: string – name: toUpdatedAt description: Data de Atualização (até) yyyy-mm-dd in: query type: string – name: limit description: Limite de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: product: type: array items: type: object allOf: – #/definitions/products description: Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getOrder: post: description: Consulta da entidade Pedido de Vendas paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: number: type: string description: Código de Referência do Pedido fromCreatedAt: type: string description: Data de Criação (de) yyyy-mm-dd default: 2018-01-01 toCreatedAt: type: string description: Data de Criação (até) yyyy-mm-dd fromUpdatedAt: type: string description: Data de Atualização (de) yyyy-mm-dd default: 2018-01-01 toUpdatedAt: type: string description: Data de Atualização (até) yyyy-mm-dd limit: type: integer format: int64 description: Limite de dados para paginação offset: type: integer format: int64 description: Número da página customer: type: string description: Código do Cliente store: type: string description: Código da Loja responses: 200: description: Ok schema: type: object properties: orders: type: array items: type: object allOf: – #/definitions/orders description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Pedido de Vendas paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: number description: Código de Referência do Pedido in: query type: string – name: fromCreatedAt description: Data de Criação (de) yyyy-mm-dd in: query type: string – name: toCreatedAt description: Data de Criação (até) yyyy-mm-dd in: query type: string – name: fromUpdatedAt description: Data de Atualização (de) yyyy-mm-dd in: query type: string – name: toUpdatedAt description: Data de Atualização (até) yyyy-mm-dd in: query type: string – name: limit description: Limite de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 – name: customer description: Código do Cliente in: query type: string – name: store description: Código da Loja in: query type: string responses: 200: description: Ok schema: type: object properties: orders: type: array items: type: object allOf: – #/definitions/orders description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getItemsOrder: post: description: Consulta da entidade Itens do Pedido de Vendas paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: referenceCode: type: string description: Código de Referência do Item do Pedido containsInTheName: type: string description: Contém no Nome orderByName: type: boolean description: Ordenar por Nome default: false limit: type: integer format: int64 description: Limite de dados para paginação offset: type: integer format: int64 description: Número da página order: type: string description: Código do Pedido de Vendas variant: type: string description: Código da Variante productReferenceCode: type: string description: Código do Produto responses: 200: description: Ok schema: type: object properties: itemOrders: type: array items: type: object allOf: – #/definitions/itemsOrders description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Itens do Pedido de Vendas paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceCode description: Código de Referência do Item do Pedido in: query type: string – name: containsInTheName description: Contém no Nome in: query type: string – name: orderByName description: Ordenar por Nome in: query type: boolean – name: limit description: Limite de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 – name: order description: Código do Pedido de Vendas in: query type: string – name: variant description: Código da Variante in: query type: string – name: productReferenceCode description: Código do Produto in: query type: string responses: 200: description: Ok schema: type: object properties: itemOrders: type: array items: type: object allOf: – #/definitions/itemsOrders description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getClient: post: description: Consulta da entidade Clientes paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: identityNumber: type: string description: Código Único (Id) do Cliente, sendo este o CPF ou CNPJ containsInTheEmail: type: string description: Contém no Email containsInTheName: type: string description: Contém no Nome (companyName, tradeName, responsible, firstName ou lastName) orderByName: type: boolean description: Ordenar por Nome default: false fromCreatedAt: type: string description: Data de Criação (de) yyyy-mm-dd default: 2018-01-01 toCreatedAt: type: string description: Data de Criação (até) yyyy-mm-dd fromUpdatedAt: type: string description: Data de Atualização (de) yyyy-mm-dd default: 2018-01-01 toUpdatedAt: type: string description: Data de Atualização (até) yyyy-mm-dd limit: type: integer format: int64 description: Limite de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: client: type: array items: type: object allOf: – #/definitions/clients description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Clientes paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: identityNumber description: Código Único (Id) do Cliente, sendo este o CPF ou CNPJ in: query type: string – name: containsInTheEmail description: Contém no Email in: query type: string – name: containsInTheName description: Contém no Nome (companyName, tradeName, responsible, firstName ou lastName) in: query type: string – name: orderByName description: Ordenar por Nome in: query type: boolean – name: fromCreatedAt description: Data de Criação (de) yyyy-mm-dd in: query type: string – name: toCreatedAt description: Data de Criação (até) yyyy-mm-dd in: query type: string – name: fromUpdatedAt description: Data de Atualização (de) yyyy-mm-dd in: query type: string – name: toUpdatedAt description: Data de Atualização (até) yyyy-mm-dd in: query type: string – name: limit description: Limite de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: client: type: array items: type: object allOf: – #/definitions/clients description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getStore: post: description: Consulta da entidade Loja paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: referenceCode: type: string description: Código de Referência da Store containsInTheEmail: type: string description: Contém no Email containsInTheName: type: string description: Contém no Nome orderByName: type: boolean description: Ordenar por Nome default: false fromCreatedAt: type: string description: Data de Criação (de) yyyy-mm-dd default: 2018-01-01 toCreatedAt: type: string description: Data de Criação (até) yyyy-mm-dd fromUpdatedAt: type: string description: Data de Atualização (de) yyyy-mm-dd default: 2018-01-01 toUpdatedAt: type: string description: Data de Atualização (até) yyyy-mm-dd limit: type: integer format: int64 description: Limite de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: store: type: array items: type: object allOf: – #/definitions/stores description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Loja paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceCode description: Código de Referência da Store in: query type: string – name: containsInTheEmail description: Contém no Email in: query type: string – name: containsInTheName description: Contém no Nome in: query type: string – name: orderByName description: Ordenar por Nome in: query type: boolean – name: fromCreatedAt description: Data de Criação (de) yyyy-mm-dd in: query type: string – name: toCreatedAt description: Data de Criação (até) yyyy-mm-dd in: query type: string – name: fromUpdatedAt description: Data de Atualização (de) yyyy-mm-dd in: query type: string – name: toUpdatedAt description: Data de Atualização (até) yyyy-mm-dd in: query type: string – name: limit description: Limite de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: store: type: array items: type: object allOf: – #/definitions/stores description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getAgent: post: description: Consulta de Representantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: token: type: string description: Código de Referência do Representante containsInTheEmail: type: string description: Contém no Email containsInTheName: type: string description: Contém no Nome orderByName: type: boolean description: Ordenar por Nome default: false fromCreatedAt: type: string description: Data de Criação (de) yyyy-mm-dd default: 2018-01-01 toCreatedAt: type: string description: Data de Criação (até) yyyy-mm-dd fromUpdatedAt: type: string description: Data de Atualização (de) yyyy-mm-dd default: 2018-01-01 toUpdatedAt: type: string description: Data de Atualização (até) yyyy-mm-dd limit: type: integer format: int64 description: Limit de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: agent: type: array items: type: object allOf: – #/definitions/agents description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de Representantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: token description: Código de Referência do Representante in: query type: string – name: containsInTheEmail description: Contém no Email in: query type: string – name: containsInTheName description: Contém no Nome in: query type: string – name: orderByName description: Ordenar por Nome in: query type: boolean – name: fromCreatedAt description: Data de Criação (de) yyyy-mm-dd in: query type: string – name: toCreatedAt description: Data de Criação (até) yyyy-mm-dd in: query type: string – name: fromUpdatedAt description: Data de Atualização (de) yyyy-mm-dd in: query type: string – name: toUpdatedAt description: Data de Atualização (até) yyyy-mm-dd in: query type: string – name: limit description: Limit de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: agent: type: array items: type: object allOf: – #/definitions/agents description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getAgentsOrder: post: description: Consulta de Representantes do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codereference: type: string description: Código de Referência do Representante _date: type: string description: Data do filtro yyyy-mm-dd limit: type: integer format: int64 description: Limit de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: agentOrder: type: array items: type: object allOf: – #/definitions/agentsOrders description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de Representantes do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codereference description: Código de Referência do Representante in: query type: string – name: _date description: Data do filtro yyyy-mm-dd in: query type: string – name: limit description: Limit de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: agentOrder: type: array items: type: object allOf: – #/definitions/agentsOrders description: Lista da Entidade Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getGroupedTable: post: description: Consulta de tabelas agrupadas – paginaÇão obrigatória devido ao quantidade de registros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: _date: type: string description: Data do filtro yyyy-mm-dd limit: type: integer format: int64 description: Limit de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: groupedTables: type: array items: type: object allOf: – #/definitions/groupedTables description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de tabelas agrupadas – paginaÇão obrigatória devido ao quantidade de registros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: _date description: Data do filtro yyyy-mm-dd in: query type: string – name: limit description: Limit de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: groupedTables: type: array items: type: object allOf: – #/definitions/groupedTables description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getProviderUser: post: description: Consulta de usuários dos providers tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: referenceCode: type: integer format: int64 description: Código do usuário do provider email: type: string description: Contém no Email name: type: string description: Contém no Nome orderByName: type: boolean description: Ordenar por Nome default: false fromCreatedAt: type: string description: Data de Criação (de) yyyy-mm-dd default: 2018-01-01 toCreatedAt: type: string description: Data de Criação (até) yyyy-mm-dd fromUpdatedAt: type: string description: Data de Atualização (de) yyyy-mm-dd default: 2018-01-01 toUpdatedAt: type: string description: Data de Atualização (até) yyyy-mm-dd limit: type: integer format: int64 description: Limit de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: providerUser: type: array items: type: object allOf: – #/definitions/providerUser description: Retorna lista de usuários dos providers totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de usuários dos providers tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceCode description: Código do usuário do provider in: query type: integer format: int64 – name: email description: Contém no Email in: query type: string – name: name description: Contém no Nome in: query type: string – name: orderByName description: Ordenar por Nome in: query type: boolean – name: fromCreatedAt description: Data de Criação (de) yyyy-mm-dd in: query type: string – name: toCreatedAt description: Data de Criação (até) yyyy-mm-dd in: query type: string – name: fromUpdatedAt description: Data de Atualização (de) yyyy-mm-dd in: query type: string – name: toUpdatedAt description: Data de Atualização (até) yyyy-mm-dd in: query type: string – name: limit description: Limit de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: providerUser: type: array items: type: object allOf: – #/definitions/providerUser description: Retorna lista de usuários dos providers totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getInvoice: post: description: Consulta de Fatura Enviadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: invoiceCode: type: string description: Código da Fatura order: type: string description: código do Pedido de Vendas fromCreatedAt: type: string description: Data de Criação (de) yyyy-mm-dd default: 2018-01-01 toCreatedAt: type: string description: Data de Criação (até) yyyy-mm-dd fromUpdatedAt: type: string description: Data de Atualização (de) yyyy-mm-dd default: 2018-01-01 toUpdatedAt: type: string description: Data de Atualização (até) yyyy-mm-dd limit: type: integer format: int64 description: Limit de dados para paginação offset: type: integer format: int64 description: Número da página responses: 200: description: Ok schema: type: object properties: invoices: type: array items: type: object allOf: – #/definitions/invoice description: Lista da Entidade Fatura Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de Fatura Enviadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: invoiceCode description: Código da Fatura in: query type: string – name: order description: código do Pedido de Vendas in: query type: string – name: fromCreatedAt description: Data de Criação (de) yyyy-mm-dd in: query type: string – name: toCreatedAt description: Data de Criação (até) yyyy-mm-dd in: query type: string – name: fromUpdatedAt description: Data de Atualização (de) yyyy-mm-dd in: query type: string – name: toUpdatedAt description: Data de Atualização (até) yyyy-mm-dd in: query type: string – name: limit description: Limit de dados para paginação in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: invoices: type: array items: type: object allOf: – #/definitions/invoice description: Lista da Entidade Fatura Retornada totalRecordsReturned: type: integer format: int64 description: Total de registros retornados. totalRecordsFound: type: integer format: int64 description: Total de registros encontrados. _error: type: string description: Erro encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/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 /flexyfeeddatabase/queries/exportSettingsParametersForUpdate: 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 /flexyfeeddatabase/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 /flexyfeeddatabase/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 /flexyfeeddatabase/actions/updateProviderUser: post: description: Alteração de usuário provider tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – referenceCode properties: referenceCode: type: integer format: int64 description: Código do usuário do provider name: type: string description: Nome telephone: type: string description: Telefone emails: type: string description: Emails store: type: string description: Loja active: type: boolean description: Ativo? default: true responses: 200: description: Ok schema: type: object required: – providerUser properties: providerUser: type: object allOf: – #/definitions/providerUser description: Retorna objeto usuários provider 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/actions/writeExportedDataIdentifiers: post: description: Gravar identificadores de dados exportados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id – idExport properties: entityName: type: string allOf: – #/definitions/entityNameEnum description: Entidade id: type: string description: Identificador local idExport: type: string description: Identificador exportado items: type: array items: type: string description: Itens errorOccurred: type: string description: Erro ocorrido responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso ou insucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/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 /flexyfeeddatabase/actions/importSettingsParametersForUpdate: 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 /flexyfeeddatabase/signals/runDataExport: post: description: Execute a exportação | Envia dados para serviço backoffice tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – selectEntities properties: limit: type: integer format: int64 description: Limite default: 3 offset: type: integer format: int64 description: Deslocamento default: 0 updateAll: type: boolean description: Alterar todos dos registros da(s) entidade(s) selecionada(s) default: false selectEntities: type: object allOf: – #/definitions/selectEntities description: Selecionar entidades a executar responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/signals/runDataImport: post: description: Executar importação de dados Flexy tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – environment properties: environment: type: object allOf: – #/definitions/environments description: Ambiente que deseja executar allEntities: type: boolean description: Executar todas as entidades ignorando o atributo selectEntities default: false selectEntities: type: object allOf: – #/definitions/selectEntities description: Selecionar entidades a executar recoveryMode: type: boolean description: Modo de recuperação | Verifica se há atualização não finalizada default: true responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/events/importSettingsParametersForUpdateEvent: 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 /flexyfeeddatabase/events/exportSettingsParametersForUpdateEvent: 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 /flexyfeeddatabase/entities/settingsParametersForUpdate: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/settingsParametersForUpdate responses: 200: description: The created resource schema: #/definitions/settingsParametersForUpdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/settingsParametersForUpdate responses: 200: description: The created resource schema: #/definitions/settingsParametersForUpdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/settingsParametersForUpdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/entities/settingsParametersForUpdate/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/settingsParametersForUpdate responses: 200: description: Ok schema: #/definitions/settingsParametersForUpdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/settingsParametersForUpdate responses: 200: description: Ok schema: #/definitions/settingsParametersForUpdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/settingsParametersForUpdate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /flexyfeeddatabase/entities/settingsParametersForUpdate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/settingsParametersForUpdate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: entityNameEnum: description: Entidades type: string enum: – PRODUCT – ORDER – CATEGORY – CUSTOMER – STORE – PRICE_TABLE 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 selectEntities: description: Objeto de parâmetros entidades a importar e exportar type: object properties: address: type: boolean description: Entidade Endereço default: false client: type: boolean description: Entidade Cliente default: false properties: type: boolean description: Entidade propriedade de produtos default: false variants: type: boolean description: Entidade Variações de produtos default: false categories: type: boolean description: Entidade Categorias de produtos default: false product: type: boolean description: Entidade Produto default: false store: type: boolean description: Entidade Loja default: false agents: type: boolean description: Entidade Representante default: false orders: type: boolean description: Entidade pedidos de Vendas default: false itemsOrders: type: boolean description: Entidade item do pedido de Venda default: false providerUser: type: boolean description: Entidade usuário do lojista default: false priceTable: type: boolean description: Entidade tabela de preço default: false _error: type: string description: (Somente no retorno) Erro no critério de parâmetro enviado environments: description: Objeto de Parâmetros do Ambiente type: object required: – token properties: environment: type: string description: Ambiente fonte dos dados, sobrepõe os demais podendo ser: SHP(SHOPPING), STR(STORE) ou HML(HOMOLOG_SHOPPING) url: type: string description: Url do ambiente token: type: string description: Código token do ambiente ou loja codeStore: type: string description: Código store da loja products: description: Objeto Produto type: object required: – referenceCode – name – url – shoppingStore – slug – stockControl – availableFor – createdAt – updatedAt – productType – nameCategories – nameCategories2 – nameCategories3 properties: referenceCode: type: string description: Código de Referência name: type: string description: Nome url: type: string description: URL shoppingStore: type: string description: Loja do Shopping slug: type: string description: Slug stockControl: type: boolean description: Controle de Estoque availableFor: type: string description: Disponível para (todos/vendas) createdAt: type: string format: date description: Data de Criação updatedAt: type: string format: date description: Date de Alteração productType: type: string description: Tipo do Produto nameCategories: type: string description: Categoria do Produto 1 nameCategories2: type: string description: Categoria do Produto 2 nameCategories3: type: string description: Categoria do Produto 3 orders: description: Objeto Pedido de Vendas type: object required: – number – total – totalReal – promotionDiscount – createdAt – updatedAt – customer – shoppingStore – originPage – dbUpdate – status properties: number: type: string description: Número do Pedido total: type: string description: Total Flexy totalReal: type: string description: Total Real promotionDiscount: type: string description: Desconto Concedido createdAt: type: string format: date description: Data de Criação updatedAt: type: string format: date description: Date de Alteração customer: type: string description: Código do Cliente shoppingStore: type: string description: Código do Provedor originPage: type: string description: Página de Origem dbUpdate: type: string format: date description: Data de Atualização do Banco de Dados status: type: string description: Status do Pedido paymentMethods: type: array items: type: object allOf: – #/definitions/paymentMethods description: Lista de Objeto Método de Pagamento paymentMethods: description: Objeto Método de Pagamento type: object required: – paymentRule – installments – paymentMethodAmount properties: paymentRule: type: string description: Forma de Pagamento installments: type: string description: Número de Parcelas paymentMethodAmount: type: string description: Valor da Forma de Pagamento clients: description: Objeto Cliente type: object required: – identityNumber – companyName – tradeName – stateRegistration – responsible – firstName – lastName – dateOfBirth – primaryPhone – secondPhone – email – createdAt – updatedAt – address properties: identityNumber: type: string description: Número do Cliente companyName: type: string description: Razão Social tradeName: type: string description: Nome da Fantasia stateRegistration: type: string description: Registro Estadual responsible: type: string description: Responsável firstName: type: string description: Nome da Pessoa lastName: type: string description: Apelido dateOfBirth: type: string format: date description: Data de Nascimento primaryPhone: type: string description: Contato Primário secondPhone: type: string description: Contato secundário email: type: string description: Email createdAt: type: string format: date description: Data de Criação updatedAt: type: string format: date description: Date de Alteração address: type: object allOf: – #/definitions/address description: Endereço stores: description: Objeto Loja type: object required: – referenceCode – companyName – name – tradeName – cnpj – stateRegistration – email – codeStore – tokenStore – originPage – isEnabled – isActivated – responsibleName – userEmail – _group – logoUrl – fiveconUrl – primaryPhone – _domain – createdAt – updatedAt – address properties: referenceCode: type: string description: Código da Loja companyName: type: string description: Nome da Companhia name: type: string description: Nome Fantasia tradeName: type: string description: Nome Comercial cnpj: type: string description: CNPJ stateRegistration: type: string description: Registro Estadual email: type: string description: Email codeStore: type: string description: Código Store tokenStore: type: string description: Token Store originPage: type: string description: Página de Origem isEnabled: type: boolean description: Está Habilitado? isActivated: type: boolean description: Está Ativo? responsibleName: type: string description: Nome do Responsável userEmail: type: string description: Email Usuário _group: type: string description: Grupo logoUrl: type: string description: URL do Logo fiveconUrl: type: string description: URL do Logo primaryPhone: type: string description: Contato Principal _domain: type: string description: Domínio createdAt: type: string format: date description: Data de Criação updatedAt: type: string format: date description: Date de Alteração address: type: object allOf: – #/definitions/address description: Endereço agents: description: Objeto Representante type: object required: – token – name – email – phone – createdAt – updatedAt – commissionPercentage properties: token: type: string description: Código do Agente name: type: string description: Nome email: type: string description: Email phone: type: string description: Contato createdAt: type: string format: date description: Data de Criação updatedAt: type: string format: date description: Date de Alteração commissionPercentage: type: string description: Percentual de Comissão agentsOrders: description: Objeto Representante do Pedido de Vendas type: object required: – codereference – name – _order properties: codereference: type: string description: Código do Agente name: type: string description: Nome do Agente _order: type: string description: Número do Pedido de Vendas itemsOrders: description: Objeto Item do Pedido de Vendas type: object required: – referenceCode – name – quantity – unitPrice – totalPrice – valorUnitarioReal – promotionDiscount – additionalTo – orders – variant – productReferenceCode – categories2 – categories3 properties: referenceCode: type: string description: Código do Item do Pedido de Vendas name: type: string description: Nome do Produto Variante quantity: type: integer format: int64 description: Quantidade Vendida unitPrice: type: string description: Valor Unitário – Flexy totalPrice: type: string description: Valor Total – Flexy valorUnitarioReal: type: string description: Valor Unitário Real promotionDiscount: type: string description: Valor de descontos promocionais additionalTo: type: string description: Valor Adicional orders: type: string description: Código do Pedido de Vendas variant: type: string description: Código da Variação productReferenceCode: type: string description: Código do produto categories2: type: string description: Categoria do produto categories3: type: string description: Categoria do produto groupedTables: description: Objeto Tabelas Agrupadas (Pedido de Vendas + Item do Pedido de Vendas) type: object required: – referenceCode – name – quantity – valorUnitarioReal – promotionDiscount – orders – productReferenceCode – categories2 – categories3 – createdat – customer – shoppingstore properties: referenceCode: type: string description: Código do Item do Pedido de Vendas name: type: string description: Nome do Produto Variante quantity: type: integer format: int64 description: Quantidade Vendida valorUnitarioReal: type: string description: Valor Unitário Real promotionDiscount: type: string description: Valor de descontos promocionais orders: type: string description: Código do Pedido de Vendas productReferenceCode: type: string description: Código do produto categories2: type: string description: Categoria do produto categories3: type: string description: Categoria do produto createdat: type: string format: date description: Data de Criação customer: type: string description: Código do Cliente shoppingstore: type: string description: Código do Provedor providerUser: description: Objeto Usuário do Provider type: object required: – createdAt – updatedAt – originPage properties: referenceCode: type: integer format: int64 description: Código do usuário do provider name: type: string description: Nome telephone: type: string description: Telefone emails: type: string description: Emails store: type: string description: Loja createdAt: type: string format: date description: Data de Criação updatedAt: type: string format: date description: Date de Alteração originPage: type: string description: Página de Origem active: type: boolean description: Ativo? invoice: description: Objeto Fatura type: object required: – invoiceCode – order – invoiceAmount – url – createdAt – updatedAt properties: invoiceCode: type: string description: Código da Fatura order: type: string description: Código do Pedido de Vendas invoiceAmount: type: string description: Valor da Fatura url: type: string description: URL Gerada createdAt: type: string format: date description: Data de Criação updatedAt: type: string format: date description: Date de Alteração address: description: Objeto Endereço type: object required: – codeReference – postcode – city – state – country – street – district – complement – number properties: codeReference: type: string description: Código de referência postcode: type: string description: CEP city: type: string description: Cidade state: type: string description: Estado (Sigla) country: type: string description: País street: type: string description: Logadouro district: type: string description: Bairro complement: type: string description: Complemento number: type: string description: Número settingsParametersForUpdate: description: Parâmetros de configurações para atualização type: object required: – environment – entity properties: id: type: string format: uuid description: Identificação environment: type: string description: Ambiente entity: type: string description: Entidade success: type: boolean description: Sucesso default: false offset: type: integer format: int64 description: Deslocar createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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