erp_mer

ig5_contratovenda

22 views 22/10/2018 04/08/2020 integrador 0

2.0info: 0.1.1 ig5_contratovenda description: Mercado – Integração G5 – Contrato de venda x-senior-domain: erp_mer x-senior-domain-path: erp_mer x-senior-service-path: ig5_contratovenda 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/erp_mersecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ig5_contratovenda/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 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 /ig5_contratovenda/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 /ig5_contratovenda/actions/gerarPedido: post: description: Gerar pedido via contrato de venda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentoIntegrado – codigoEmpresa – codigoFilial – codigoCliente – condicaoPagamento – itens properties: documentoIntegrado: type: string maxLength: 20 description: Número do documento integrado codigoEmpresa: type: integer format: int64 description: Código da empresa maximum: 9999 codigoFilial: type: integer format: int64 description: Código da filial maximum: 9999 codigoCliente: type: integer format: int64 description: Código do cliente do pedido maximum: 999999999 codigoRepresentante: type: integer format: int64 description: Código do representante do pedido maximum: 999999999 sequenciaEnderecoEntrega: type: integer format: int64 description: Sequência do endereço de entrega do cliente maximum: 99999 sequenciaEnderecoCobranca: type: integer format: int64 description: Sequência do endereço de cobrança maximum: 99999 codigoMoeda: type: string maxLength: 3 description: Código da moeda/índice do preço unitário numeroPedidoCliente: type: string maxLength: 20 description: Número do pedido do cliente observacao: type: string maxLength: 999 description: Observação do pedido formaPagamento: type: integer format: int64 description: Código da forma de pagamento maximum: 2 condicaoPagamento: type: string maxLength: 6 description: Código da condição de pagamento itens: type: array items: type: object allOf: – #/definitions/recItemPedido minimum: 1 description: Itens do pedido responses: 200: description: Ok schema: type: object required: – numeroPedido – itens properties: numeroPedido: type: integer format: int64 description: Número do pedido maximum: 99999999 itens: type: array items: type: object allOf: – #/definitions/recItemPedidoRetorno minimum: 1 description: Itens do pedido default: description: Error response schema: #/definitions/genericError /ig5_contratovenda/actions/cancelarPedidos: post: description: Cancelar pedido – Nenhum pedido é cancelado se algum cancelamento de pedido falhar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pedidos properties: pedidos: type: array items: type: object allOf: – #/definitions/recChavePedido minimum: 1 description: Pedidos para cancelamento responses: 200: description: Ok schema: type: object required: – pedidos properties: pedidos: type: array items: type: object allOf: – #/definitions/recCancelamentoPedidoRetorno minimum: 1 description: Pedidos da solicitação de cancelamento default: description: Error response schema: #/definitions/genericError definitions: 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 recItemPedido: description: Estrutura dos itens do pedido type: object required: – documentoIntegrado – codigoProduto – codigoDerivacao – unidadeMedida – quantidadePedido – precoUnitario properties: documentoIntegrado: type: string maxLength: 20 description: Número do documento integrado codigoProduto: type: string maxLength: 14 description: Código do produto codigoDerivacao: type: string maxLength: 7 description: Código da derivação do produto unidadeMedida: type: string maxLength: 3 description: Unidade de medida do produto quantidadePedido: type: number format: double description: Quantidade do produto – máscara (14,5) precoUnitario: type: number format: double description: Preço unitário do produto – máscara (14,5) observacao: type: string maxLength: 999 description: observacao do item recItemPedidoRetorno: description: Estrutura do retorno dos itens do pedido type: object required: – documentoIntegrado – sequenciaItem properties: documentoIntegrado: type: string maxLength: 20 description: Número do documento integrado sequenciaItem: type: integer format: int64 description: Sequência de item do pedido maximum: 9999 recChavePedido: description: Estrutura com a chave de um pedido discriminator: _discriminator type: object required: – codigoEmpresa – codigoFilial – numeroPedido – _discriminator properties: codigoEmpresa: type: integer format: int64 description: Código da empresa maximum: 9999 codigoFilial: type: integer format: int64 description: Código da filial maximum: 9999 numeroPedido: type: integer format: int64 description: Número do pedido maximum: 99999999 _discriminator: type: string description: recCancelamentoPedidoRetorno: description: Estrutura do retorno de cancelamento allOf: – #/definitions/recChavePedido – type: object required: – falha properties: falha: type: boolean description: Falha no cancelamento descricaoFalha: type: string description: Descrição da falha no cancelamento notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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