flexyfeeddatabase

2.0info: 1.0.0 flexyfeeddatabase 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 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset properties: referenceCode: type: string description: Código de Referência do Produto _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: product: type: array items: type: object allOf: – #/definitions/products description: Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Produto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceCode description: Código de Referência do Produto 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 required: true type: integer format: int64 – name: offset description: Número da página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: product: type: array items: type: object allOf: – #/definitions/products description: Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getOrder: post: description: Consulta da entidade Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset properties: number: type: string description: Código de Referência do Pedido _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: orders: type: array items: type: object allOf: – #/definitions/orders description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: number description: Código de Referência do Pedido 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 required: true type: integer format: int64 – name: offset description: Número da página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: orders: type: array items: type: object allOf: – #/definitions/orders description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getItemsOrder: post: description: Consulta da entidade Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset properties: referenceCode: type: string description: Código de Referência do Pedido 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: itemOrders: type: array items: type: object allOf: – #/definitions/itemsOrders description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceCode description: Código de Referência do Pedido in: query type: string – name: limit description: Limit de dados para paginação in: query required: true type: integer format: int64 – name: offset description: Número da página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: itemOrders: type: array items: type: object allOf: – #/definitions/itemsOrders description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getClient: post: description: Consulta da entidade Clientes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset properties: number: type: string description: Código de Referência do Cliente _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: client: type: array items: type: object allOf: – #/definitions/clients description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Clientes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: number description: Código de Referência do Cliente 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 required: true type: integer format: int64 – name: offset description: Número da página in: query required: true 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getStatus: post: description: Consulta da entidade Status do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset properties: number: type: string description: Código de Referência do Status 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: status: type: array items: type: object allOf: – #/definitions/status description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Status do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: number description: Código de Referência do Status in: query type: string – name: limit description: Limit de dados para paginação in: query required: true type: integer format: int64 – name: offset description: Número da página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: status: type: array items: type: object allOf: – #/definitions/status description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getStore: post: description: Consulta da entidade Status do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset properties: referenceCode: type: string description: Código de Referência da Store _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: store: type: array items: type: object allOf: – #/definitions/stores description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Status do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceCode description: Código de Referência da Store 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 required: true type: integer format: int64 – name: offset description: Número da página in: query required: true 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getAgent: post: description: Consulta da entidade Status do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset properties: token: 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: agent: type: array items: type: object allOf: – #/definitions/agents description: Lista da Entidade Retornada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Status do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: token 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 required: true type: integer format: int64 – name: offset description: Número da página in: query required: true 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getAgentsOrder: post: description: Consulta da entidade Status do Pedido de Vendas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da entidade Status 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 required: true type: integer format: int64 – name: offset description: Número da página in: query required: true 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/queries/getGroupedTable: post: description: Consulta das tabelas agrupadas para o BI tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – limit – offset 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 das tabelas agrupadas para o BI 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 required: true type: integer format: int64 – name: offset description: Número da página in: query required: true 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/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/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 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: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /flexyfeeddatabase/actions/runDatabaseFeed: post: description: Executador da importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – environment properties: environment: type: object allOf: – #/definitions/environments description: Ambiente que deseja fazer a carga de dados all: type: boolean description: Executar todas as entidades com processamento incremental default: false feedEntities: type: object allOf: – #/definitions/feedEntities description: Possibilita informar como true as entidades desejadas com processamento incremental allInitial: type: boolean description: Execução inicial do banco de dados, não acatando processamento incremental default: false responses: 200: description: Ok schema: type: object required: – feedEntities properties: feedEntities: type: object allOf: – #/definitions/feedEntities description: Executado somente entidades selecionadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: 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 feedEntities: description: Entidades a ser importadas type: object properties: 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 _error: type: string description: (Somente no retorno) Erro no critério de parâmetro enviado environments: description: Listar parâmetros do ambiente desejado 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: Campos da ser Retornada type: object required: – referenceCode – nameCategories2 – nameCategories3 properties: referenceCode: type: string description: Código de Referência nameCategories2: type: string description: Categoria do Produto nameCategories3: type: string description: Categoria do Produto orders: description: Campos da serem Retornados type: object required: – number – totalreal – promotiondiscount – createdat – customer – shoppingstore properties: number: type: string description: Número do Pedido totalreal: type: string description: Total Real promotiondiscount: type: string description: Desconto Concedido 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 clients: description: Campos da serem Retornados type: object required: – identitynumber – companyname – tradename – firstname properties: identitynumber: type: string description: Número do Cliente companyname: type: string description: Razão Social tradename: type: string description: Nome da Fantasia firstname: type: string description: Nome da Pessoa status: description: Campos da serem Retornados type: object required: – number – name – info properties: number: type: string description: Número do Status name: type: string description: Nome info: type: string description: Informação / Observação stores: description: Campos da serem Retornados type: object required: – referenceCode – name – _group properties: referenceCode: type: string description: Código da Loja name: type: string description: Nome Fantasia _group: type: string description: Grupo agents: description: Campos da serem Retornados type: object required: – token – name properties: token: type: string description: Código do Agente name: type: string description: Nome agentsOrders: description: Campos da serem Retornados 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: Campos da serem Retornados type: object required: – referenceCode – name – quantity – valorUnitarioReal – promotionDiscount – orders – 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 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 groupedTables: description: Campos da serem Retornados 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 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