WMS-X Receiving Checkin (checkin)

2.0info: 1.6.1 WMS-X Receiving Checkin description: Serviço Responsável pela conferência e suas operações no recebimento do WMS-X x-senior-domain: Recebimento WMS-X x-senior-domain-path: wmsx_receiving x-senior-service-path: checkin 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_receivingsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/queries/exportReceivingType: 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 /checkin/queries/exportOrderReceiving: 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 /checkin/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 /checkin/queries/exportReceivingDocument: 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 /checkin/queries/exportReceivingDocumentItem: 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 /checkin/queries/exportWmsVendor: 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 /checkin/queries/exportCheckin: 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 /checkin/queries/exportCheckinItem: 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 /checkin/queries/exportCheckinOccurrence: 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 /checkin/queries/exportCheckinResume: 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 /checkin/queries/exportReasonOccurrence: 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 /checkin/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 /checkin/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 /checkin/actions/startCheckinByOrderReceivingNumber: post: description: Iniciar um nova conferência ou retormar conferência em andamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingNumber properties: orderReceivingNumber: type: integer format: int64 description: Número da Ordem de Recebimento responses: 200: description: Ok schema: type: object required: – checkin properties: checkin: type: object allOf: – #/definitions/recCheckin description: Conferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/actions/registerCheckin: post: description: Registrar conferência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checkinItems properties: checkinItems: type: array items: type: object allOf: – #/definitions/recCheckinItem minimum: 1 description: Itens/Produtos conferidos responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/actions/generateCheckin: post: description: Gerar Conferência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId properties: orderReceivingId: type: string description: Id da Ordem de Recebimento responses: 200: description: Ok schema: type: object required: – message – success properties: message: type: string description: Mensagem success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/actions/endAllCheckin: post: description: Finalizar todas as Conferências tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingNumber properties: orderReceivingNumber: type: integer format: int64 description: Número da Ordem de Recebimento responses: 200: description: Ok schema: type: object required: – message – hasDivergence – productsWithDivergence properties: message: type: string description: Mensagem hasDivergence: type: boolean description: Finalizada com divergência productsWithDivergence: type: array items: type: object allOf: – #/definitions/productOwner minimum: 1 description: Produtos conferidos com divergência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/actions/ignoreCheckinItem: post: description: Ignorar contagem tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId – checkinItemIds properties: orderReceivingId: type: string description: Id da Ordem de Recebimento checkinItemIds: type: array items: type: string minimum: 1 description: Lista de Ids das contagens a serem ignoradas responses: 200: description: Ok schema: type: object required: – message – success properties: message: type: string description: Mensagem success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/actions/releaseOrderReceivingWithDivergence: post: description: Liberar Ordem de Recebimento com divergência de conferência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId – releaseReason – reasonOccurrenceId properties: orderReceivingId: type: string description: Id da Ordem de Recebimento releaseReason: type: string description: Motivo da Liberação reasonOccurrenceId: type: string description: Motivo de Ocorrência da divergência responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/actions/importReceivingType: 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 /checkin/actions/importOrderReceiving: 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 /checkin/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 /checkin/actions/importReceivingDocument: 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 /checkin/actions/importReceivingDocumentItem: 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 /checkin/actions/importWmsVendor: 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 /checkin/actions/importCheckin: 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 /checkin/actions/importCheckinItem: 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 /checkin/actions/importCheckinOccurrence: 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 /checkin/actions/importCheckinResume: 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 /checkin/actions/importReasonOccurrence: 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 /checkin/events/exportReceivingConfirmation: post: description: Evento de confirmação de Recebimento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/receivingConfirmationPayload responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/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 /checkin/events/importReceivingTypeEvent: 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 /checkin/events/exportReceivingTypeEvent: 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 /checkin/events/importOrderReceivingEvent: 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 /checkin/events/exportOrderReceivingEvent: 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 /checkin/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 /checkin/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 /checkin/events/importReceivingDocumentEvent: 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 /checkin/events/exportReceivingDocumentEvent: 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 /checkin/events/importReceivingDocumentItemEvent: 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 /checkin/events/exportReceivingDocumentItemEvent: 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 /checkin/events/importWmsVendorEvent: 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 /checkin/events/exportWmsVendorEvent: 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 /checkin/events/importCheckinEvent: 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 /checkin/events/exportCheckinEvent: 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 /checkin/events/importCheckinItemEvent: 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 /checkin/events/exportCheckinItemEvent: 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 /checkin/events/importCheckinOccurrenceEvent: 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 /checkin/events/exportCheckinOccurrenceEvent: 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 /checkin/events/importCheckinResumeEvent: 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 /checkin/events/exportCheckinResumeEvent: 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 /checkin/events/importReasonOccurrenceEvent: 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 /checkin/events/exportReasonOccurrenceEvent: 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 /checkin/entities/receivingType: 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/receivingType responses: 200: description: The created resource schema: #/definitions/receivingType 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/receivingType responses: 200: description: The created resource schema: #/definitions/receivingType 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/receivingType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/receivingType/{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/editReceivingType responses: 200: description: Ok schema: #/definitions/editReceivingType 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/receivingType responses: 200: description: Ok schema: #/definitions/receivingType 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/receivingType 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 /checkin/entities/receivingType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivingType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/orderReceiving: 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/orderReceiving responses: 200: description: The created resource schema: #/definitions/orderReceiving 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/orderReceiving responses: 200: description: The created resource schema: #/definitions/orderReceiving 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/orderReceiving 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/orderReceiving/{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/editOrderReceiving responses: 200: description: Ok schema: #/definitions/editOrderReceiving 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/orderReceiving responses: 200: description: Ok schema: #/definitions/orderReceiving 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/orderReceiving 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 /checkin/entities/orderReceiving/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/orderReceiving responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/receivingDocument: 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/receivingDocument responses: 200: description: The created resource schema: #/definitions/receivingDocument 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/receivingDocument responses: 200: description: The created resource schema: #/definitions/receivingDocument 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/receivingDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/receivingDocument/{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/editReceivingDocument responses: 200: description: Ok schema: #/definitions/editReceivingDocument 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/receivingDocument responses: 200: description: Ok schema: #/definitions/receivingDocument 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/receivingDocument 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 /checkin/entities/receivingDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivingDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/receivingDocumentItem: 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/receivingDocumentItem responses: 200: description: The created resource schema: #/definitions/receivingDocumentItem 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/receivingDocumentItem responses: 200: description: The created resource schema: #/definitions/receivingDocumentItem 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/receivingDocumentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/receivingDocumentItem/{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/editReceivingDocumentItem responses: 200: description: Ok schema: #/definitions/editReceivingDocumentItem 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/receivingDocumentItem responses: 200: description: Ok schema: #/definitions/receivingDocumentItem 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/receivingDocumentItem 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 /checkin/entities/receivingDocumentItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivingDocumentItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkin: 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/checkin responses: 200: description: The created resource schema: #/definitions/checkin 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/checkin responses: 200: description: The created resource schema: #/definitions/checkin 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/checkin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkin/{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/editCheckin responses: 200: description: Ok schema: #/definitions/editCheckin 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/checkin responses: 200: description: Ok schema: #/definitions/checkin 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/checkin 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 /checkin/entities/checkin/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checkin responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkinItem: 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/checkinItem responses: 200: description: The created resource schema: #/definitions/checkinItem 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/checkinItem responses: 200: description: The created resource schema: #/definitions/checkinItem 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/checkinItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkinItem/{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/editCheckinItem responses: 200: description: Ok schema: #/definitions/editCheckinItem 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/checkinItem responses: 200: description: Ok schema: #/definitions/checkinItem 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/checkinItem 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 /checkin/entities/checkinItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checkinItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkinOccurrence: 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/checkinOccurrence responses: 200: description: The created resource schema: #/definitions/checkinOccurrence 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/checkinOccurrence responses: 200: description: The created resource schema: #/definitions/checkinOccurrence 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/checkinOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkinOccurrence/{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/editCheckinOccurrence responses: 200: description: Ok schema: #/definitions/editCheckinOccurrence 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/checkinOccurrence responses: 200: description: Ok schema: #/definitions/checkinOccurrence 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/checkinOccurrence 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 /checkin/entities/checkinOccurrence/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checkinOccurrence responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkinResume: 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/checkinResume responses: 200: description: The created resource schema: #/definitions/checkinResume 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/checkinResume responses: 200: description: The created resource schema: #/definitions/checkinResume 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/checkinResume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/checkinResume/{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/editCheckinResume responses: 200: description: Ok schema: #/definitions/editCheckinResume 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/checkinResume responses: 200: description: Ok schema: #/definitions/checkinResume 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/checkinResume 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 /checkin/entities/checkinResume/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checkinResume responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/reasonOccurrence: 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/reasonOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /checkin/entities/reasonOccurrence/{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/reasonOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumSitReg: type: string enum: – VA – VI description: Situação do registro: * `VA` – Ativo * `VI` – Inativo 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) 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 enumCheckinItemSituation: type: string enum: – NOT_RELEASED – RELEASED – IGNORED description: Situação do Item da Conferência: * `NOT_RELEASED` – Não Liberada * `RELEASED` – Liberada * `IGNORED` – Ignorada enumProductSituation: type: string enum: – GOOD – DAMAGED – EXPIRED – TRUNCATED description: Situação do Produto: * `GOOD` – Bom * `DAMAGED` – Danificado * `EXPIRED` – Vencido * `TRUNCATED` – Truncado enumOrderReceivingSituation: type: string enum: – CREATED – CHECKIN_IN_PROGRESS – CHECKIN_COMPLETED – CHECKIN_COMPLETED_WITH_DIVERGENCE – GENERATED_BATCH – AWAITING_ALLOCATION – COMPLETED_ALLOCATION – CANCELED description: Situação da Ordem de Recebimento: * `CREATED` – Criada * `CHECKIN_IN_PROGRESS` – Em Conferência * `CHECKIN_COMPLETED` – Conferência Concluída * `CHECKIN_COMPLETED_WITH_DIVERGENCE` – Conferência Concluída com Divergência * `GENERATED_BATCH` – Lote Gerado * `AWAITING_ALLOCATION` – Aguardando Alocação * `COMPLETED_ALLOCATION` – Alocação Concluída * `CANCELED` – Cancelada enumCheckinSituation: type: string enum: – IN_PROGRESS – COMPLETED description: Situação da Conferência: * `IN_PROGRESS` – Em andamento * `COMPLETED` – Finalizada enumTypeTerm: type: string enum: – VM – VD description: Tipo de prazo: * `VM` – Meses * `VD` – Dias 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 enumDocumentSituation: type: string enum: – CREATED – IN_ORDER_RECEIVING – CANCELED description: Situação do Documento de Entrada: * `CREATED` – Criado * `IN_ORDER_RECEIVING` – Em Ordem de Recebimento * `CANCELED` – Cancelado enunCheckinTypeOccurrence: type: string enum: – SUCCESS – ERROR_ITEM_NOT_ON_INVOICE – ERROR_ITEM_EXTRA – ERROR_ITEM_LESS – ERROR_ITEM_ON_INVOICE_NOT_ON_OR – ERROR_SPECIFIC_INFO_NOT_CHECKED – ERROR_NOT_RECEIVED_BY_BLACKLIST – ERROR_ITEM_ON_OR_NOT_CHECKED – WARNING description: Tipos de Ocorrências da Conferência: * `SUCCESS` – Conferido de acordo com a Ordem de Recebimento * `ERROR_ITEM_NOT_ON_INVOICE` – Conferido no recebimento, porém não presente em nota fiscal * `ERROR_ITEM_EXTRA` – Quantidade conferida maior do que o previsto na Ordem de Recebimento * `ERROR_ITEM_LESS` – Quantidade conferida menor do que o previsto na Ordem de Recebimento * `ERROR_ITEM_ON_INVOICE_NOT_ON_OR` – Produto informado na conferência, mas não está presente na Ordem de Recebimento * `ERROR_SPECIFIC_INFO_NOT_CHECKED` – Informação especifica não conferida * `ERROR_NOT_RECEIVED_BY_BLACKLIST` – Não recebido de acordo com backlist * `ERROR_ITEM_ON_OR_NOT_CHECKED` – Produto informado na Ordem de Recebimento, porém não conferido no recebimento * `WARNING` – Alerta de ocorrência na conferência enumQuantityCheckinType: type: string enum: – QUANTITY – BALLAST_AND_LAYER description: Tipo de Conferência: * `QUANTITY` – Quantidade * `BALLAST_AND_LAYER` – Lastro e Camada enumReceivingBlockRule: type: string enum: – ALLOW – BLOCK_ON_CHECKIN – BLOCK_ON_CHECKIN_RELEASE description: Regra de bloqueio de recebimento: * `ALLOW` – Permite o recebimento * `BLOCK_ON_CHECKIN` – Bloqueia na conferência * `BLOCK_ON_CHECKIN_RELEASE` – Bloqueia na liberação da conferência enumTransportModel: type: string enum: – ROAD – RAILWAY – AIR description: Modelo de Trasnsporte: * `ROAD` – Rodoviário * `RAILWAY` – Ferroviário * `AIR` – Aéreo 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 recCheckin: description: Conferência – Record type: object required: – id – number – orderReceivingNumber – ownerId – ownerName – quantityCheckinType properties: id: type: string description: Id da conferência number: type: integer format: int64 description: Número da conferência orderReceivingNumber: type: integer format: int64 description: Número da orderm de recebimento ownerId: type: string description: Id do depositante ownerName: type: string description: Nome do depositante quantityCheckinType: type: string allOf: – #/definitions/enumQuantityCheckinType description: Tipo de Conferência recCheckinItem: description: Conferência Item – Record type: object required: – checkinId – productOwnerId – packingId – productSituation properties: checkinId: type: string description: Id da conferência productOwnerId: type: string description: Id do Produto depositante packingId: type: string description: Id da Embalagem quantity: type: number format: double description: Quantidade ballast: type: integer format: int64 description: Lastro layer: type: integer format: int64 description: Camada incompleteLayer: type: integer format: int64 description: Camada incompleta productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento recResumeProductsOr: description: Resumo dos produtos da OR – Record type: object required: – orderReceivingId – productOwnerId – packingId – goodQuantity – damagedQuantity – expiredQuantity – truncatedQuantity properties: orderReceivingId: type: string description: Id da Ordem de Recebimento productOwnerId: type: string description: Id do Produto/Depositante packingId: type: string description: Id da Embalagem goodQuantity: type: number format: double description: Quantidade Boa damagedQuantity: type: number format: double description: Quantidade Danificada expiredQuantity: type: number format: double description: Quantidade Vencida truncatedQuantity: type: number format: double description: Quantidade Truncada recResumeProductsOrderReceiving: description: Resumo dos produtos da OR agrupados por produto depositante e situação do produto – Record type: object required: – orderReceivingId – productOwnerId – code – description – productSituation – unitQuantity – hasCheckin properties: orderReceivingId: type: string description: Id da Ordem de Recebimento productOwnerId: type: string description: Id do Produto Depositante code: type: string description: Código do produto description: type: string description: Descrição do produto productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto unitQuantity: type: number format: double description: Quantidade unitária hasCheckin: type: integer format: int64 description: Existe conferência para o item da Ordem de Recebimento recResumeProductsCheckin: description: Produtos conferidos por situação – Record type: object required: – orderReceivingId – productOwnerId – code – description – productSituation – unitQuantity – goodUnitQuantity – damagedUnitQuantity – expiredUnitQuantity – truncatedUnitQuantity – existsInOrderReceiving properties: orderReceivingId: type: string description: Id da Ordem de Recebimento productOwnerId: type: string description: Id do Produto Depositante code: type: string description: Código do produto description: type: string description: Descrição do produto productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto unitQuantity: type: number format: double description: Quantidade unitária goodUnitQuantity: type: number format: double description: Quantidade Unitária Boa damagedUnitQuantity: type: number format: double description: Quantidade Unitária Danificada expiredUnitQuantity: type: number format: double description: Quantidade Unitária Vencida truncatedUnitQuantity: type: number format: double description: Quantidade Unitária Truncada existsInOrderReceiving: type: integer format: int64 description: Produto informado na Ordem de Recebimento recResultCheckinsFinished: description: Resultado das conferências finalizadas – Record type: object required: – hasDivergence – productsWithDivergence properties: hasDivergence: type: boolean description: Finalizadas com divergência productsWithDivergence: type: array items: type: object allOf: – #/definitions/productOwner minimum: 1 description: Produtos conferidos com divergência receivingConfirmationPayload: description: Payload da confirmação de recebimento type: object required: – orderReceivingId – orderReceivingNumber – ownerId – ownerCode – warehouseId – warehouseCode – registrationDate – receivedDate properties: orderReceivingId: type: string description: Id da Ordem de Recebimento orderReceivingNumber: type: integer format: int64 description: Número da Ordem de Recebimento ownerId: type: string description: Id do depositante ownerCode: type: string description: Código de Integração do depositante warehouseId: type: string description: Código do Armazém warehouseCode: type: string description: Código de Integração do Armazém registrationDate: type: string format: date-time description: Data que a ordem de recebimento foi cadastrada receivedDate: type: string format: date description: Data que a ordem de recebimento foi conferida carrierId: type: string description: ID da Transportadora carrierCode: type: string description: Código de Integração da Transportadora licensePlate: type: string description: Identificação do veículo utilizado na ordem de recebimento transportType: type: string allOf: – #/definitions/enumTransportModel description: Identificação do tipo de transporte (ROAD/ RAILWAY/ AIR) documents: type: array items: type: object allOf: – #/definitions/documentChecked description: Documentos da Order Recebimento documentChecked: description: Documento Conferido type: object required: – documentNumber – vendorId – vendorCode properties: documentNumber: type: string description: Número do Documento expected: type: boolean description: Indica se é um documento previsto na ordem de recebimento default: true vendorId: type: string description: ID do Fornecedor vendorCode: type: string description: Código de Integração do Fornecedor documentSeries: type: string description: Serie da Nota accessKey: type: string description: Chave da Nota displayDescription: type: string maxLength: 255 description: Rótulo para exibição amigável do documento sourceDocumentType: type: string maxLength: 50 description: Classificação do tipo de documento conforme definido pelo sistema de origem items: type: array items: type: object allOf: – #/definitions/itemChecked description: Items Checados itemChecked: description: type: object required: – productId – productCode – packagingBarCode – expectedQuantity – receivedQuantity properties: itemNumber: type: integer format: int64 description: Número do item productId: type: string description: ID do Produto productCode: type: string description: Código do Produto packagingBarCode: type: string description: Código da Embalagem uom: type: string description: Unidade de Medida expectedQuantity: type: number format: double description: Quantidade Esperada receivedQuantity: type: number format: double description: Quantidade Recebida details: type: array items: type: object allOf: – #/definitions/itemCheckedDetails description: Detalhamento dos items itemCheckedDetails: description: Item Conferido type: object required: – productSituation – quantity – grossWeight – netWeight – sectorId – sectorCode properties: productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto quantity: type: number format: double description: Quantidade grossWeight: type: number format: double description: Peso Bruto da embalagem em gramas multiplicado pela quantidade da linha netWeight: type: number format: double description: Peso Líquido da embalagem em gramas multiplicado pela quantidade da linha industryBatch: type: string description: Lote industria fabricationDate: type: string format: date description: Data de Fabricação expirationDate: type: string format: date description: Data de Vencimento sectorId: type: string description: ID do Setor sectorCode: type: string description: Código de integração do Setor wmsWarehouse: description: Armazém type: object required: – warehouseSituation 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 required: – ownerSituation 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 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: 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 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 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: receivingType: description: Tipo de Recebimento type: object required: – description – supervisorAuthDivergence – situation – maxCheckIn – receivingBufferAllocation – quantityCheckinType – allowOverReceiving – allowUnderReceiving – allowUnexpectedProduct properties: id: type: string format: uuid description: Id description: type: string description: Descrição supervisorAuthDivergence: type: boolean description: Apenas o supervisor pode liberar contagens divergentes situation: type: string allOf: – #/definitions/enumSitReg description: Situação maxCheckIn: type: integer format: int64 description: Máximo de Conferência de Entrada receivingBufferAllocation: type: boolean description: Alocação em buffer de recebimento quantityCheckinType: type: string allOf: – #/definitions/enumQuantityCheckinType description: Tipo de Conferência allowOverReceiving: type: string allOf: – #/definitions/enumReceivingBlockRule description: Permite recebimento a maior allowUnderReceiving: type: string allOf: – #/definitions/enumReceivingBlockRule description: Permite recebimento a menor allowUnexpectedProduct: type: string allOf: – #/definitions/enumReceivingBlockRule description: Permite recebimento de produto não esperado startWorkflowProcessAfterConfirmation: type: boolean description: Iniciar um Fluxo de Processo BPM após confirmação do recebimento workflowProcessId: type: integer format: int64 description: Identificação do Fluxo BPM workflowRequestTitle: type: string maxLength: 255 description: Título da Solicitação Processo Workflow createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReceivingType: type: object required: – id allOf: – #/definitions/receivingType orderReceiving: description: Ordem de Recebimento type: object required: – wmsWarehouse – receivingType – receivingDate – situation – wmsOwner – violatedProduct – openProduct – brokenProduct properties: id: type: string format: uuid description: Identificador único number: type: integer format: int64 description: Número da OR wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém receivingType: type: object allOf: – #/definitions/receivingType description: Tipo de recebimento receivingDate: type: string format: date description: Data de recebimento situation: type: string allOf: – #/definitions/enumOrderReceivingSituation description: Situação wmsCarrying: type: object allOf: – #/definitions/wmsCarrying description: Transportadora wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante licensePlate: type: string description: Placa modal: type: string allOf: – #/definitions/enumTransportModel description: Modal de transporte observation: type: string maxLength: 500 description: Observação violatedProduct: type: boolean description: Produto violado openProduct: type: boolean description: Produto aberto brokenProduct: type: boolean description: Produto quebrado hasDivergence: type: boolean description: Existe divergência na conferência releasedWithDivergenceBy: type: string description: Liberado por releasedWithDivergenceDate: type: string format: date-time description: Liberado em exportConfirmationOrderReceiving: type: boolean description: Confirmação de exportação da ordem de recebimento exportConfirmationOrderReceivingDate: type: string format: date-time description: Data de confirmação da exportação da ordem de recebimento releaseReason: type: string maxLength: 255 description: Motivo liberação com Divergencia reasonOccurrence: type: object allOf: – #/definitions/reasonOccurrence description: Motivo de Ocorrência da divergência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOrderReceiving: type: object required: – id allOf: – #/definitions/orderReceiving wmsCarrying: description: Transportadora type: object required: – sitTra 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: receivingDocument: description: Documento de Entrada type: object required: – number – documentDate – situation – productSituation – wmsVendor properties: id: type: string format: uuid description: Identificador único orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento number: type: string description: Número sequence: type: string description: Sequência documentDate: type: string format: date description: Data situation: type: string allOf: – #/definitions/enumDocumentSituation description: Situação productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto wmsVendor: type: object allOf: – #/definitions/wmsVendor description: Fornecedor accessKey: type: string description: Chave da Nota Fiscal displayDescription: type: string maxLength: 255 description: Rótulo para exibição amigável do documento sourceDocumentType: type: string maxLength: 50 description: Classificação do tipo de documento conforme definido pelo sistema de origem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReceivingDocument: type: object required: – id allOf: – #/definitions/receivingDocument receivingDocumentItem: description: Item do Documento de Entrada type: object required: – item – productOwner – packing – quantity properties: id: type: string format: uuid description: Identificador único receivingDocument: type: object allOf: – #/definitions/receivingDocument description: Documento de Entrada item: 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: integer format: int64 description: Quantidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReceivingDocumentItem: type: object required: – id allOf: – #/definitions/receivingDocumentItem wmsVendor: description: Fornecedor type: object required: – sitFor properties: id: type: string format: uuid description: Identificador único sitFor: type: string allOf: – #/definitions/enumSitReg description: Situação do fornecedor 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: checkin: description: Conferência do Documento de Entrada type: object required: – orderReceiving – situation properties: id: type: string format: uuid description: Identificador único number: type: integer format: int64 description: Número da Conferência orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento situation: type: string allOf: – #/definitions/enumCheckinSituation 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: editCheckin: type: object required: – id allOf: – #/definitions/checkin checkinItem: description: Conferência do item do Documento de Entrada type: object required: – checkin – productOwner – packing – quantity – productSituation – situation properties: id: type: string format: uuid description: Identificador único checkin: type: object allOf: – #/definitions/checkin description: Conferência do Documento de Entrada productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem quantity: type: number format: double description: Quantidade ballast: type: integer format: int64 description: Lastro layer: type: integer format: int64 description: Camada incompleteLayer: type: integer format: int64 description: Camada incompleta productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto situation: type: string allOf: – #/definitions/enumCheckinItemSituation description: Situação industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento ignoredBy: type: string description: Usuário que ignorou ignoredDate: type: string format: date-time description: Data que ignorou createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCheckinItem: type: object required: – id allOf: – #/definitions/checkinItem checkinOccurrence: description: Ocorrências na Conferência type: object required: – orderReceiving – occurenceType properties: id: type: string format: uuid description: Identificador único orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento occurenceType: type: string allOf: – #/definitions/enunCheckinTypeOccurrence description: Tipo de ocorrência info: type: string maxLength: 500 description: Informação complementar createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCheckinOccurrence: type: object required: – id allOf: – #/definitions/checkinOccurrence checkinResume: description: Resumo da Conferência type: object required: – orderReceiving – productOwner – goodQuantity – damagedQuantity – expiredQuantity – truncatedQuantity properties: id: type: string format: uuid description: Identificador único orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante goodQuantity: type: number format: double description: Quantidade Boa damagedQuantity: type: number format: double description: Quantidade Danificada expiredQuantity: type: number format: double description: Quantidade Vencida truncatedQuantity: type: number format: double description: Quantidade Truncada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCheckinResume: type: object required: – id allOf: – #/definitions/checkinResume reasonOccurrence: description: Motivo de Ocorrência – Replicação type: object required: – inventory properties: id: type: string format: uuid description: Identificador único code: type: string description: Código description: type: string description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situação batchUnlock: type: boolean description: Desbloqueio de lote batchBlocking: type: boolean description: Bloqueio de lote physicalCut: type: boolean description: Corte físico stockEntryCorrection: type: boolean description: Ajuste de movimentação de entrada stockOutCorrection: type: boolean description: Ajuste de movimentação de saída materialStateCorrection: type: boolean description: Ajuste de estado de material releaseConferenceWithDivergence: type: boolean description: Liberação de conferência com divergência inventory: type: boolean description: Controle de Inventário 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: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string 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