2.0info: 1.6.1 Romaneio de cargas description: Romaneio de cargas x-senior-domain: Agronegócio x-senior-domain-path: agro x-senior-service-path: packing_list 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/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /packing_list/queries/healthcheck: post: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/queries/listProducers: post: description: Retorna a lista de produtores referente ao id de romaneio tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – packingListId properties: packingListId: type: string description: Id do romaneio responses: 200: description: Ok schema: type: object required: – producers properties: producers: type: array items: type: object allOf: – #/definitions/producer minimum: 1 description: Lista de produtores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de produtores referente ao id de romaneio tags: – Queries x-senior-visibility: PUBLIC parameters: – name: packingListId description: Id do romaneio in: query required: true type: string responses: 200: description: Ok schema: type: object required: – producers properties: producers: type: array items: type: object allOf: – #/definitions/producer minimum: 1 description: Lista de produtores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/queries/listClassifications: post: description: Retorna a lista de classificações referente ao id de romaneio tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – packingListId properties: packingListId: type: string description: Id do romaneio responses: 200: description: Ok schema: type: object required: – classifications properties: classifications: type: array items: type: object allOf: – #/definitions/classification minimum: 1 description: Lista de classificações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de classificações referente ao id de romaneio tags: – Queries x-senior-visibility: PUBLIC parameters: – name: packingListId description: Id do romaneio in: query required: true type: string responses: 200: description: Ok schema: type: object required: – classifications properties: classifications: type: array items: type: object allOf: – #/definitions/classification minimum: 1 description: Lista de classificações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/queries/listPackingListByUserProducer: post: description: Retorna a lista de romaneios por usuário produtor tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – userProducerId properties: userProducerId: type: string description: Id do usuário produtor responses: 200: description: Ok schema: type: object required: – packingLists properties: packingLists: type: array items: type: object allOf: – #/definitions/packingList minimum: 1 description: List de Romaneios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de romaneios por usuário produtor tags: – Queries x-senior-visibility: PUBLIC parameters: – name: userProducerId description: Id do usuário produtor in: query required: true type: string responses: 200: description: Ok schema: type: object required: – packingLists properties: packingLists: type: array items: type: object allOf: – #/definitions/packingList minimum: 1 description: List de Romaneios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/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 /packing_list/queries/exportPackingList: 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 /packing_list/queries/exportProducer: 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 /packing_list/queries/exportClassification: 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 /packing_list/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 /packing_list/actions/notifyInputOutputCargo: post: description: Cria as notificações de entrada e saída de carga e gera os logs referentes ao processo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – producerCpfCnpj – licensePlate – product – inputWeight – companyBranch – company – processType properties: producerCpfCnpj: type: string description: CPF CNPJ do produtor licensePlate: type: string description: Placa do caminhão product: type: string description: Produto da carga inputWeight: type: number format: double description: Peso de entrada na balança outputWeight: type: number format: double description: Peso de saída na balança companyBranch: type: string description: Nome da filial company: type: string description: Nome da Empresa inputDateTime: type: string format: date-time description: Data e hora da entrada na balança outputDateTime: type: string format: date-time description: Data e hora da saída na balança processType: type: string allOf: – #/definitions/cargoProcess description: Tipo do processo entrada/saída responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/actions/createOrUpdatePackingList: post: description: Primitiva para receber as informações do ticket.\n### Resources – res://senior.com.br/agro/packing_list/actions/createPackingList tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tickets properties: tickets: type: array items: type: object allOf: – #/definitions/packingListReceived minimum: 1 description: Lista das cotas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/actions/packingListUpdate: post: description: Primitiva para atualizar um packing list.\n### Resources – res://senior.com.br/agro/packing_list/entities/packingList tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – packingList properties: packingList: type: object allOf: – #/definitions/packingListReceived description: Packing List responses: 200: description: Ok schema: type: object required: – packingList properties: packingList: type: object allOf: – #/definitions/packingList description: Packing List atualizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/actions/deleteDatabaseRecords: post: description: Primitiva para deletar os registros da passe de um produtor\n### Resources – res://senior.com.br/agro/packing_list/actions/deleteDatabaseRecords tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – infoToDelete properties: infoToDelete: type: array items: type: object allOf: – #/definitions/infoToDelete minimum: 1 description: Lista das informações a serem excluidas da base de dados responses: 200: description: Ok schema: type: object required: – returnProducers properties: returnProducers: type: array items: type: object allOf: – #/definitions/deleteDatabaseRecordsResult minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/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 /packing_list/actions/importPackingList: 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 /packing_list/actions/importProducer: 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 /packing_list/actions/importClassification: 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 /packing_list/events/importPackingListEvent: 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 /packing_list/events/exportPackingListEvent: 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 /packing_list/events/importProducerEvent: 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 /packing_list/events/exportProducerEvent: 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 /packing_list/events/importClassificationEvent: 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 /packing_list/events/exportClassificationEvent: 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 /packing_list/entities/packingList: 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/packingList responses: 200: description: The created resource schema: #/definitions/packingList 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/packingList responses: 200: description: The created resource schema: #/definitions/packingList 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/packingList 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/packingList/{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/packingList responses: 200: description: Ok schema: #/definitions/packingList 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/packingList responses: 200: description: Ok schema: #/definitions/packingList 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/packingList 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 /packing_list/entities/packingList/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/packingList responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/producer: 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/producer responses: 200: description: The created resource schema: #/definitions/producer 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/producer responses: 200: description: The created resource schema: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/producer/{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/producer responses: 200: description: Ok schema: #/definitions/producer 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/producer responses: 200: description: Ok schema: #/definitions/producer 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/producer 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 /packing_list/entities/packingList/{parentId}/producers: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/producer responses: 200: description: The created resources schema: type: array items: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/producer responses: 200: description: The created resources schema: type: array items: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/packingList/{parentId}/producers/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/producer responses: 200: description: Ok schema: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/producer responses: 200: description: Ok schema: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/producer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/producer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/producer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/classification: 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/classification responses: 200: description: The created resource schema: #/definitions/classification 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/classification responses: 200: description: The created resource schema: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/classification/{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/classification responses: 200: description: Ok schema: #/definitions/classification 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/classification responses: 200: description: Ok schema: #/definitions/classification 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/classification 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 /packing_list/entities/packingList/{parentId}/classifications: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/classification responses: 200: description: The created resources schema: type: array items: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/classification responses: 200: description: The created resources schema: type: array items: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/packingList/{parentId}/classifications/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/classification responses: 200: description: Ok schema: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/classification responses: 200: description: Ok schema: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/classification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /packing_list/entities/classification/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/classification responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: cargoProcess: description: Entrada ou saída de carga type: string enum: – CARGO_INPUT – CARGO_OUTPUT documentStatus: description: Status do documento type: string enum: – ACTIVE – INACTIVE upDown: description: Up or down type: string enum: – UP – DOWN sendNotification: description: Enviar notificação type: string enum: – YES – NO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck packingListReceived: description: DTO de Entrada de dados relacionados aos tickets type: object required: – status – inputDate – inputTime properties: status: type: string allOf: – #/definitions/documentStatus description: Status do romaneio singleRecordKey: type: string description: Id do Romaneio company: type: string maxLength: 255 description: Nome da Empresa subsidiary: type: string maxLength: 255 description: Filial address: type: string maxLength: 255 description: Endereço warehouseDescription: type: string maxLength: 100 description: Descrição do depósito inputDate: type: string format: date description: Data de entrada inputTime: type: string description: Hora de entrada outputDate: type: string format: date description: Data da saída outputTime: type: string description: Hora da saída harvest: type: string description: Safra harvestPeriod: type: integer format: int64 description: Período inicial da safra packingListNumber: type: integer format: int64 description: Número do Romaneio operation: type: string description: Operação licensePlate: type: string maxLength: 10 description: Placa do veículo driver: type: string maxLength: 255 description: Motorista product: type: string maxLength: 255 description: Produto measurementUnit: type: string description: Unidade de Medida inputWeight: type: number format: double description: Peso Entrada outputWeight: type: number format: double description: Peso Saída totalDiscounted: type: number format: double description: Total Descontado netWeight: type: number format: double description: Peso Líquido sendNotification: type: string allOf: – #/definitions/sendNotification description: Enviar Notificação producers: type: array items: type: object allOf: – #/definitions/producerReceived description: Lista de produtores classifications: type: array items: type: object allOf: – #/definitions/classificationReceived description: Lista de Classificações producerReceived: description: DTO de Entidade Produtor type: object required: – cpfCnpj properties: name: type: string description: Nome do produtor cpfCnpj: type: string description: CpfCnpj originAddress: type: string maxLength: 255 description: Endereço de Origem stateRegistration: type: string description: Inscrição Estadual participationPercentage: type: number format: double description: Percentual de Participação amountInParticipation: type: number format: double description: Quantidade Participação invoiceSeries: type: string description: Série NF invoiceNumber: type: integer format: int64 description: Nota Produtor contractNumber: type: integer format: int64 description: Número contrato classificationReceived: description: DTO de Entidade Classificação type: object properties: description: type: string description: Descrição do item samplingWeight: type: number format: double description: Peso Amostra reportedPercentage: type: number format: double description: % informado discountedPercentage: type: number format: double description: % Descontado discountedWeight: type: number format: double description: Peso Descontado infoToDelete: description: Informações sobre CPF que devem ser excluidos da base de dados type: object required: – cnpjCpf properties: cnpjCpf: type: string description: cnpjCpf deleteDatabaseRecordsResult: description: Informações referente ao retorno da requisição de deletar registros do banco por cpfCnpj type: object required: – cpfCnpj – status – messageError properties: cpfCnpj: type: string description: CPF/CNPJ referente a excluir os registros status: type: string description: Status referente a excluir os dados deste CPF/CNPJ messageError: type: string description: Mensagem de erro referente a excluir os dados deste CPF/CNPJ packingList: description: Entidade de Romaneio type: object required: – status – inputDate – inputTime properties: id: type: string format: uuid description: Id do Romaneio status: type: string allOf: – #/definitions/documentStatus description: Status do romaneio singleRecordKey: type: string description: Chave única recebida por integração company: type: string maxLength: 255 description: Nome da Empresa subsidiary: type: string maxLength: 255 description: Filial address: type: string maxLength: 255 description: Endereço warehouseDescription: type: string maxLength: 100 description: Descrição do depósito inputDate: type: string format: date description: Data de entrada inputTime: type: string description: Hora de entrada outputDate: type: string format: date description: Data da saída outputTime: type: string description: Hora da saída harvest: type: string description: Safra harvestPeriod: type: integer format: int64 description: Período inicial da safra packingListNumber: type: integer format: int64 description: Número do Romaneio operation: type: string description: Operação licensePlate: type: string maxLength: 10 description: Placa do veículo driver: type: string maxLength: 255 description: Motorista product: type: string maxLength: 255 description: Produto measurementUnit: type: string maxLength: 255 description: Unidade de Medida inputWeight: type: number format: double description: Peso Entrada outputWeight: type: number format: double description: Peso Saída totalDiscounted: type: number format: double description: Total Descontado netWeight: type: number format: double description: Peso Líquido producers: type: array items: type: object allOf: – #/definitions/producer description: Lista de produtores classifications: type: array items: type: object allOf: – #/definitions/classification description: Lista de Classificações createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: producer: description: Entidade Produtor type: object required: – cpfCnpj properties: id: type: string format: uuid description: Id do Produtor cpfCnpj: type: string description: CpfCnpj name: type: string description: Nome do produtor originAddress: type: string maxLength: 255 description: Endereço de Origem stateRegistration: type: string description: Inscrição Estadual participationPercentage: type: number format: double description: Percentual de Participação amountInParticipation: type: number format: double description: Quantidade Participação invoiceSeries: type: string description: Série NF invoiceNumber: type: integer format: int64 description: Nota Produtor contractNumber: type: integer format: int64 description: Número contrato packingList: type: object allOf: – #/definitions/packingList description: Romaneio createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: classification: description: Entidade Classificação type: object properties: id: type: string format: uuid description: Id da Classificação description: type: string description: Descrição do item samplingWeight: type: number format: double description: Peso Amostra reportedPercentage: type: number format: double description: % informado discountedPercentage: type: number format: double description: % Descontado discountedWeight: type: number format: double description: Peso Descontado packingList: type: object allOf: – #/definitions/packingList description: Romaneio 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 genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE