Mais pesquisados:Customização, Tutorial, Documentação

WMS-X Foundation Warehouse (warehouse)

20 views 0 13/05/2024 Atualizado em 21/10/2024 integrador

2.0info: 0.11.2 WMS-X Foundation Warehouse description: Serviço Foundation do WMS-X responsável pelo Armazém x-senior-domain: Foundation WMS-X x-senior-domain-path: wmsx_fnd x-senior-service-path: warehouse 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/wmsx_fndsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /warehouse/queries/healthcheck: post: description: Verifica a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para garantir o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para garantir o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/listLinkSectorProduct: post: description: Listar o vinculo do produto ao setor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sectorId properties: sectorId: type: string description: Id do Setor referenceCode: type: string description: Código de Referência do produto productDescription: type: string description: Descrição do produto globalFilter: type: string description: Filtro de pesquisa global offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorProduct minimum: 1 description: Lista de Produtos Vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar o vinculo do produto ao setor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: sectorId description: Id do Setor in: query required: true type: string – name: referenceCode description: Código de Referência do produto in: query type: string – name: productDescription description: Descrição do produto in: query type: string – name: globalFilter description: Filtro de pesquisa global in: query type: string – name: offset description: Numero da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: sort description: Ordenação por campos in: query type: string – name: order description: Direção da ordenação do campos in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorProduct minimum: 1 description: Lista de Produtos Vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/listLinkSectorOwner: post: description: Listar o vinculo do depositante ao setor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sectorId properties: sectorId: type: string description: Id do Setor ownerPersonCnpCpf: type: string description: CNPJ/CPF do depositante ownerPersonName: type: string description: Nome fantasia do depositante globalFilter: type: string description: Filtro de pesquisa global offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorOwner minimum: 1 description: Lista de Depositantes vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar o vinculo do depositante ao setor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: sectorId description: Id do Setor in: query required: true type: string – name: ownerPersonCnpCpf description: CNPJ/CPF do depositante in: query type: string – name: ownerPersonName description: Nome fantasia do depositante in: query type: string – name: globalFilter description: Filtro de pesquisa global in: query type: string – name: offset description: Numero da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: sort description: Ordenação por campos in: query type: string – name: order description: Direção da ordenação do campos in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorOwner minimum: 1 description: Lista de Depositantes vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/autocompleteFilterWarehouse: post: description: Primitiva para obtenção de Armazém para vínculo ao papel do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Input de busca informado pelo usuário searchValue: type: string description: Input exato para busca de registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Retorno da consulta efetuada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obtenção de Armazém para vínculo ao papel do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Input de busca informado pelo usuário in: query type: string – name: searchValue description: Input exato para busca de registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Retorno da consulta efetuada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/listLinkSectorPlace: post: description: Listar o vinculo do local ao setor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – warehouseId – sectorId properties: warehouseId: type: string description: Id do Armazém sectorId: type: string description: Id do Setor address: type: string description: Código de Referência do produto placeType: type: string allOf: – #/definitions/enumPlaceType description: Tipo do Local globalFilter: type: string description: Filtro de pesquisa global offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/place minimum: 1 description: Lista de Locais de Armazenagem Vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/getPlaceToProductsAndToWmsOwners: post: description: Retornar o local de armazenagem válido para os produtos e depositantes informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – placeAddress – productsIds – wmsOwnersIds properties: wmsWarehouseId: type: string description: Id do Armazém placeAddress: type: string description: Endereço do local de armazenagem productsIds: type: array items: type: string minimum: 1 description: Ids dos produtos wmsOwnersIds: type: array items: type: string minimum: 1 description: Ids dos depositantes responses: 200: description: Ok schema: type: object required: – place properties: place: type: object allOf: – #/definitions/place description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar o local de armazenagem válido para os produtos e depositantes informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsWarehouseId description: Id do Armazém in: query required: true type: string – name: placeAddress description: Endereço do local de armazenagem in: query required: true type: string – name: productsIds description: Ids dos produtos in: query required: true type: array items: type: string minimum: 1 – name: wmsOwnersIds description: Ids dos depositantes in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – place properties: place: type: object allOf: – #/definitions/place description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/getPickingToProdutctOwner: post: description: Retornar o picking do produto/depositante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – productOwnerId properties: wmsWarehouseId: type: string description: Id do armazém productOwnerId: type: string description: Id do produto/depositante responses: 200: description: Ok schema: type: object required: – picking properties: picking: type: object allOf: – #/definitions/place description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar o picking do produto/depositante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsWarehouseId description: Id do armazém in: query required: true type: string – name: productOwnerId description: Id do produto/depositante in: query required: true type: string responses: 200: description: Ok schema: type: object required: – picking properties: picking: type: object allOf: – #/definitions/place description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/listSectorsOfProductAndWarehouse: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – productId properties: wmsWarehouseId: type: string description: Id do armazém productId: type: string description: Id do produto globalFilter: type: string description: Filtro de pesquisa global offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 orderBy: type: string description: Ordenação por campos / asc ou desc para direcão responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorProduct minimum: 1 description: Lista de Setores Vinculados Ao Produto Informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsWarehouseId description: Id do armazém in: query required: true type: string – name: productId description: Id do produto in: query required: true type: string – name: globalFilter description: Filtro de pesquisa global in: query type: string – name: offset description: Numero da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: orderBy description: Ordenação por campos / asc ou desc para direcão in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorProduct minimum: 1 description: Lista de Setores Vinculados Ao Produto Informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/listSectorsOfOwnerAndWarehouse: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – wmsOwnerId properties: wmsWarehouseId: type: string description: Id do armazém wmsOwnerId: type: string description: Id do Depositante globalFilter: type: string description: Filtro de pesquisa global offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 orderBy: type: string description: Ordenação por campos / asc ou desc para direcão responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorOwner minimum: 1 description: Lista de Setores Vinculados Ao Depositante Informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsWarehouseId description: Id do armazém in: query required: true type: string – name: wmsOwnerId description: Id do Depositante in: query required: true type: string – name: globalFilter description: Filtro de pesquisa global in: query type: string – name: offset description: Numero da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: orderBy description: Ordenação por campos / asc ou desc para direcão in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorOwner minimum: 1 description: Lista de Setores Vinculados Ao Depositante Informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/queries/validateSectorProduct: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/recValidateSectorProduct minimum: 1 description: dados para validação responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Retorna se os dados são válidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/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 /warehouse/queries/exportE001pes: 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 /warehouse/queries/exportWarehouse: 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 /warehouse/queries/exportWmsWarehouse: 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 /warehouse/queries/exportOwner: 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 /warehouse/queries/exportWmsOwner: 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 /warehouse/queries/exportWarehouseOwner: 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 /warehouse/queries/exportSector: 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 /warehouse/queries/exportSectorOwner: 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 /warehouse/queries/exportProduct: 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 /warehouse/queries/exportSectorProduct: 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 /warehouse/queries/exportPlace: 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 /warehouse/queries/exportProductOwner: 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 /warehouse/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 /warehouse/actions/printPlaceLabel: post: description: Imprimir etiqueta de local de armazenagem tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – placeIds properties: placeIds: type: array items: type: string minimum: 1 description: Ids dos Locais de Armazenagem responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download da etiqueta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/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 /warehouse/actions/importE001pes: 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 /warehouse/actions/importWarehouse: 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 /warehouse/actions/importWmsWarehouse: 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 /warehouse/actions/importOwner: 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 /warehouse/actions/importWmsOwner: 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 /warehouse/actions/importWarehouseOwner: 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 /warehouse/actions/importSector: 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 /warehouse/actions/importSectorOwner: 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 /warehouse/actions/importProduct: 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 /warehouse/actions/importSectorProduct: 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 /warehouse/actions/importPlace: 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 /warehouse/actions/importProductOwner: 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 /warehouse/signals/bulkCreatePlaces: post: description: Criar Locais de Armazenagem em massa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – placeType – wmsWarehouseId properties: dockBufferStart: type: integer format: int64 description: Doca/Buffer inicial dockBufferEnd: type: integer format: int64 description: Doca/Buffer final block: type: string description: Bloco streetStart: type: string description: Rua inicial streetEnd: type: string description: Rua final buildingStart: type: integer format: int64 description: Prédio inicial buildingEnd: type: integer format: int64 description: Prédio final floorStart: type: integer format: int64 description: Andar inicial floorEnd: type: integer format: int64 description: Andar final apartmentStart: type: integer format: int64 description: Apartamento inicial apartmentEnd: type: integer format: int64 description: Apartamento final placeType: type: string allOf: – #/definitions/enumPlaceType description: Tipo de local sideBuildingType: type: string allOf: – #/definitions/enumSideBuildingType description: Tipo do lado do prédio wmsWarehouseId: type: string description: Id do Armazém height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) maneuverHeight: type: integer format: int64 description: Altura de Manobra (mm) maxWeight: type: integer format: int64 description: Peso Máximo (gr) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /warehouse/signals/bulkChangePlaces: post: description: Alterar locais em massa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – placeIds properties: wmsWarehouseId: type: string description: Id do Armazém placeIds: type: array items: type: string minimum: 1 description: Lista de Ids de locais placeType: type: string allOf: – #/definitions/enumPlaceType description: Tipo de local height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) maneuverHeight: type: integer format: int64 description: Altura de Manobra (mm) maxWeight: type: integer format: int64 description: Peso Máximo (gr) situation: type: string allOf: – #/definitions/enumSitReg description: Situação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /warehouse/events/importE001pesEvent: 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 /warehouse/events/exportE001pesEvent: 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 /warehouse/events/importWarehouseEvent: 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 /warehouse/events/exportWarehouseEvent: 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 /warehouse/events/importWmsWarehouseEvent: 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 /warehouse/events/exportWmsWarehouseEvent: 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 /warehouse/events/importOwnerEvent: 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 /warehouse/events/exportOwnerEvent: 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 /warehouse/events/importWmsOwnerEvent: 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 /warehouse/events/exportWmsOwnerEvent: 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 /warehouse/events/importWarehouseOwnerEvent: 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 /warehouse/events/exportWarehouseOwnerEvent: 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 /warehouse/events/importSectorEvent: 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 /warehouse/events/exportSectorEvent: 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 /warehouse/events/importSectorOwnerEvent: 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 /warehouse/events/exportSectorOwnerEvent: 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 /warehouse/events/importProductEvent: 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 /warehouse/events/exportProductEvent: 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 /warehouse/events/importSectorProductEvent: 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 /warehouse/events/exportSectorProductEvent: 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 /warehouse/events/importPlaceEvent: 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 /warehouse/events/exportPlaceEvent: 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 /warehouse/events/importProductOwnerEvent: 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 /warehouse/events/exportProductOwnerEvent: 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 /warehouse/apis/linkSectorProduct: post: description: Vincular Setor aos Produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkSectorProductFacade responses: 200: description: Ok schema: #/definitions/linkSectorProductFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/apis/linkSectorOwner: post: description: Vincular Setor aos Depositantes tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkSectorOwnerFacade responses: 200: description: Ok schema: #/definitions/linkSectorOwnerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/apis/linkSectorPlace: post: description: Vincular Setor aos Locais de Armazenagem tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkSectorPlaceFacade responses: 200: description: Ok schema: #/definitions/linkSectorPlaceFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/e001pes: 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/e001pes/{id}: 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/warehouse: 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/warehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/warehouse/{id}: 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/warehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/wmsWarehouse: 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/wmsWarehouse responses: 200: description: The created resource schema: #/definitions/wmsWarehouse 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/wmsWarehouse responses: 200: description: The created resource schema: #/definitions/wmsWarehouse 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/wmsWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/wmsWarehouse/{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/wmsWarehouse responses: 200: description: Ok schema: #/definitions/wmsWarehouse 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/wmsWarehouse responses: 200: description: Ok schema: #/definitions/wmsWarehouse 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/wmsWarehouse 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 /warehouse/entities/wmsWarehouse/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/wmsWarehouse responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/owner: 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/owner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/owner/{id}: 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/owner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/warehouseOwner: 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/warehouseOwner responses: 200: description: The created resource schema: #/definitions/warehouseOwner 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/warehouseOwner responses: 200: description: The created resource schema: #/definitions/warehouseOwner 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/warehouseOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/warehouseOwner/{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/warehouseOwner responses: 200: description: Ok schema: #/definitions/warehouseOwner 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/warehouseOwner responses: 200: description: Ok schema: #/definitions/warehouseOwner 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/warehouseOwner 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 /warehouse/entities/warehouseOwner/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/warehouseOwner responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/sector: 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/sector responses: 200: description: The created resource schema: #/definitions/sector 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/sector responses: 200: description: The created resource schema: #/definitions/sector 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/sector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/sector/{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/sector responses: 200: description: Ok schema: #/definitions/sector 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/sector responses: 200: description: Ok schema: #/definitions/sector 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/sector 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 /warehouse/entities/sector/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sector responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/sectorOwner: 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/sectorOwner responses: 200: description: The created resource schema: #/definitions/sectorOwner 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/sectorOwner responses: 200: description: The created resource schema: #/definitions/sectorOwner 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/sectorOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/sectorOwner/{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/sectorOwner responses: 200: description: Ok schema: #/definitions/sectorOwner 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/sectorOwner responses: 200: description: Ok schema: #/definitions/sectorOwner 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/sectorOwner 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 /warehouse/entities/sectorOwner/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sectorOwner responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/sectorProduct: 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/sectorProduct responses: 200: description: The created resource schema: #/definitions/sectorProduct 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/sectorProduct responses: 200: description: The created resource schema: #/definitions/sectorProduct 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/sectorProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/sectorProduct/{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/sectorProduct responses: 200: description: Ok schema: #/definitions/sectorProduct 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/sectorProduct responses: 200: description: Ok schema: #/definitions/sectorProduct 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/sectorProduct 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 /warehouse/entities/sectorProduct/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sectorProduct responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/place: 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/place responses: 200: description: The created resource schema: #/definitions/place 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/place responses: 200: description: The created resource schema: #/definitions/place 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/place 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /warehouse/entities/place/{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/place responses: 200: description: Ok schema: #/definitions/place 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/place responses: 200: description: Ok schema: #/definitions/place 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/place 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 /warehouse/entities/place/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/place responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: serviceHealthStatus: description: Definições de status do serviço type: string enum: – UP – DOWN enumJurFis: description: Tipo de pessoa type: string enum: – VJ – VF enumTipMer: description: Tipo de mercado type: string enum: – VI – VE enumSitReg: description: Situação do registro type: string enum: – VA – VI enumRegime: description: Regime de Armazenagem type: string enum: – VF – VA – VG enumPlaceType: description: Tipo de Local de Armzenagem type: string enum: – PI – PB – PP – DC – BF – PA enumMaskAddressField: description: Campos que compõem a máscara do endereço do local de armazenagem type: string enum: – BLOCK – STREET – BUILDING – FLOOR – APARTMENT enumSideBuildingType: description: Tipo do Lado de Prédio type: string enum: – ALL – EVEN – ODD enumTypeTerm: description: Tipo de prazo type: string enum: – VM – VD enumControlShelfLife: description: Controle de validade type: string enum: – VN – VV – VF – VVF enumProductSituation: description: Situação do Produto type: string enum: – GOOD – DAMAGED – EXPIRED – TRUNCATED 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 checkData: description: Dados do Healthcheck type: object required: – name – status properties: name: type: string description: Nome do Healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck autocompleteFilter: description: DTO com informações de consulta type: object required: – text – value properties: text: type: string description: Descrição apresentada na consulta do filtro value: type: string description: Valor exato para armazenamento do filtro recPlaceLabelDataSource: description: Modelo de dados para o datasource do jasper para impressão de etiqueta de lote de armazenagem type: object required: – places properties: places: type: array items: type: object allOf: – #/definitions/recPlaceLabel minimum: 1 description: Locais recPlaceLabel: description: Modelo de dados para impressão de etiqueta de local de armazenagem type: object required: – address – formatedAddress properties: address: type: string description: Endereço formatedAddress: type: string description: Endereço formatado recValidateSectorProduct: description: Modelo de dados para validação de vinculo de setor e produto type: object required: – productSitution – productId properties: productSitution: type: string allOf: – #/definitions/enumProductSituation description: Situação dos produtos productId: type: string description: Id do Produto e001pes: description: Pessoa – Replicação type: object required: – codPes – nomPes – apePes – tipPes – tipMer properties: id: type: string format: uuid description: Identificador único codPes: type: integer format: int64 description: Código nomPes: type: string maxLength: 100 description: Nome apePes: type: string maxLength: 80 description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF numRge: type: string maxLength: 15 description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string maxLength: 6 description: Órgão emissor do RG insEst: type: string maxLength: 25 description: Inscrição estadual insMun: type: string maxLength: 16 description: Inscrição municipal tipMer: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado do cliente warehouse: type: object allOf: – #/definitions/warehouse description: Armazém owner: type: object allOf: – #/definitions/owner description: Depositante excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: warehouse: description: Armazém – Replicação type: object required: – warehouseSituation properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa warehouseSituation: type: string allOf: – #/definitions/enumSitReg description: Situação do Armazém excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: wmsWarehouse: description: Armazém type: object required: – warehouse properties: id: type: string format: uuid description: Id da entidade warehouse: type: object allOf: – #/definitions/warehouse description: Armazém blockMask: type: string maxLength: 5 description: Máscara bloco streetMask: type: string maxLength: 5 description: Máscara rua buildingMask: type: string maxLength: 5 description: Máscara prédio floorMask: type: string maxLength: 5 description: Máscara andar apartmentMask: type: string maxLength: 5 description: Máscara apartamento code: type: string description: Código do Armazem para Integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: owner: description: Depositante – Replicação type: object required: – ownerSituation properties: id: type: string format: uuid description: Identificador único e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa ownerSituation: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: wmsOwner: description: Depositante type: object required: – owner properties: id: type: string format: uuid description: Identificador único owner: type: object allOf: – #/definitions/owner description: Depositante regime: type: string allOf: – #/definitions/enumRegime description: Regime de Armazenagem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: warehouseOwner: description: Depositantes vinculados ao Armazém type: object required: – wmsWarehouse – wmsOwner properties: id: type: string format: uuid description: Id da entidade wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: sector: description: Setor type: object required: – code – description – good – damaged – expired – truncated – picking – bufferStock – buffer – wmsWarehouse – situation properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 20 description: Código description: type: string maxLength: 100 description: Descrição good: type: boolean description: Bom damaged: type: boolean description: Danificado expired: type: boolean description: Vencido truncated: type: boolean description: Truncado picking: type: boolean description: Picking bufferStock: type: boolean description: Pulmão buffer: type: boolean description: Buffer wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém situation: type: string allOf: – #/definitions/enumSitReg description: Situação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: sectorOwner: description: Depositantes vinculados ao Setor type: object required: – sector – wmsOwner properties: id: type: string format: uuid description: Id da entidade sector: type: object allOf: – #/definitions/sector description: Setor wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: product: description: Produto type: object required: – referenceCode – description – situation properties: id: type: string format: uuid description: Identificador único referenceCode: type: string description: Código Referência description: type: string description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: sectorProduct: description: Produtos Vinculados ao Setor type: object required: – sector – product properties: id: type: string format: uuid description: Id da entidade sector: type: object allOf: – #/definitions/sector description: Setor product: type: object allOf: – #/definitions/product description: Produto createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: place: description: Local de Armazenagem type: object required: – wmsWarehouse – type – height – width – length – maneuverHeight – maxWeight – situation properties: id: type: string format: uuid description: Identificador único address: type: string description: Endereço formatedAddress: type: string description: Endereço block: type: string description: Bloco street: type: string description: Rua building: type: integer format: int64 description: Prédio floor: type: integer format: int64 description: Andar apartment: type: integer format: int64 description: Apartamento wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém type: type: string allOf: – #/definitions/enumPlaceType description: Tipo height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) maneuverHeight: type: integer format: int64 description: Altura de Manobra (mm) maxWeight: type: integer format: int64 description: Peso Máximo (gr) situation: type: string allOf: – #/definitions/enumSitReg description: Situação sector: type: object allOf: – #/definitions/sector description: Setor labelTargetId: type: string description: Target Id da etiqueta labelFileName: type: string description: Nome do arquivo da etiqueta de local no S3 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: productOwner: description: Depositantes vinculados ao produto type: object required: – product – wmsOwner – code – description – situation – controlShelfLife – typeTerm – shelfLife – marketingPeriod – criticalDeadline – controlIndustrialBatch – requestDayInDates properties: id: type: string format: uuid description: Id da entidade product: type: object allOf: – #/definitions/product description: Produto wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante code: type: string description: Código do produto description: type: string description: Descrição do produto situation: type: string allOf: – #/definitions/enumSitReg description: Situação do produto controlShelfLife: type: string allOf: – #/definitions/enumControlShelfLife description: Tipo de controle de validade typeTerm: type: string allOf: – #/definitions/enumTypeTerm description: Tipo de prazo shelfLife: type: integer format: int64 description: Prazo de validade marketingPeriod: type: integer format: int64 description: Prazo de comercialização criticalDeadline: type: integer format: int64 description: Prazo crítico controlIndustrialBatch: type: boolean description: Controlar lote indústria requestDayInDates: type: boolean description: Solicitar dia ao informar data de vencimento e fabricação 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 linkSectorProductFacade: description: Vincular Setor aos Produtos type: object required: – sectorId properties: id: type: string format: uuid description: Identificador único sectorId: type: string format: uuid description: Id do Setor productIds: type: array items: type: string format: uuid description: Lista de Ids de produtos a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids removidos linkSectorOwnerFacade: description: Vincular Setor aos Depositantes type: object required: – sectorId properties: id: type: string format: uuid description: Identificador único sectorId: type: string format: uuid description: Id do Setor ownerIds: type: array items: type: string format: uuid description: Lista de Ids de depositantes a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids removidos linkSectorPlaceFacade: description: Vincular Setor aos Locais de Armazenagem type: object required: – sectorId properties: id: type: string format: uuid description: Identificador único sectorId: type: string format: uuid description: Id do Setor placeIds: type: array items: type: string format: uuid description: Lista de Ids de locais a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids de locais a serem removidos 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação