wms_custom

Inventário (inventory)

12 views 05/07/2021 10/09/2021 integrador 0

2.0info: 1.1.2 Inventário description: Eventos e Pontos de Extensão do WMS – Inventário x-senior-domain: Camada de Customização do WMS x-senior-domain-path: wms_custom x-senior-service-path: inventory contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/wms_customsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /inventory/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: 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: default: description: Error response schema: #/definitions/genericError /inventory/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /inventory/actions/createInventory: post: description: Cadastro de Inventário THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idInventario – armazem – usuario – data – tipo properties: idInventario: type: integer format: int64 description: Id. Inventário armazem: type: object allOf: #/definitions/entidade description: Armazem usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data tipo: type: string allOf: – #/definitions/inventoryType description: Tipo do Inventário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /inventory/actions/updateStock: post: description: Atualziar Estoque THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idInventario – armazem – usuario – data – valor properties: idInventario: type: integer format: int64 description: Id. Inventário armazem: type: object allOf: #/definitions/entidade description: Armazem usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data valor: type: number format: double description: Valor Divergência responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /inventory/actions/blockCount: post: description: Bloquear Contagem THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idInventario – armazem – usuario – data properties: idInventario: type: integer format: int64 description: Id. Inventário armazem: type: object allOf: #/definitions/entidade description: Armazem usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /inventory/actions/liberateCount: post: description: Liberar Contagem THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idInventario – armazem – usuario – data properties: idInventario: type: integer format: int64 description: Id. Inventário armazem: type: object allOf: #/definitions/entidade description: Armazem usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /inventory/actions/deleteInventory: post: description: Excluir Inventário THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idInventario – armazem – usuario – data properties: idInventario: type: integer format: int64 description: Id. Inventário armazem: type: object allOf: #/definitions/entidade description: Armazem usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /inventory/actions/cancelInventory: post: description: Cancelar Inventário THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idInventario – armazem – usuario – data properties: idInventario: type: integer format: int64 description: Id. Inventário armazem: type: object allOf: #/definitions/entidade description: Armazem usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /inventory/actions/generateAutomaticCount: post: description: Gerar Contagem Automática THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idInventario – armazem – usuario – data – tipoLocal – tipoEmbalagem properties: idInventario: type: integer format: int64 description: Id. Inventário armazem: type: object allOf: #/definitions/entidade description: Armazem usuario: type: object allOf: #/definitions/usuario description: Usuário data: type: string format: date-time description: Data tipoLocal: type: string allOf: – #/definitions/tipoLocal description: Tipo de Local tipoEmbalagem: type: string allOf: – #/definitions/tipoEmbalagem description: Tipo de Embalagem responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError definitions: inventoryType: description: Tipo Inventário type: string enum: – General – Rotating linkedAction: description: Ação ao vincular no Inventário type: string enum: – Linked – Unlinked tipoLocal: description: Tipo de Local type: string enum: – PickingPulmao – Picking – Pulmao tipoEmbalagem: description: Tipo de Embalagem type: string enum: – Unidade – Caixa – EmbLote – Lote 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 usuario: description: Usuário type: object required: – nomeUsuario properties: nomeUsuario: type: string description: Nome Usuário loginSeniorX: type: string description: Login SeniorX entidade: description: Entidade type: object required: – cnpj properties: cnpj: type: string description: CNPJ ie: type: string description: Inscrição Estadual produto: description: Produto type: object required: – idProduto – codProduto – descricao properties: idProduto: type: integer format: int64 description: Id do Produto codProduto: type: string description: Código do Produto descricao: type: string description: Descrição local: description: Local type: object required: – idArmazem – idLocal properties: idArmazem: type: integer format: int64 description: Id Armazém idLocal: type: string description: Id Local setor: type: object allOf: #/definitions/setor description: Setor regiao: type: object allOf: #/definitions/regiao description: Região setor: description: Setor type: object required: – idSetor – descricao properties: idSetor: type: integer format: int64 description: Id do Setor descricao: type: string description: Descrição regiao: description: Região type: object required: – idRegiao – descricao properties: idRegiao: type: integer format: int64 description: Id da Região descricao: type: string description: Descrição notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment