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

WMS-X Shipment General (general)

84 views 0 03/06/2024 Atualizado em 17/04/2025 integrador

2.0info: 1.2.0 WMS-X Shipment General description: Serviço Foundation da expedição do WMS-X x-senior-domain: Expedição WMS-X x-senior-domain-path: wmsx_shipment x-senior-service-path: general 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_shipmentsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general/queries/listLinkOutBoundPickup: post: description: Listar o vinculo do pedido com a coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – pickupId properties: wmsWarehouseId: type: string description: Id do armazém pickupId: type: string description: Id da coleta documentNumber: type: string description: Número do documento invoiceNumber: type: integer format: int64 description: Número da nota fiscal invoiceSeries: type: string description: Série da nota fiscal issueDate: type: string format: date description: Data de Emissão da Nota Fiscal boardingDate: type: string format: date description: Data esperada de embarque wmsOwnerId: type: string description: Depositante globalFilter: type: string description: Filtro 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/outBoundPickupView minimum: 1 description: Lista de pedidos Vinculados ou não à Coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar o vinculo do pedido com a coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsWarehouseId description: Id do armazém in: query required: true type: string – name: pickupId description: Id da coleta in: query required: true type: string – name: documentNumber description: Número do documento in: query type: string – name: invoiceNumber description: Número da nota fiscal in: query type: integer format: int64 – name: invoiceSeries description: Série da nota fiscal in: query type: string – name: issueDate description: Data de Emissão da Nota Fiscal in: query type: string format: date – name: boardingDate description: Data esperada de embarque in: query type: string format: date – name: wmsOwnerId description: Depositante in: query type: string – name: globalFilter description: Filtro 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/outBoundPickupView minimum: 1 description: Lista de pedidos Vinculados ou não à Coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getPickupDocuments: post: description: Consultar os pedido com a coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pickupId properties: pickupId: type: string description: Id da coleta globalFilter: type: string description: Filtro 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/recPickupDocument minimum: 1 description: Lista de pedidos vinculados à coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consultar os pedido com a coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pickupId description: Id da coleta in: query required: true type: string – name: globalFilter description: Filtro 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/recPickupDocument minimum: 1 description: Lista de pedidos vinculados à coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getPickupVolumes: post: description: Consultar os volumes da coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pickupId properties: pickupId: type: string description: Id da coleta globalFilter: type: string description: Filtro 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/recPickupVolume minimum: 1 description: Lista de volumes vinculados à coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consultar os volumes da coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pickupId description: Id da coleta in: query required: true type: string – name: globalFilter description: Filtro 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/recPickupVolume minimum: 1 description: Lista de volumes vinculados à coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getOutBoundItemsSpecificBatches: post: description: Consultar os itens do pedido e os lotes específicos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Filtro 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: 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/recOutBoundItemSpecificBatch minimum: 1 description: Lista de itens do pedido e os lotes específicos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consultar os itens do pedido e os lotes específicos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro in: query required: true 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: 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/recOutBoundItemSpecificBatch minimum: 1 description: Lista de itens do pedido e os lotes específicos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listLinkShipmentConfigurationOwner: post: description: Listar o vinculo do depositante à Configuração de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – shipmentConfigurationId properties: shipmentConfigurationId: type: string description: Id da Configuração de Expedição 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/shipmentConfigurationOwner minimum: 1 description: Lista de Depositantes vinculados ou não à Configuração de Expedição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar o vinculo do depositante à Configuração de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: shipmentConfigurationId description: Id da Configuração de Expedição 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/shipmentConfigurationOwner minimum: 1 description: Lista de Depositantes vinculados ou não à Configuração de Expedição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listLinkShipmentConfigurationWarehouse: post: description: Listar o vinculo do armazém à Configuração de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – shipmentConfigurationId properties: shipmentConfigurationId: type: string description: Id da Configuração de Expedição warehousePersonCnpCpf: type: string description: CNPJ/CPF do armazém warehousePersonName: type: string description: Nome fantasia do armazém 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/shipmentConfigurationWarehouse minimum: 1 description: Lista de Armazém vinculados ou não à Configuração de Expedição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar o vinculo do armazém à Configuração de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: shipmentConfigurationId description: Id da Configuração de Expedição in: query required: true type: string – name: warehousePersonCnpCpf description: CNPJ/CPF do armazém in: query type: string – name: warehousePersonName description: Nome fantasia do armazém 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/shipmentConfigurationWarehouse minimum: 1 description: Lista de Armazém vinculados ou não à Configuração de Expedição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/searchShipmentConfigurations: post: description: Busca configurações de expedição utilizando os filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: code: type: string description: Código da Configuração de Expedição description: type: string description: Descrição da Configuração de Expedição situation: type: string allOf: – #/definitions/enumSitReg description: Situação da Configuração de Expedição wmsOwnerId: type: string description: Id do Depositante vinculado wmsWarehouseId: type: string description: Id do Armazém vinculado 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/shipmentConfiguration minimum: 1 description: Dados das configurações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca configurações de expedição utilizando os filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: code description: Código da Configuração de Expedição in: query type: string – name: description description: Descrição da Configuração de Expedição in: query type: string – name: situation description: Situação da Configuração de Expedição in: query type: string allOf: – #/definitions/enumSitReg – name: wmsOwnerId description: Id do Depositante vinculado in: query type: string – name: wmsWarehouseId description: Id do Armazém vinculado 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/shipmentConfiguration minimum: 1 description: Dados das configurações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getOutBoundItems: post: description: Listar Itens do pedido/Outbound tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – outBoundId properties: outBoundId: type: string description: Id do Outbound page: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sortField: type: string description: sortDirection: type: integer format: int64 description: Direção da ordenação default: 0 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/recOutboundItemTabData minimum: 1 description: Listar Itens do pedido/OutBound 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar Itens do pedido/Outbound tags: – Queries x-senior-visibility: PRIVATE parameters: – name: outBoundId description: Id do Outbound in: query required: true type: string – name: page 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: sortField description: in: query type: string – name: sortDirection description: Direção da ordenação in: query type: integer format: int64 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/recOutboundItemTabData minimum: 1 description: Listar Itens do pedido/OutBound 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getOutBoundDocumentType: post: description: Listar Tipos de Documento de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsOwnerId properties: wmsOwnerId: type: string description: Id do Depositante code: type: string description: Código do Tipo de Documento description: type: string description: Descrição do Tipo de Documento globalFilter: type: string description: Filtro 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/outBoundDocumentType minimum: 1 description: Lista de Tipos de Documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar Tipos de Documento de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsOwnerId description: Id do Depositante in: query required: true type: string – name: code description: Código do Tipo de Documento in: query type: string – name: description description: Descrição do Tipo de Documento in: query type: string – name: globalFilter description: Filtro 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/outBoundDocumentType minimum: 1 description: Lista de Tipos de Documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listLinkShipmentConfigDocType: post: description: Listar o vinculo do Tipo de documento de expedição à Configuração de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – shipmentConfigurationId properties: shipmentConfigurationId: type: string description: Id da Configuração de Expedição documentTypeCode: type: string description: Código do Documento de expedição documentTypeDescription: type: string description: Descrição do Documento de expedição warehousePersonName: type: string description: Nome fantasia do armazém 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/shipmentConfigOutboundDocType minimum: 1 description: Lista de Tipos de documento de expedição vinculados ou não à Configuração de Expedição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar o vinculo do Tipo de documento de expedição à Configuração de Expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: shipmentConfigurationId description: Id da Configuração de Expedição in: query required: true type: string – name: documentTypeCode description: Código do Documento de expedição in: query type: string – name: documentTypeDescription description: Descrição do Documento de expedição in: query type: string – name: warehousePersonName description: Nome fantasia do armazém 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/shipmentConfigOutboundDocType minimum: 1 description: Lista de Tipos de documento de expedição vinculados ou não à Configuração de Expedição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/shipmentDraftReport: post: description: Gera o relatório de Minuta de Embarque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pickupNumber properties: pickupNumber: type: integer format: int64 description: Número da colera responses: 200: description: Ok schema: type: object required: – totalElements properties: contents: type: array items: type: string format: byte description: Conteudo do relatório totalElements: type: integer format: int64 description: Número de elementos na lista 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera o relatório de Minuta de Embarque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pickupNumber description: Número da colera in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: contents: type: array items: type: string format: byte description: Conteudo do relatório totalElements: type: integer format: int64 description: Número de elementos na lista 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listLinkOutBoundDocumentTypeOwner: post: description: Listar o vinculo do depositante ao tipo de documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – outBoundDocumentTypeId properties: outBoundDocumentTypeId: type: string description: Id do Tipo de Documento 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/outBoundDocumentTypeOwner 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 tipo de documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: outBoundDocumentTypeId description: Id do Tipo de Documento 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/outBoundDocumentTypeOwner minimum: 1 description: Lista de Depositantes vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/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 /general/queries/exportE001end: 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 /general/queries/exportE006pai: 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 /general/queries/exportE007ufs: 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 /general/queries/exportE008rai: 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 /general/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 /general/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 /general/queries/exportWmsCarrying: 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 /general/queries/exportPacking: 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 /general/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 /general/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 /general/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 /general/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 /general/queries/exportOutBound: 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 /general/queries/exportOutBoundItem: 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 /general/queries/exportIndustrialBatchSpecified: 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 /general/queries/exportOutBoundDelivery: 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 /general/queries/exportOutBoundReference: 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 /general/queries/exportShipmentPerson: 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 /general/queries/exportPickup: 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 /general/queries/exportOutBoundValidationControl: 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 /general/queries/exportDispatchSeparationWave: 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 /general/queries/exportOutBoundWave: 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 /general/queries/exportVolume: 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 /general/queries/exportVolumeDetail: 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 /general/queries/exportOutBoundPickup: 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 /general/queries/exportOutBoundPickupView: 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 /general/queries/exportUnitizer: 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 /general/queries/exportOutBoundShipmentDataView: 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 /general/queries/exportBatch: 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 /general/queries/exportSpecificBatch: 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 /general/queries/exportShipmentConfiguration: 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 /general/queries/exportShipmentConfigurationWarehouse: 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 /general/queries/exportShipmentConfigurationOwner: 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 /general/queries/exportSeparationZone: 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 /general/queries/exportOutBoundDocumentType: 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 /general/queries/exportOutBoundDocumentTypeSector: 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 /general/queries/exportOutBoundDocumentTypeOwner: 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 /general/queries/exportShipmentConfigOutboundDocType: 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 /general/queries/exportSeparationTaskQueryView: 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 /general/queries/exportOutBoundQueryView: 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 /general/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 /general/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/returnShipmentRelease: post: description: Retorna o oubound enviado para liberação para ser processado novamente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – selectedWarehouseId properties: outBoundIds: type: array items: type: string description: Identificadores dos Documentos Relativos ao Preset selectedWarehouseId: type: string description: Id do armazém responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/authorizeBoarding: post: description: Autorizar Embarque da Coleta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pickupId properties: pickupId: type: string description: Id da coleta responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se houve sucesso na operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/cancelAuthorizationBoarding: post: description: Cancelar Autorizção do Embarque da Coleta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pickupId properties: pickupId: type: string description: Id da coleta responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se houve sucesso na operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/printPickupBoardingReport: post: description: Gera o relatório de tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pickupId properties: pickupId: type: string description: Id da coleta responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do relatório 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/printShipmentDraftReport: post: description: Gera o relatório de Minuta de Embarque tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pickupId – timezone properties: pickupId: type: string description: Id da coleta timezone: type: string description: Timezone para geração do relatório responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do relatório 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/invoiceOutBound: post: description: Faturar pedido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – outBoundId – invoiceNumber – issueDate properties: outBoundId: type: string description: Id do pedido invoiceNumber: type: integer format: int64 description: Número da nota fiscal invoiceSeries: type: string description: Série da nota fiscal issueDate: type: string format: date description: Data de Emissão da Nota Fiscal accessKey: type: string description: Chave de acesso responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Informa se houve sucesso na execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/addShipingAddress: post: description: Adiciona um endereço de entrega para um pessoa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId – shipmentTo properties: personId: type: string description: Id da pessoa shipmentTo: type: object allOf: – #/definitions/recShipmentTo description: Endereço de entrega responses: 200: description: Ok schema: type: object required: – id properties: id: type: string maxLength: 36 description: Identificador único do registro criada/alterado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/getShipingAddress: post: description: Retorna endereços de entrega de um pessoa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId properties: personId: type: string description: Id da pessoa responses: 200: description: Ok schema: type: object properties: addresses: type: array items: type: object allOf: – #/definitions/recAddress description: Retorna os endereços de entrega. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/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 /general/actions/importE001end: 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 /general/actions/importE006pai: 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 /general/actions/importE007ufs: 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 /general/actions/importE008rai: 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 /general/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 /general/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 /general/actions/importWmsCarrying: 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 /general/actions/importPacking: 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 /general/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 /general/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 /general/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 /general/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 /general/actions/importOutBound: 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 /general/actions/importOutBoundItem: 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 /general/actions/importIndustrialBatchSpecified: 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 /general/actions/importOutBoundDelivery: 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 /general/actions/importOutBoundReference: 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 /general/actions/importShipmentPerson: 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 /general/actions/importPickup: 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 /general/actions/importOutBoundValidationControl: 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 /general/actions/importDispatchSeparationWave: 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 /general/actions/importOutBoundWave: 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 /general/actions/importVolume: 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 /general/actions/importVolumeDetail: 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 /general/actions/importOutBoundPickup: 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 /general/actions/importOutBoundPickupView: 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 /general/actions/importUnitizer: 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 /general/actions/importOutBoundShipmentDataView: 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 /general/actions/importBatch: 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 /general/actions/importSpecificBatch: 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 /general/actions/importShipmentConfiguration: 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 /general/actions/importShipmentConfigurationWarehouse: 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 /general/actions/importShipmentConfigurationOwner: 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 /general/actions/importSeparationZone: 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 /general/actions/importOutBoundDocumentType: 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 /general/actions/importOutBoundDocumentTypeSector: 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 /general/actions/importOutBoundDocumentTypeOwner: 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 /general/actions/importShipmentConfigOutboundDocType: 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 /general/actions/importSeparationTaskQueryView: 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 /general/actions/importOutBoundQueryView: 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 /general/signals/releaseShipment: post: description: Liberar pedidos para expedição tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – outBoundIds – selectedWarehouseId properties: outBoundIds: type: array items: type: string minimum: 1 description: Ids dos oubounds que serão processados selectedWarehouseId: type: string description: Id do armazém responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/dispatchPickup: post: description: Expedir coleta tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pickupId – pickupNumber properties: pickupId: type: string description: Id da coleta pickupNumber: type: integer format: int64 description: Número da colera responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/reversePickup: post: description: Estornar coleta tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pickupId – pickupNumber properties: pickupId: type: string description: Id da coleta pickupNumber: type: integer format: int64 description: Número da colera responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/sendOutboundStatus: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – outboundIds – status – changedDate properties: outboundIds: type: array items: type: string minimum: 1 description: Ids dos oubounds que serão processados status: type: string allOf: – #/definitions/enumOutBoundSituation description: Status changedDate: type: string format: date description: Data da alteração de status responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/signals/associateSpecificBatchesOnOutBounds: post: description: Associar Lotes especificos solicitados no pedido tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – outBoundIds properties: outBoundIds: type: array items: type: string minimum: 1 description: Ids dos Out Bound(s) que será vinculado os lotes solicitados caso tenha algum espeficado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /general/events/exportOutboundStatusChanged: post: description: Exportação de Status de Pedido x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/exportOutboundStatusPayload responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/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 /general/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 /general/events/importE001endEvent: 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 /general/events/exportE001endEvent: 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 /general/events/importE006paiEvent: 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 /general/events/exportE006paiEvent: 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 /general/events/importE007ufsEvent: 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 /general/events/exportE007ufsEvent: 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 /general/events/importE008raiEvent: 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 /general/events/exportE008raiEvent: 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 /general/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 /general/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 /general/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 /general/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 /general/events/importWmsCarryingEvent: 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 /general/events/exportWmsCarryingEvent: 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 /general/events/importPackingEvent: 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 /general/events/exportPackingEvent: 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 /general/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 /general/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 /general/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 /general/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 /general/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 /general/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 /general/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 /general/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 /general/events/importOutBoundEvent: 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 /general/events/exportOutBoundEvent: 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 /general/events/importOutBoundItemEvent: 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 /general/events/exportOutBoundItemEvent: 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 /general/events/importIndustrialBatchSpecifiedEvent: 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 /general/events/exportIndustrialBatchSpecifiedEvent: 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 /general/events/importOutBoundDeliveryEvent: 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 /general/events/exportOutBoundDeliveryEvent: 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 /general/events/importOutBoundReferenceEvent: 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 /general/events/exportOutBoundReferenceEvent: 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 /general/events/importShipmentPersonEvent: 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 /general/events/exportShipmentPersonEvent: 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 /general/events/importPickupEvent: 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 /general/events/exportPickupEvent: 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 /general/events/importOutBoundValidationControlEvent: 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 /general/events/exportOutBoundValidationControlEvent: 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 /general/events/importDispatchSeparationWaveEvent: 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 /general/events/exportDispatchSeparationWaveEvent: 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 /general/events/importOutBoundWaveEvent: 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 /general/events/exportOutBoundWaveEvent: 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 /general/events/importVolumeEvent: 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 /general/events/exportVolumeEvent: 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 /general/events/importVolumeDetailEvent: 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 /general/events/exportVolumeDetailEvent: 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 /general/events/importOutBoundPickupEvent: 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 /general/events/exportOutBoundPickupEvent: 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 /general/events/importOutBoundPickupViewEvent: 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 /general/events/exportOutBoundPickupViewEvent: 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 /general/events/importUnitizerEvent: 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 /general/events/exportUnitizerEvent: 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 /general/events/importOutBoundShipmentDataViewEvent: 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 /general/events/exportOutBoundShipmentDataViewEvent: 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 /general/events/importBatchEvent: 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 /general/events/exportBatchEvent: 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 /general/events/importSpecificBatchEvent: 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 /general/events/exportSpecificBatchEvent: 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 /general/events/importShipmentConfigurationEvent: 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 /general/events/exportShipmentConfigurationEvent: 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 /general/events/importShipmentConfigurationWarehouseEvent: 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 /general/events/exportShipmentConfigurationWarehouseEvent: 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 /general/events/importShipmentConfigurationOwnerEvent: 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 /general/events/exportShipmentConfigurationOwnerEvent: 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 /general/events/importSeparationZoneEvent: 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 /general/events/exportSeparationZoneEvent: 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 /general/events/importOutBoundDocumentTypeEvent: 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 /general/events/exportOutBoundDocumentTypeEvent: 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 /general/events/importOutBoundDocumentTypeSectorEvent: 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 /general/events/exportOutBoundDocumentTypeSectorEvent: 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 /general/events/importOutBoundDocumentTypeOwnerEvent: 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 /general/events/exportOutBoundDocumentTypeOwnerEvent: 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 /general/events/importShipmentConfigOutboundDocTypeEvent: 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 /general/events/exportShipmentConfigOutboundDocTypeEvent: 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 /general/events/importSeparationTaskQueryViewEvent: 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 /general/events/exportSeparationTaskQueryViewEvent: 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 /general/events/importOutBoundQueryViewEvent: 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 /general/events/exportOutBoundQueryViewEvent: 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 /general/apis/linkOutBoundPickup: post: description: Vincular Pedido à Coleta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkOutBoundPickupFacade responses: 200: description: Ok schema: #/definitions/linkOutBoundPickupFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/importOutBoundDocument: post: description: Importação Documento para Pedido de Expedição tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/importOutBoundDocumentFacadeInput responses: 200: description: Ok schema: #/definitions/importOutBoundDocumentFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/importOutBoundAuthorization: post: description: Importação da autorização do Pedido de Expedição tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/importOutBoundAuthorizationFacadeInput responses: 200: description: Ok schema: #/definitions/importOutBoundAuthorizationFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/integrateOutBound: post: description: API DEPRECIADA: Primitiva deprecada, utilize a primitiva importOutBoundDocument | DATA: 2024-11-01 | Integrar Pedido de Expedição deprecated: true tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/integrateOutBoundFacade responses: 200: description: Ok schema: #/definitions/integrateOutBoundFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/linkShipmentConfigurationOwner: post: description: Vincular Configuração de Expedição aos Depositantes tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkShipmentConfigurationOwnerFacade responses: 200: description: Ok schema: #/definitions/linkShipmentConfigurationOwnerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/linkShipmentConfigurationWarehouse: post: description: Vincular Configuração de Expedição aos Armazéns tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkShipmentConfigurationWarehouseFacade responses: 200: description: Ok schema: #/definitions/linkShipmentConfigurationWarehouseFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/linkShipmentConfigurationDocType: post: description: Vincular Configuração de Expedição aos Tipos de documentos de expedição tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkShipmentConfigurationDocTypeFacade responses: 200: description: Ok schema: #/definitions/linkShipmentConfigurationDocTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/linkOutBoundDocumentTypeOwner: post: description: Vincular Tipo de Documento aos Depositantes tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkOutBoundDocumentTypeOwnerFacade responses: 200: description: Ok schema: #/definitions/linkOutBoundDocumentTypeOwnerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/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 /general/entities/e001end: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e001end/{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/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e006pai: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e006pai/{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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e007ufs: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e007ufs/{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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e008rai: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/e008rai/{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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/wmsWarehouse: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/wmsWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/wmsWarehouse/{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/wmsWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/wmsOwner: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/wmsOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/wmsOwner/{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/wmsOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/wmsCarrying: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/wmsCarrying 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/wmsCarrying/{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/wmsCarrying 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/packing: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/packing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/packing/{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/packing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/product: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/product/{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/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/productOwner: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/productOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/productOwner/{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/productOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sector: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/sector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sector/{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/sector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/place: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/place 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/place/{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/place 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBound: 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/outBound responses: 200: description: The created resource schema: #/definitions/outBound 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/outBound responses: 200: description: The created resource schema: #/definitions/outBound 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBound 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBound/{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/editOutBound responses: 200: description: Ok schema: #/definitions/editOutBound 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/outBound responses: 200: description: Ok schema: #/definitions/outBound 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/outBound 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 /general/entities/outBound/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBound responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundItem: 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/outBoundItem responses: 200: description: The created resource schema: #/definitions/outBoundItem 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/outBoundItem responses: 200: description: The created resource schema: #/definitions/outBoundItem 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundItem/{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/editOutBoundItem responses: 200: description: Ok schema: #/definitions/editOutBoundItem 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/outBoundItem responses: 200: description: Ok schema: #/definitions/outBoundItem 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/outBoundItem 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 /general/entities/outBoundItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/industrialBatchSpecified: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/industrialBatchSpecified 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDelivery: 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/outBoundDelivery responses: 200: description: The created resource schema: #/definitions/outBoundDelivery 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/outBoundDelivery responses: 200: description: The created resource schema: #/definitions/outBoundDelivery 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundDelivery 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDelivery/{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/editOutBoundDelivery responses: 200: description: Ok schema: #/definitions/editOutBoundDelivery 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/outBoundDelivery responses: 200: description: Ok schema: #/definitions/outBoundDelivery 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/outBoundDelivery 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 /general/entities/outBound/{parentId}/deliveryAddress: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outBoundDelivery responses: 200: description: The created resource schema: #/definitions/outBoundDelivery 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outBoundDelivery responses: 200: description: The created resource schema: #/definitions/outBoundDelivery 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: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundDelivery 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBound/{parentId}/deliveryAddress/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutBoundDelivery responses: 200: description: Ok schema: #/definitions/editOutBoundDelivery 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outBoundDelivery responses: 200: description: Ok schema: #/definitions/outBoundDelivery 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outBoundDelivery 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDelivery/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundDelivery responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundReference: 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/outBoundReference responses: 200: description: The created resource schema: #/definitions/outBoundReference 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/outBoundReference responses: 200: description: The created resource schema: #/definitions/outBoundReference 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundReference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundReference/{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/editOutBoundReference responses: 200: description: Ok schema: #/definitions/editOutBoundReference 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/outBoundReference responses: 200: description: Ok schema: #/definitions/outBoundReference 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/outBoundReference 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 /general/entities/outBound/{parentId}/outBoundReference: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/outBoundReference responses: 200: description: The created resources schema: type: array items: #/definitions/outBoundReference 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/outBoundReference responses: 200: description: The created resources schema: type: array items: #/definitions/outBoundReference 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: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundReference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBound/{parentId}/outBoundReference/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutBoundReference responses: 200: description: Ok schema: #/definitions/editOutBoundReference 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outBoundReference responses: 200: description: Ok schema: #/definitions/outBoundReference 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outBoundReference 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundReference/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundReference responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentPerson: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentPerson responses: 200: description: The created resource schema: #/definitions/shipmentPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentPerson responses: 200: description: The created resource schema: #/definitions/shipmentPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/shipmentPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentPerson/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editShipmentPerson responses: 200: description: Ok schema: #/definitions/editShipmentPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/shipmentPerson responses: 200: description: Ok schema: #/definitions/shipmentPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/shipmentPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /general/entities/shipmentPerson/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/shipmentPerson responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/pickup: 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/pickup responses: 200: description: The created resource schema: #/definitions/pickup 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/pickup responses: 200: description: The created resource schema: #/definitions/pickup 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pickup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/pickup/{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/editPickup responses: 200: description: Ok schema: #/definitions/editPickup 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/pickup responses: 200: description: Ok schema: #/definitions/pickup 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/pickup 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 /general/entities/pickup/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pickup responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundValidationControl: 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/outBoundValidationControl responses: 200: description: The created resource schema: #/definitions/outBoundValidationControl 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/outBoundValidationControl responses: 200: description: The created resource schema: #/definitions/outBoundValidationControl 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundValidationControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundValidationControl/{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/editOutBoundValidationControl responses: 200: description: Ok schema: #/definitions/editOutBoundValidationControl 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/outBoundValidationControl responses: 200: description: Ok schema: #/definitions/outBoundValidationControl 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/outBoundValidationControl 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 /general/entities/outBoundValidationControl/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundValidationControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/volume: 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/volume responses: 200: description: The created resource schema: #/definitions/volume 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/volume responses: 200: description: The created resource schema: #/definitions/volume 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/volume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/volume/{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/editVolume responses: 200: description: Ok schema: #/definitions/editVolume 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/volume responses: 200: description: Ok schema: #/definitions/volume 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/volume 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 /general/entities/volume/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/volume responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/volumeDetail: 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/volumeDetail responses: 200: description: The created resource schema: #/definitions/volumeDetail 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/volumeDetail responses: 200: description: The created resource schema: #/definitions/volumeDetail 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/volumeDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/volumeDetail/{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/editVolumeDetail responses: 200: description: Ok schema: #/definitions/editVolumeDetail 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/volumeDetail responses: 200: description: Ok schema: #/definitions/volumeDetail 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/volumeDetail 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 /general/entities/volumeDetail/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/volumeDetail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundPickup: 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/outBoundPickup responses: 200: description: The created resource schema: #/definitions/outBoundPickup 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/outBoundPickup responses: 200: description: The created resource schema: #/definitions/outBoundPickup 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundPickup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundPickup/{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/editOutBoundPickup responses: 200: description: Ok schema: #/definitions/editOutBoundPickup 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/outBoundPickup responses: 200: description: Ok schema: #/definitions/outBoundPickup 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/outBoundPickup 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 /general/entities/outBoundPickup/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundPickup responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/unitizer: 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/unitizer responses: 200: description: The created resource schema: #/definitions/unitizer 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/unitizer responses: 200: description: The created resource schema: #/definitions/unitizer 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/unitizer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/unitizer/{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/editUnitizer responses: 200: description: Ok schema: #/definitions/editUnitizer 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/unitizer responses: 200: description: Ok schema: #/definitions/unitizer 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/unitizer 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 /general/entities/unitizer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/unitizer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundShipmentDataView: get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundShipmentDataView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfiguration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentConfiguration responses: 200: description: The created resource schema: #/definitions/shipmentConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentConfiguration responses: 200: description: The created resource schema: #/definitions/shipmentConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/shipmentConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfiguration/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editShipmentConfiguration responses: 200: description: Ok schema: #/definitions/editShipmentConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/shipmentConfiguration responses: 200: description: Ok schema: #/definitions/shipmentConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/shipmentConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /general/entities/shipmentConfiguration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/shipmentConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfigurationWarehouse: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentConfigurationWarehouse responses: 200: description: The created resource schema: #/definitions/shipmentConfigurationWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentConfigurationWarehouse responses: 200: description: The created resource schema: #/definitions/shipmentConfigurationWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/shipmentConfigurationWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfigurationWarehouse/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editShipmentConfigurationWarehouse responses: 200: description: Ok schema: #/definitions/editShipmentConfigurationWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/shipmentConfigurationWarehouse responses: 200: description: Ok schema: #/definitions/shipmentConfigurationWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/shipmentConfigurationWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /general/entities/shipmentConfigurationWarehouse/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/shipmentConfigurationWarehouse responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfigurationOwner: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentConfigurationOwner responses: 200: description: The created resource schema: #/definitions/shipmentConfigurationOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/shipmentConfigurationOwner responses: 200: description: The created resource schema: #/definitions/shipmentConfigurationOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/shipmentConfigurationOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfigurationOwner/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editShipmentConfigurationOwner responses: 200: description: Ok schema: #/definitions/editShipmentConfigurationOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/shipmentConfigurationOwner responses: 200: description: Ok schema: #/definitions/shipmentConfigurationOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/shipmentConfigurationOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /general/entities/shipmentConfigurationOwner/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/shipmentConfigurationOwner responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDocumentType: 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/outBoundDocumentType responses: 200: description: The created resource schema: #/definitions/outBoundDocumentType 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/outBoundDocumentType responses: 200: description: The created resource schema: #/definitions/outBoundDocumentType 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundDocumentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDocumentType/{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/editOutBoundDocumentType responses: 200: description: Ok schema: #/definitions/editOutBoundDocumentType 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/outBoundDocumentType responses: 200: description: Ok schema: #/definitions/outBoundDocumentType 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/outBoundDocumentType 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 /general/entities/outBoundDocumentType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundDocumentType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDocumentTypeSector: 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/outBoundDocumentTypeSector responses: 200: description: The created resource schema: #/definitions/outBoundDocumentTypeSector 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/outBoundDocumentTypeSector responses: 200: description: The created resource schema: #/definitions/outBoundDocumentTypeSector 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundDocumentTypeSector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDocumentTypeSector/{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/editOutBoundDocumentTypeSector responses: 200: description: Ok schema: #/definitions/editOutBoundDocumentTypeSector 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/outBoundDocumentTypeSector responses: 200: description: Ok schema: #/definitions/outBoundDocumentTypeSector 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/outBoundDocumentTypeSector 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 /general/entities/outBoundDocumentTypeSector/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundDocumentTypeSector responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDocumentTypeOwner: 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/outBoundDocumentTypeOwner responses: 200: description: The created resource schema: #/definitions/outBoundDocumentTypeOwner 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/outBoundDocumentTypeOwner responses: 200: description: The created resource schema: #/definitions/outBoundDocumentTypeOwner 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundDocumentTypeOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundDocumentTypeOwner/{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/editOutBoundDocumentTypeOwner responses: 200: description: Ok schema: #/definitions/editOutBoundDocumentTypeOwner 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/outBoundDocumentTypeOwner responses: 200: description: Ok schema: #/definitions/outBoundDocumentTypeOwner 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/outBoundDocumentTypeOwner 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 /general/entities/outBoundDocumentTypeOwner/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundDocumentTypeOwner responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfigOutboundDocType: 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/shipmentConfigOutboundDocType responses: 200: description: The created resource schema: #/definitions/shipmentConfigOutboundDocType 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/shipmentConfigOutboundDocType responses: 200: description: The created resource schema: #/definitions/shipmentConfigOutboundDocType 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/shipmentConfigOutboundDocType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/shipmentConfigOutboundDocType/{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/editShipmentConfigOutboundDocType responses: 200: description: Ok schema: #/definitions/editShipmentConfigOutboundDocType 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/shipmentConfigOutboundDocType responses: 200: description: Ok schema: #/definitions/shipmentConfigOutboundDocType 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/shipmentConfigOutboundDocType 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 /general/entities/shipmentConfigOutboundDocType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/shipmentConfigOutboundDocType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/separationTaskQueryView: get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/separationTaskQueryView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/outBoundQueryView: get: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outBoundQueryView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumTipMer: type: string enum: – VI – VE description: Tipo de mercado: * `VI` – Interno (Nacional) * `VE` – Externo (Exterior) enumSitReg: type: string enum: – VA – VI description: Situação do registro: * `VA` – Ativo * `VI` – Inativo enumRegime: type: string enum: – VF – VA – VG description: Regime de Armazenagem: * `VF` – Filial * `VA` – Armazém Geral * `VG` – GMB – Guia de Movimentação de Bens enumControlShelfLife: type: string enum: – VN – VV – VF – VVF description: Controle de validade: * `VN` – Não controla * `VV` – Coleta vencimento * `VF` – Coleta fabricação * `VVF` – Coleta vencimento e fabricação enumTypeTerm: type: string enum: – VM – VD description: Tipo de prazo: * `VM` – Meses * `VD` – Dias enumPlaceType: type: string enum: – PI – PB – PP – DC – BF – PA description: Tipo de Local de Armzenagem: * `PI` – Picking * `PB` – Pulmão Blocado * `PP` – Pulmão Paletizado * `DC` – Doca * `BF` – Buffer * `PA` – Packing enumOutBoundSituation: type: string enum: – PENDING – RELEASE_IN_PROGRESS – RELEASE_REJECTED – RELEASED – IN_SHIPMENT – IN_SEPARATION – SEPARATED – IN_CHECKIN – CHECKED – IN_PICKUP – FINISHED – CANCELED description: Situação do Pedido de Expedição: * `PENDING` – Pendente * `RELEASE_IN_PROGRESS` – Liberação em Andamento * `RELEASE_REJECTED` – Liberação Rejeitada * `RELEASED` – Liberado * `IN_SHIPMENT` – Em Expedição * `IN_SEPARATION` – Em Separação * `SEPARATED` – Separado * `IN_CHECKIN` – Em Conferência * `CHECKED` – Conferido * `IN_PICKUP` – Em Coleta * `FINISHED` – Processado * `CANCELED` – Cancelada enumTransportModel: type: string enum: – ROAD – RAILWAY – AIR description: Modelo de Trasnsporte: * `ROAD` – Rodoviário * `RAILWAY` – Ferroviário * `AIR` – Aéreo enumPickupSituation: type: string enum: – CREATED – RELEASED – IN_SHIPMENT – FINISHED – IN_REVERSE – CANCELED description: Situação da coleta: * `CREATED` – Criada * `RELEASED` – Liberada * `IN_SHIPMENT` – Em expedição * `FINISHED` – Finalizada * `IN_REVERSE` – Em estorno * `CANCELED` – Cancelada enumProductSituation: type: string enum: – GOOD – DAMAGED – EXPIRED – TRUNCATED description: Situação do Produto: * `GOOD` – Bom * `DAMAGED` – Danificado * `EXPIRED` – Vencido * `TRUNCATED` – Truncado enumStockValidationSituation: type: string enum: – PENDING – RELEASE_IN_PROGRESS – REJECTED – APPROVED – CANCELED description: Situação da validação de estoque: * `PENDING` – Pendente * `RELEASE_IN_PROGRESS` – Liberação em Andamento * `REJECTED` – Rejeitada * `APPROVED` – Aprovada * `CANCELED` – Cancelada enumSeparationWaveSituation: type: string enum: – FORMED – RELEASED – EXECUTING – FINISHED – CANCELED description: Situação da onda de separação: * `FORMED` – Formada * `RELEASED` – Liberada * `EXECUTING` – Em execução * `FINISHED` – Finalizada * `CANCELED` – Cancelada enumVolumeSituation: type: string enum: – CREATED – IN_PROGRESS – FINISHED – CANCELED description: Situação do volume: * `CREATED` – Criado * `IN_PROGRESS` – Em andamento * `FINISHED` – Finalizado * `CANCELED` – Cancelado enumUnitizerType: type: string enum: – OWN – RETURNABLE – REUSABLE description: Tipo de unitizador: * `OWN` – Própria * `RETURNABLE` – Retornável * `REUSABLE` – Reutilizável enumTipEnd: type: string enum: – V3 – V4 description: Tipo de endereço: * `V3` – Comercial * `V4` – Residencial enumOutBoundDocumentType: type: string enum: – ORDER – INVOICE description: Tipo de documento do Pedido de Expedição: * `ORDER` – Pedido de venda * `INVOICE` – Nota fiscal enumPalletType: type: string enum: – COMPLETE – INCOMPLETE – LEFTOVER – UNIT description: Tipo do Lote Palete Gerado: * `COMPLETE` – Palete Completo * `INCOMPLETE` – Palete Incompleto * `LEFTOVER` – Palete Sobra * `UNIT` – Palete Unitário enumInputOpertionType: type: string enum: – ORDER_RECEIVING – RELOCATION – STOCK_ENTRY_CORRECTION – INVENTORY description: Tipo de Operação de Entrada: * `ORDER_RECEIVING` – Ordem de Recebimento * `RELOCATION` – Remanejamento * `STOCK_ENTRY_CORRECTION` – Ajuste de Estoque de Entrada * `INVENTORY` – Inventário enumBatchOrigin: type: string enum: – OR – RE – IV – SC – MS description: Origem do Lote: * `OR` – Ordem de Recebimento * `RE` – Remanejamento * `IV` – Inventário * `SC` – Ajuste * `MS` – Mudança de Estado de Material enumSpecificBatchSituation: type: string enum: – CREATED – CANCELED – IN_SHIPMENT description: Tipo de Situação do Lote Específico: * `CREATED` – Criada * `CANCELED` – Cancelada * `IN_SHIPMENT` – Em expedição enumConsumptionTypeStock: type: string enum: – COMPLETE – BALLAST – CLOSED_BOX description: Tipo de Consumo de Estoque: * `COMPLETE` – Palete Completo * `BALLAST` – Lastro * `CLOSED_BOX` – Caixa Fechada enumOrderFIFOBy: type: string enum: – RECEIVING_DATE – STORAGE_DATE description: Tipo de Ordenação de FIFO: * `RECEIVING_DATE` – Data de Recebimento * `STORAGE_DATE` – Data de Armazenagem enumPlaceTypePriority: type: string enum: – PL – PI – BF – AL description: Prioridade de Tipo de Local: * `PL` – Pulmão * `PI` – Picking * `BF` – Buffer * `AL` – Todos enumProductVisualizationType: type: string enum: – NONE – ONLY_PRODUCT – PRODUCT_AND_QUANTITY description: Permitir visualização dos produtos esperados para conferência de Saida: * `NONE` – Nenhum * `ONLY_PRODUCT` – Somente Produtos * `PRODUCT_AND_QUANTITY` – Produto e quantidade enumOutboundReferenceKey: type: string enum: – INVOICE_DATE – INVOICE_NUMBER – INVOICE_SERIES – INVOICE_ACCESS_KEY description: Chave com campos de Referencia para Outbound: * `INVOICE_DATE` – Data de Emissão da Nota Fiscal * `INVOICE_NUMBER` – Número da Nota Fiscal * `INVOICE_SERIES` – Serie da Nota Fiscal * `INVOICE_ACCESS_KEY` – Chave da Nota Fiscal enumOutboundOrigin: type: string enum: – MANUAL – INTEGRATION description: Origem do cadastro do Pedido de Expedição: * `MANUAL` – Cadastro via tela * `INTEGRATION` – Cadastro via integração enumSideBuildingType: type: string enum: – ALL – EVEN – ODD description: Tipo do Lado de Prédio: * `ALL` – Todos os lados * `EVEN` – Lados pares * `ODD` – Lados ímpares enumPlaceBlockOperation: type: string enum: – MB – GI description: Operações de bloqueio de local: * `MB` – Bloqueio manual * `GI` – Inventário Geral enumSeparationTaskSituation: type: string enum: – CREATED – IN_SEPARATION – IN_DELIVERY – SEPARATED – CANCELED description: Situação da Tarefa de Separação: * `CREATED` – Criada * `IN_SEPARATION` – Em separação * `IN_DELIVERY` – Em entrega * `SEPARATED` – Separado * `CANCELED` – Cancelada userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim recPickupDocument: description: Pedido de Expedição vinculado à coleta type: object required: – outBound – wave – items properties: outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda items: type: array items: type: object allOf: – #/definitions/outBoundItem minimum: 1 description: Itens recPickupVolume: description: Volume vinculado à coleta type: object required: – volume – items properties: volume: type: object allOf: – #/definitions/volume description: Volume items: type: array items: type: object allOf: – #/definitions/volumeDetail minimum: 1 description: Itens recShipmentPerson: description: Pessoa vinculada ao Pedido de Expedição type: object required: – code properties: code: type: string description: Código de Integração da Pessoa name: type: string description: Nome da Pessoa legalPerson: type: boolean description: Indica que é uma pessoa juridica default: true national: type: boolean description: Indica se pessoa atua em mercado nacional default: true documentNumber: type: string description: Documento – Ex: CNPJ / CPF / Passaporte recOutboundReferenceFields: description: Campos de referencia para cabeçalho do Pedido de Expedição type: object required: – key – value properties: key: type: string allOf: – #/definitions/enumOutboundReferenceKey description: Chave do Campo value: type: string description: Valor para Campo recInvoice: description: Entrega da Expedição type: object required: – issueDate – number properties: issueDate: type: string format: date description: Data de Emissão do Outbound / Nota Fiscal number: type: integer format: int64 description: Número da Nota Somente se DocumentType for Invoice serie: type: integer format: int64 description: Serie da Nota accessKey: type: string description: Chave da Nota Fiscal recShipmentTo: description: Entrega da Expedição type: object properties: code: type: string description: Código de Integração da Pessoa vinculada ao endereço entrega name: type: string description: Nome do Pessoa que recebe a entrega legalPerson: type: boolean description: Indica que é uma pessoa juridica default: true national: type: boolean description: Indica se pessoa atua em mercado nacional default: true documentNumber: type: string description: Documento – Ex: CNPJ / CPF / Passaporte shippingAddress: type: object allOf: – #/definitions/recAddress description: Endereço para envio recAddress: description: Conjunto de Dados que forma um Endereço type: object required: – address properties: address: type: string description: Rua do Endereço address2: type: string description: Complemento number: type: string maxLength: 60 description: Número do Endereço postalCode: type: string description: Código Postal neighborhood: type: string maxLength: 75 description: Bairro city: type: string description: Cidade state: type: string description: Estado country: type: string description: Pais isBussinessAddress: type: boolean description: É endereço comercial recOutBoundItemSpecificBatch: description: Lotes específicos vinculados ao item do pedido type: object required: – outBoundItem – specificBatches properties: outBoundItem: type: object allOf: – #/definitions/outBoundItem description: Item do pedido specificBatches: type: array items: type: object allOf: – #/definitions/specificBatch minimum: 1 description: Lotes específicos recOutboundItem: description: Items do Pedido de Expedição type: object required: – productCode – quantity properties: itemNumber: type: integer format: int64 description: Número que identifica o item productCode: type: string description: Código do Produto productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto quantity: type: number format: double description: Quantidade minimum: 0.0 packagingBarCode: type: string description: Código da Embalagem uom: type: string description: Unidade de Medida specificBatches: type: array items: type: object allOf: – #/definitions/recSpecifyBatch description: Lotes especificos para expedição exportOutboundStatusPayload: description: Payload de exportação de status de pedido type: object required: – ownerCode – issuerCode – changedDate – status properties: ownerCode: type: string description: Código do Depositante issuerCode: type: string description: IssuerCode documentNumber: type: string description: Número do Pedido invoiceNumber: type: integer format: int64 description: Número da Nota Fiscal invoiceSeries: type: string description: Série da Nota Fiscal changedDate: type: string format: date description: Data da Alteração de Status status: type: string allOf: – #/definitions/enumOutBoundSituation description: Status do Pedido recOutboundItemTabData: description: Items do Pedido de Expedição type: object required: – outBoundItem – hasSpecificBatchAssociation properties: outBoundItem: type: object allOf: – #/definitions/outBoundItem description: Item do Pedido/Outbound apresentado em Tela hasSpecificBatchAssociation: type: boolean description: Identifica se já há Lote Específico associado ao item industrialBatchesRequested: type: array items: type: object allOf: – #/definitions/recSpecifyBatch description: Lotes específicos requisitados recSpecifyBatch: description: Lotes Espcíficos (Lote Indústria) para expedição type: object required: – batchInformation – quantity properties: batchInformation: type: string description: Lote específico quantity: type: number format: double description: Quantidade minimum: 0.0 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 sitPes: 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: e001end: description: Endereço da pessoa – Replicação type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa indEnt: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true indCob: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false indCol: type: boolean description: Indica se o endereço é utilizado para coleta default: false indFis: type: boolean description: Indicativo se o endereço é utilizado para endereço fiscal default: false postalCode: type: string maxLength: 20 description: Código Postal endPes: type: string maxLength: 100 description: Endereço nenEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento baiEnd: type: string maxLength: 75 description: Bairro prxEnd: type: string maxLength: 200 description: Ponto de referência e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade tipLoc: type: string allOf: – #/definitions/enumTipEnd description: Tipo do local nomRes: type: string maxLength: 50 description: Nome do responsável tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF insEst: type: string maxLength: 25 description: Inscrição estadual fonRes: type: string maxLength: 21 description: Telefone celRes: type: string maxLength: 22 description: Celular faxRes: type: string maxLength: 20 description: Fax emaRes: type: string maxLength: 100 description: E-mail sitEnd: 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: e006pai: description: País – Replicação type: object required: – codPai – nomPai – merSul – visEnt properties: id: type: string format: uuid description: Id da entidade codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome merSul: type: boolean description: Mercosul visEnt: type: boolean description: Visto entrada paiDir: type: integer format: int64 description: Código do país na DIRF minimum: 0 maximum: 999 paiSis: type: integer format: int64 description: País Siscomex/Siscoserv minimum: 0 maximum: 999 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: e007ufs: description: Estado – Replicação type: object required: – sigUfs – nomUfs – e006pai properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País 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: e008rai: description: Cidade – Replicação type: object required: – codRai – nomCid – e007ufs – cepMin – cepMax properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado popCid: type: integer format: int64 description: População minimum: 0 maximum: 999999999 potAlf: type: number format: double description: Potencial consumo minimum: 0.00 maximum: 99.999 locGeo: type: string maxLength: 6 description: Localização geográfica cepMin: type: integer format: int64 description: CEP inicial minimum: 0 maximum: 99999999 cepMax: type: integer format: int64 description: CEP final minimum: 0 maximum: 99999999 codFis: type: integer format: int64 description: Código fiscal município minimum: 0 maximum: 9999999 codIbg: type: integer format: int64 description: Código IBGE município minimum: 0 maximum: 9999999 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 properties: id: type: string format: uuid description: Id da entidade warehouseSituation: type: string allOf: – #/definitions/enumSitReg description: Situação do Armazém codPes: type: integer format: int64 description: Código nomPes: type: string description: Nome apePes: type: string description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string description: CNPJ/CPF numRge: type: string description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string description: Órgão emissor do RG insEst: type: string description: Inscrição estadual insMun: type: string description: Inscrição municipal 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 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 properties: id: type: string format: uuid description: Identificador único ownerSituation: type: string allOf: – #/definitions/enumSitReg description: Situação codPes: type: integer format: int64 description: Código nomPes: type: string description: Nome apePes: type: string description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string description: CNPJ/CPF numRge: type: string description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string description: Órgão emissor do RG insEst: type: string description: Inscrição estadual insMun: type: string description: Inscrição municipal regime: type: string allOf: – #/definitions/enumRegime description: Regime de Armazenagem allowsPartialSeparation: type: boolean description: Permite separação parcial code: type: string description: Código do Depositante para Integraçã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: wmsCarrying: description: Transportadora type: object properties: id: type: string format: uuid description: Identificador único sitTra: type: string allOf: – #/definitions/enumSitReg description: Situação da transportadora codPes: type: integer format: int64 description: Código nomPes: type: string description: Nome apePes: type: string description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string description: CNPJ/CPF numRge: type: string description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string description: Órgão emissor do RG insEst: type: string description: Inscrição estadual insMun: type: string description: Inscrição municipal code: type: string description: Código para Integraçã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: packing: description: Embalagem type: object properties: id: type: string format: uuid description: Identificador único product: type: object allOf: – #/definitions/product description: Produto code: type: string maxLength: 30 description: Código shortDescription: type: string description: Descrição Reduzida conversionFactor: type: number format: double description: Fator de Conversão height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) grossWeight: type: integer format: int64 description: Peso Bruto (gr) netWeight: type: integer format: int64 description: Peso Líquido (gr) ballast: type: integer format: int64 description: Lastro layer: type: integer format: int64 description: Camada maximumStacking: type: integer format: int64 description: Empilhamento Máximo preRegistration: type: boolean description: Pré-cadastro situation: 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: product: description: Produto type: object properties: id: type: string format: uuid description: Identificador único referenceCode: type: string description: Código Referência description: type: string description: Descrição cplDescription: type: string description: Descrição complementar situation: 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: productOwner: description: Depositantes vinculados ao produto type: object required: – 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 showFabDateInCollector: type: boolean description: Exibir data de fabricação nas operações do coletor default: true showExpDateInCollector: type: boolean description: Exibir data de vencimento nas operações do coletor default: true 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: sector: description: Setor type: object required: – situation properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 20 description: Código integrationCode: type: string description: Código de integração 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 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: place: description: Local de Armazenagem type: object 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 separationZone: type: object allOf: – #/definitions/separationZone description: Zona de separação sideBuildingType: type: string allOf: – #/definitions/enumSideBuildingType description: Tipo do lado do prédio blockOperation: type: string allOf: – #/definitions/enumPlaceBlockOperation description: Operação que solicitou o bloqueio do local 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: outBound: description: Pedido de expedição type: object required: – wmsWarehouse – wmsOwner – sender – receiver – receiverAddress – documentNumber – productSituation – situation properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante sender: type: object allOf: – #/definitions/e001pes description: Remetente receiver: type: object allOf: – #/definitions/e001pes description: Pessoa Destinatário receiverAddress: type: object allOf: – #/definitions/e001end description: Endereço do Destinatário deliveryAddress: type: object allOf: – #/definitions/outBoundDelivery description: Endereço de Entrega wmsCarrying: type: object allOf: – #/definitions/wmsCarrying description: Transportadora documentNumber: type: string description: Número do documento shippingDate: type: string format: date-time description: Data de expedição shippingUser: type: string description: Usuário expedição boardingDate: type: string format: date description: Data de embarque invoiceNumber: type: integer format: int64 description: Número da nota fiscal invoiceSeries: type: string description: Série da nota fiscal issueDate: type: string format: date description: Data de Emissão da Nota Fiscal productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto comments: type: string description: Descrição situation: type: string allOf: – #/definitions/enumOutBoundSituation description: Situação documentType: type: object allOf: – #/definitions/outBoundDocumentType description: Tipo do documento outBoundReference: type: array items: type: object allOf: – #/definitions/outBoundReference description: Dados de Referência do pedido de expedição outboundAuthorized: type: boolean description: Expedição Autorizada default: false authorizationUser: type: string description: Usuário de autorização da expedição authorizationDate: type: string format: date description: Data de autorização da expedição outboundOrigin: type: string allOf: – #/definitions/enumOutboundOrigin description: Origem do cadastro do pedido de expedição lastSituationSent: type: string allOf: – #/definitions/enumOutBoundSituation description: Última Situação Enviada outboundConfirmationSent: type: boolean description: Confirmação de separação padrão já emitida default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBound: type: object required: – id allOf: – #/definitions/outBound outBoundItem: description: Item do pedido de expedição type: object required: – outBound – productOwner – packing – quantity properties: id: type: string format: uuid description: Identificador único outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição itemNumber: type: integer format: int64 description: Número do item productOwner: type: object allOf: – #/definitions/productOwner description: Produto packing: type: object allOf: – #/definitions/packing description: Embalagem quantity: type: number format: double description: Quantidade minimum: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundItem: type: object required: – id allOf: – #/definitions/outBoundItem industrialBatchSpecified: description: Lote Indústria especificado para Expedição type: object required: – outBoundItem – industrialBatch – quantity properties: id: type: string format: uuid description: Identificador único outBoundItem: type: object allOf: – #/definitions/outBoundItem description: Item do Pedido de expedição industrialBatch: type: string description: Lote Industria Especificado quantity: type: number format: double description: Quantidade Solicitada minimum: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: outBoundDelivery: description: Dados de entrega do pedido type: object required: – receiver properties: id: type: string format: uuid description: Identificador único receiver: type: object allOf: – #/definitions/e001pes description: Pessoa Vinculada ao Endereço de Entrega do pedido receiverName: type: string description: Nome da Pessoa receiverLegalPerson: type: boolean description: Indica que é uma pessoa juridica receiverNational: type: boolean description: Indica se pessoa atua em mercado nacional default: true receiverDocumentNumber: type: string description: Documento – Ex: CNPJ / CPF / Passaporte postalCode: type: string maxLength: 20 description: Código Postal Entrega address: type: string maxLength: 100 description: Endereço Entrega number: type: string maxLength: 60 description: Número Entrega complement: type: string maxLength: 200 description: Complemento Entrega neighborhood: type: string maxLength: 75 description: Bairro Entrega country: type: string maxLength: 75 description: País Entrega city: type: string maxLength: 75 description: Cidade Entrega state: type: string maxLength: 75 description: Estado Entrega createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundDelivery: type: object required: – id allOf: – #/definitions/outBoundDelivery outBoundReference: description: Dados de Referência para Outbound type: object required: – key – value properties: id: type: string format: uuid description: Identificador único outBound: type: object allOf: – #/definitions/outBound description: Pedido de Expedição key: type: string allOf: – #/definitions/enumOutboundReferenceKey description: Chave do Campo value: type: string description: Valor do Campo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundReference: type: object required: – id allOf: – #/definitions/outBoundReference shipmentPerson: description: Pessoa associada a integração para entrega type: object required: – personId – code properties: id: type: string format: uuid description: Identificador único personId: type: string format: uuid description: Pessoa de Entrega do pedido code: type: string description: Código de Integração para entrega createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editShipmentPerson: type: object required: – id allOf: – #/definitions/shipmentPerson pickup: description: Coleta type: object required: – wmsWarehouse – modal – situation properties: id: type: string format: uuid description: Identificador único number: type: integer format: int64 description: Número wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém modal: type: string allOf: – #/definitions/enumTransportModel description: Modal de transporte wmsCarrying: type: object allOf: – #/definitions/wmsCarrying description: Transportadora licensePlate: type: string description: Placa driver: type: object allOf: – #/definitions/e001pes description: Motorista dock: type: object allOf: – #/definitions/place description: Doca observation: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/enumPickupSituation description: Situação boardingAuthorizationDate: type: string format: date-time description: Data de autorização de embarque boardingAuthorizationUser: type: string description: Usuário de autorização de embarque pickupBoardingReportId: type: string description: Id do relatório de embarque pickupBoardingReportFileName: type: string description: Nome do arquivo do relatório de embarque shipmentDraftReportId: type: string description: Id do relatório da minuta de embarque shipmentDraftReportFileName: type: string description: Nome do arquivo do relatório de embarque createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPickup: type: object required: – id allOf: – #/definitions/pickup outBoundValidationControl: description: Entidade para controle de comunicação entre expedição e estoque type: object required: – idValidation – outBoundItem – sendDate – productSituation – quantityUn properties: id: type: string format: uuid description: Identificador único idValidation: type: string format: uuid description: Id da validação outBoundItem: type: object allOf: – #/definitions/outBoundItem description: Outbound sendDate: type: string format: date description: Data de envio para a validação receiptDate: type: string format: date description: Data de recebimento da validação productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto quantityUn: type: number format: double description: Quantidade Unitária solicitada availableQtyUn: type: number format: double description: Quantidade Unitária disponível no momento da avaliação default: 0.0 industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento stockValidationSituation: type: string allOf: – #/definitions/enumStockValidationSituation description: Situação da validação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundValidationControl: type: object required: – id allOf: – #/definitions/outBoundValidationControl dispatchSeparationWave: description: Onda de separação para expedição type: object required: – wmsWarehouse – situation – description properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém number: type: integer format: int64 description: Número da onda situation: type: string allOf: – #/definitions/enumSeparationWaveSituation description: Situação description: type: string description: Descrição separated: type: boolean description: Separada checked: type: boolean description: Conferida createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: outBoundWave: description: Vinculo da onda com os pedidos de expedição type: object required: – wave – outBound properties: id: type: string format: uuid description: Identificador único wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: volume: description: Volumes do Pedido de Expedição type: object required: – outBound – wave – barCode – volumeNumber – situation properties: id: type: string format: uuid description: Identificador único outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição pickup: type: object allOf: – #/definitions/pickup description: Coleta wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda de separação barCode: type: string description: Código de barras volumeNumber: type: integer format: int64 description: Número do volume situation: type: string allOf: – #/definitions/enumVolumeSituation 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: editVolume: type: object required: – id allOf: – #/definitions/volume volumeDetail: description: Detalhes do volume type: object required: – volume – productOwner – quantity properties: id: type: string format: uuid description: Identificador único volume: type: object allOf: – #/definitions/volume description: Volume productOwner: type: object allOf: – #/definitions/productOwner description: Produto/Depositante quantity: type: number format: double description: Quantidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVolumeDetail: type: object required: – id allOf: – #/definitions/volumeDetail outBoundPickup: description: Vinculo da coleta com os pedidos de expedição type: object required: – pickup – outBound properties: id: type: string format: uuid description: Identificador único pickup: type: object allOf: – #/definitions/pickup description: Coleta outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundPickup: type: object required: – id allOf: – #/definitions/outBoundPickup outBoundPickupView: description: Consulta para Vinculo da coleta com os pedidos de expedição type: object required: – outBound – quantityItems – totalCubage – totalWeight – quantityVolumes properties: id: type: integer format: int64 description: Identificador único da view outBoundPickupId: type: string format: uuid description: Identificador do vínculo pickup: type: object allOf: – #/definitions/pickup description: Coleta outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição quantityItems: type: integer format: int64 description: Quantidade de Itens totalCubage: type: number format: double description: Cubagem total totalWeight: type: number format: double description: Peso total quantityVolumes: type: integer format: int64 description: Quantidade de volumes unitizer: description: Unitizador type: object required: – description – situation – type – height – width – size – grossWeight – available properties: id: type: string format: uuid description: Identificador único description: type: string description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situação type: type: string allOf: – #/definitions/enumUnitizerType description: Tipo barCode: type: string description: Código de barras height: type: integer format: int64 description: Altura (mm) minimum: 0 width: type: integer format: int64 description: Largura (mm) minimum: 0 size: type: integer format: int64 description: Comprimento (mm) minimum: 0 grossWeight: type: integer format: int64 description: Peso Bruto (gr) minimum: 0 product: type: object allOf: – #/definitions/product description: Produto available: type: boolean description: Disponível createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editUnitizer: type: object required: – id allOf: – #/definitions/unitizer outBoundShipmentDataView: description: Consulta para informações complementares no pedidos de expedição type: object required: – wmsWarehouseId – outBound properties: id: type: integer format: int64 description: Identificador único da view wmsWarehouseId: type: string format: uuid description: Armazém outBound: type: object allOf: – #/definitions/outBound description: Pedido de Expedição invoiceNumber: type: string description: Número da Nota Fiscal invoiceSeries: type: string description: Série da Nota Fiscal invoiceDate: type: string description: Data de emissão da Nota Fiscal destinationDock: type: string description: Doca de destino waveNumber: type: integer format: int64 description: Número da onda pickupNumber: type: integer format: int64 description: Número da coleta wmsCarrying: type: string description: Transportadora batch: description: Lote de Armazenamento type: object properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém originId: type: string format: uuid description: Id da origem do lote origin: type: string allOf: – #/definitions/enumBatchOrigin description: Origem do lote palletNumber: type: integer format: int64 description: Número do palete palletType: type: string allOf: – #/definitions/enumPalletType description: Tipo do Lote productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto quantity: type: number format: double description: Quantidade total do lote no fator da embalagem quantityUn: type: number format: double description: Quantidade unitária total do lote industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento inputOperationType: type: string allOf: – #/definitions/enumInputOpertionType description: Tipo da operação de entrada inputOperationId: type: string format: uuid description: Id da operação de entrada inputOperationCode: type: string description: Código/Número da operação de entrada inputOperationDescription: type: string maxLength: 400 description: Descrição da operação de entrada blocked: type: boolean description: Bloqueado default: false 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: specificBatch: description: Lote específico type: object properties: id: type: string format: uuid description: Identificador único outBoundItem: type: string format: uuid description: Item do pedido place: type: object allOf: – #/definitions/place description: Local de armazenagem batch: type: object allOf: – #/definitions/batch description: Lote quantityUn: type: number format: double description: Quantidade unitária situation: type: string allOf: – #/definitions/enumSpecificBatchSituation 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: shipmentConfiguration: description: Configurações de Expedição type: object properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código da Configuração description: type: string description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situação requestDockWhenCreatingWave: type: boolean description: Solicitar Doca na Criação da Onda default: true enumOrderFIFOBy: type: string allOf: – #/definitions/enumOrderFIFOBy description: Ordenação de FIFO por allowsBufferSepWithStageStock: type: boolean description: Permite Separação de Pulmão em Buffer priorityPlaceTypeBufferSep: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Separação em Pulmão consumptionTypeStockBufferSep: type: string allOf: – #/definitions/enumConsumptionTypeStock description: Tipo de Palete para Separação de Pulmão allowsPickingSepInStageStock: type: boolean description: Permite Separação de Picking em Buffer priorityPlaceTypePickingSep: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Separação em Picking allowsReplenishWithStageStock: type: boolean description: Permite Reabastecer com Estoque de Buffer priorityPlaceTypeReplenish: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Reabastecimento consumptionTypeStockReplenish: type: string allOf: – #/definitions/enumConsumptionTypeStock description: Tipo de Palete para busca de estoque para reabastecimento de picking productVisualizationType: type: string allOf: – #/definitions/enumProductVisualizationType description: Parametro para permitir visualização dos produtos de saida tasksBySeparationZone: type: boolean description: Tarefas por Zona de Separação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editShipmentConfiguration: type: object required: – id allOf: – #/definitions/shipmentConfiguration shipmentConfigurationWarehouse: description: Vinculo da configuração de expedição com o armazém type: object required: – shipmentConfiguration – wmsWarehouse properties: id: type: string format: uuid description: Identificador único shipmentConfiguration: type: object allOf: – #/definitions/shipmentConfiguration description: Configuração de Expedição wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editShipmentConfigurationWarehouse: type: object required: – id allOf: – #/definitions/shipmentConfigurationWarehouse shipmentConfigurationOwner: description: Vinculo da configuração de expedição com o depositante type: object required: – shipmentConfiguration – wmsOwner properties: id: type: string format: uuid description: Identificador único shipmentConfiguration: type: object allOf: – #/definitions/shipmentConfiguration description: Configuração de Expedição 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: editShipmentConfigurationOwner: type: object required: – id allOf: – #/definitions/shipmentConfigurationOwner separationZone: description: Zona de Separação type: object properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém code: type: string description: Código description: type: string description: Descrição picking: type: boolean description: Picking bufferStock: type: boolean description: Pulmão buffer: type: boolean description: Buffer 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: outBoundDocumentType: description: Tipo de Documento de Expedição type: object required: – code properties: id: type: string format: uuid description: Identificador único code: type: string description: Código description: type: string description: Descrição needAuthorizeShipping: type: boolean description: Necessita autorização para expedir default: true 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: editOutBoundDocumentType: type: object required: – id allOf: – #/definitions/outBoundDocumentType outBoundDocumentTypeSector: description: Vinculo do tipo de documento de expedição com o setor type: object required: – outBoundDocumentType – sector – priorityLevel properties: id: type: string format: uuid description: Identificador único outBoundDocumentType: type: object allOf: – #/definitions/outBoundDocumentType description: Tipo de Documento de Expedição sector: type: object allOf: – #/definitions/sector description: Setor priorityLevel: type: integer format: int64 description: Nível de prioridade minimum: 1 maximum: 99 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundDocumentTypeSector: type: object required: – id allOf: – #/definitions/outBoundDocumentTypeSector outBoundDocumentTypeOwner: description: Vinculo do tipo de documento de expedição com o depositante type: object required: – outBoundDocumentType – wmsOwner properties: id: type: string format: uuid description: Identificador único outBoundDocumentType: type: object allOf: – #/definitions/outBoundDocumentType description: Tipo de Documento de Expedição 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: editOutBoundDocumentTypeOwner: type: object required: – id allOf: – #/definitions/outBoundDocumentTypeOwner shipmentConfigOutboundDocType: description: Vinculo da configuração de expedição com tipo de Documento de Expedição type: object required: – shipmentConfiguration – outBoundDocumentType properties: id: type: string format: uuid description: Identificador único shipmentConfiguration: type: object allOf: – #/definitions/shipmentConfiguration description: Configuração de Expedição outBoundDocumentType: type: object allOf: – #/definitions/outBoundDocumentType description: Tipo de Documento de Expedição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editShipmentConfigOutboundDocType: type: object required: – id allOf: – #/definitions/shipmentConfigOutboundDocType separationTaskQueryView: description: Busca para listar as tarefas de separação type: object required: – wave – identifier – situation – documentNumber – invoiceDate – outBoundSituation – separationZone – formatedAddress – quantity properties: id: type: integer format: int64 description: Identificador wave: type: string format: uuid description: Id da onda identifier: type: integer format: int64 description: Identificador da tarefa de separação situation: type: string allOf: – #/definitions/enumSeparationTaskSituation description: Situação da tarefa de separação documentNumber: type: string description: Número do documento invoiceNumber: type: string description: Número do documento de expedição invoiceSeries: type: string description: Serie do documento invoiceDate: type: string description: Data da emissão do documento de expedição shippingDate: type: string format: date-time description: Data de expedição outBoundSituation: type: string allOf: – #/definitions/enumOutBoundSituation description: Situação do pedido de expedição separationZone: type: string description: Zona de separação formatedAddress: type: string description: Endereço productCode: type: string description: Código do produto productDescription: type: string description: Descrição do produto productReferenceCode: type: string description: Código Referência do produto productCplDescription: type: string description: Descrição complementar do produto palletNumber: type: integer format: int64 description: Número do palete industrialBatch: type: string description: Lote indústria conversionFactor: type: number format: double description: Fator de Conversão quantity: type: number format: double description: Quantidade solicitada origin: type: string allOf: – #/definitions/enumBatchOrigin description: Origem do lote outBoundQueryView: description: Consulta para buscar as informações do pedido de expedição type: object required: – documentNumber – situation – outboundAuthorized – productSituation – wmsOwner – wmsOwnerName – wmsWarehouse – receiverName properties: id: type: string format: uuid description: Identificador único documentNumber: type: string description: Número do documento invoiceNumber: type: string description: Número do documento de expedição invoiceSeries: type: string description: Serie do documento situation: type: string allOf: – #/definitions/enumOutBoundSituation description: Situação outboundAuthorized: type: boolean description: Pedido autorizado productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto shippingDate: type: string format: date-time description: Data de embarque createdDate: type: string format: date-time description: Data de criação wmsOwner: type: string format: uuid description: Id do depositante wmsOwnerName: type: string description: Nome do depositante wmsOwnerCnpcpf: type: string description: CPF/CNPJ do depositante documentType: type: string format: uuid description: Tipo de documento documentTypeCode: type: string description: Codigo do tipo de documento documentTypeDescription: type: string description: Descrição do tipo de documento wmsWarehouse: type: string format: uuid description: Armazém receiverName: type: string description: Nome do destinátario receiverCnpcpf: type: string description: CPF/CNPJ do destinátario invoiceDate: type: string description: Data da emissão do documento de expedição wmsCarrying: type: string format: uuid description: ID da transportadora notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status linkOutBoundPickupFacade: description: Vincular Pedido à Coleta type: object required: – pickupId properties: id: type: string format: uuid description: Identificador único pickupId: type: string format: uuid description: Id do Setor outBoundIds: type: array items: type: string format: uuid description: Lista de Ids de pedidos a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids removidos importOutBoundDocumentFacadeInput: description: Importação Documento para Pedido de Expedição type: object required: – documentNumber – consignee properties: documentNumber: type: string description: Número de Pedido issuer: type: object allOf: – #/definitions/recShipmentPerson description: Emissor do Pedido de Expedição consignee: type: object allOf: – #/definitions/recShipmentPerson description: Destino do Pedido de Expedição receiver: type: object allOf: – #/definitions/recShipmentTo description: Destino da Entrega carrierCode: type: string description: Código da Transportadora outboundAuthorized: type: boolean description: Expedição Autorizada default: false invoice: type: object allOf: – #/definitions/recInvoice description: Dados nota Fiscal shippingDate: type: string format: date description: Data esperada do embarque comments: type: string description: Observações do Pedido / Nota Fiscal warehouseCode: type: string description: Código do Armazém para integração, opcional se for único para o usuário ownerCode: type: string description: Código do Depositante para integração, opcional se for único para o usuário items: type: array items: type: object allOf: – #/definitions/recOutboundItem description: Items do Documento productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto documentType: type: string description: Código do Tipo de Documento de expedição importOutBoundDocumentFacadeOutput: description: Importação Documento para Pedido de Expedição type: object required: – id properties: id: type: string maxLength: 36 description: Identificador único do registro criada/alterado. importOutBoundAuthorizationFacadeInput: description: Importação da autorização do Pedido de Expedição type: object required: – documentNumber – issuerCode properties: documentNumber: type: string description: Número de Pedido issuerCode: type: string description: Código Integração do Emissor do Pedido de Expedição referenceFields: type: array items: type: object allOf: – #/definitions/recOutboundReferenceFields description: Valores dos Campos de Referência para Autorização do Pedido de Expedição importOutBoundAuthorizationFacadeOutput: description: Importação da autorização do Pedido de Expedição type: object required: – id properties: id: type: string maxLength: 36 description: Identificador único do registro criada/alterado. integrateOutBoundFacade: description: Integrar Pedido de Expedição type: object required: – warehouseId – ownerId – receiverId – documentType – documentNumber properties: warehouseId: type: string description: Código do Armazém ownerId: type: string description: Código Depositante carrierId: type: string description: Código da Transportadora senderId: type: string description: Código do Remetente / Pessoa. Se não informado usa a pessoa do depositante receiverId: type: string description: Código do Destinatário / Pessoa receiverAdress: type: object allOf: – #/definitions/recAddress description: Endereço de Entrega documentType: type: string allOf: – #/definitions/enumOutBoundDocumentType description: Tipo do documento documentNumber: type: string description: Número de Pedido invoiceNumber: type: integer format: int64 description: Número da Nota Somente se DocumentType for Invoice invoiceSeries: type: integer format: int64 description: Serie da Nota issueDate: type: string format: date description: Data de Emissão do Outbound / Nota Fiscal invoiceAccessKey: type: string description: Chave da Nota Fiscal shippingDate: type: string format: date description: Data esperada do embarque comments: type: string description: Observações do Pedido / Nota Fiscal outboundItems: type: array items: type: object allOf: – #/definitions/recOutboundItem description: Lista correspondente aos produtos do pedido linkShipmentConfigurationOwnerFacade: description: Vincular Configuração de Expedição aos Depositantes type: object required: – shipmentConfigurationId properties: id: type: string format: uuid description: Identificador único shipmentConfigurationId: type: string format: uuid description: Id da Configuração de Expedição 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 linkShipmentConfigurationWarehouseFacade: description: Vincular Configuração de Expedição aos Armazéns type: object required: – shipmentConfigurationId properties: id: type: string format: uuid description: Identificador único shipmentConfigurationId: type: string format: uuid description: Id da Configuração de Expedição warehouseIds: type: array items: type: string format: uuid description: Lista de Ids de armazéns a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids removidos linkShipmentConfigurationDocTypeFacade: description: Vincular Configuração de Expedição aos Tipos de documentos de expedição type: object required: – shipmentConfigurationId properties: id: type: string format: uuid description: Identificador único shipmentConfigurationId: type: string format: uuid description: Id da Configuração de Expedição documentIds: type: array items: type: string format: uuid description: Lista de Ids de tipo de documento de expedição a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids removidos linkOutBoundDocumentTypeOwnerFacade: description: Vincular Tipo de Documento aos Depositantes type: object required: – outBoundDocumentTypeId properties: id: type: string format: uuid description: Identificador único outBoundDocumentTypeId: type: string format: uuid description: Id do Tipo de Documento 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 genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

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