erpx

2.0info: 1.13.0 eCommerce description: Serviço de integração comercial do ERPX x-senior-domain: ERPX x-senior-domain-path: erpx x-senior-service-path: ecommerce contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx/ecommercesecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /listProductPrice: post: description: Retorna a listagem de todos os preços de um produto do ERPX para o e-commerce ### Resources - res://senior.com.br/erpx/ecommerce/actions/managePrice x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – productPrices properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de produtos encontrados productPrices: #/definitions/productPrice 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna a listagem de todos os preços de um produto do ERPX para o e-commerce ### Resources - res://senior.com.br/erpx/ecommerce/actions/managePrice x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – productPrices properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de produtos encontrados productPrices: #/definitions/productPrice 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /createOrder: post: description: Cria um pedido de venda com os dados informados ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – order properties: order: #/definitions/order responses: 200: description: Ok schema: type: object required: – externalId properties: externalId: type: string description: ID do pedido criado no ERPX 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getProduct: post: description: Retorna as informações de um produto do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageProducts x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX responses: 200: description: Ok schema: type: object required: – product properties: product: #/definitions/product 404: description: Produto não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de um produto do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageProducts x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX responses: 200: description: Ok schema: type: object required: – product properties: product: #/definitions/product 404: description: Produto não encontrado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getInvoice: post: description: Retorna as informações da nota fiscal no ERPX ### Resources - res://senior.com.br/erpx/ecommerce/queries/getInvoice x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID da nota fiscal no ERPX responses: 200: description: Ok schema: type: object required: – invoice properties: invoice: #/definitions/invoice 404: description: Nota fiscal não encontrada 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações da nota fiscal no ERPX ### Resources - res://senior.com.br/erpx/ecommerce/queries/getInvoice x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID da nota fiscal no ERPX responses: 200: description: Ok schema: type: object required: – invoice properties: invoice: #/definitions/invoice 404: description: Nota fiscal não encontrada 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /listProducts: post: description: Retorna as informações de produtos do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageProducts x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da Empresa familyId: type: string description: Id da familia sku: type: string description: SKU do produto no ERPX description: type: string description: Descrição do produto no ERPX ecommerceSale: type: boolean description: Produto vendível no e-commerce/marketplace pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – products properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de produtos encontrados products: #/definitions/product 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de produtos do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageProducts x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da Empresa familyId: type: string description: Id da familia sku: type: string description: SKU do produto no ERPX description: type: string description: Descrição do produto no ERPX ecommerceSale: type: boolean description: Produto vendível no e-commerce/marketplace pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – products properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de produtos encontrados products: #/definitions/product 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getProductPrice: post: description: Retorna as informações de preço de um produto do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/managePrice x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – measureUnitId properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX measureUnitId: type: string description: Unidade Medida para venda paymentTermsId: type: string description: Condição de pagamento responses: 200: description: Ok schema: type: object required: – productPrice properties: productPrice: #/definitions/productPrice 404: description: Registro não localizado através do ID informado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de preço de um produto do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/managePrice x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – measureUnitId properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX measureUnitId: type: string description: Unidade Medida para venda paymentTermsId: type: string description: Condição de pagamento responses: 200: description: Ok schema: type: object required: – productPrice properties: productPrice: #/definitions/productPrice 404: description: Registro não localizado através do ID informado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getOrder: post: description: Retorna as informações de um pedido de venda do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: id: type: string description: ID do pedido no ERPX externalId: type: string description: ID do pedido no ecommerce responses: 200: description: Ok schema: type: object required: – order properties: order: #/definitions/erpxOrder 404: description: Registro não localizado através do ID informado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de um pedido de venda do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: id: type: string description: ID do pedido no ERPX externalId: type: string description: ID do pedido no ecommerce responses: 200: description: Ok schema: type: object required: – order properties: order: #/definitions/erpxOrder 404: description: Registro não localizado através do ID informado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getStock: post: description: Retorna as informações de estoque do produto no ERPX ### Resources - res://senior.com.br/erpx/ecommerce/queries/getStock x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: productId: type: string description: Id do produto no ERPX companyId: type: string description: Id da empresa no ERPX sku: type: string description: SKU do produto no ERPX responses: 200: description: Ok schema: type: object properties: availableQuantity: type: integer description: Saldo disponível do produto companyId: type: string description: Id do empresa no ERPX sku: type: string description: SKU do produto no ERPX 404: description: Registro não localizado através do ID ou chave de negócio informado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de estoque do produto no ERPX ### Resources - res://senior.com.br/erpx/ecommerce/queries/getStock x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: productId: type: string description: Id do produto no ERPX companyId: type: string description: Id da empresa no ERPX sku: type: string description: SKU do produto no ERPX responses: 200: description: Ok schema: type: object properties: availableQuantity: type: integer description: Saldo disponível do produto companyId: type: string description: Id do empresa no ERPX sku: type: string description: SKU do produto no ERPX 404: description: Registro não localizado através do ID ou chave de negócio informado 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /listOrders: post: description: Retorna as informações de pedidos de venda do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da Empresa initialIssueDate: type: string description: Data de emissão inicial finalIssueDate: type: string description: Data de emissão final customerId: type: string description: Id do cliente no ERPX sku: type: string description: SKU do produto no ERPX status: #/definitions/orderStatus pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – orders properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de pedidos encontrados orders: #/definitions/erpxOrder 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de pedidos de venda do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da Empresa initialIssueDate: type: string description: Data de emissão inicial finalIssueDate: type: string description: Data de emissão final customerId: type: string description: Id do cliente no ERPX sku: type: string description: SKU do produto no ERPX status: #/definitions/orderStatus pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – orders properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de pedidos encontrados orders: #/definitions/erpxOrder 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /updateOrderStatus: post: description: Altera o status de um pedido no ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – status properties: id: type: string description: ID do pedido no ERPX status: #/definitions/orderStatus externalId: type: string description: ID do pedido no ecommerce responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID do pedido no ERPX 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX informado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /orderUpdated: post: description: Evento que representa alterações no pedido de venda do ERPX ### Resources - res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – status properties: id: type: string description: ID do pedido no ERPX externalId: type: string description: ID do pedido no ecommerce status: #/definitions/orderStatus errorMessage: type: string description: Mensagem de erro responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productPriceUpdated: post: description: Evento que representa alterações no preço do produto do ERPX x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – measureUnitId properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX measureUnitId: type: string description: Unidade Medida para venda paymentTermsId: type: string description: Condição de pagamento status: #/definitions/updateStatus responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /invoiceGenerated: post: description: Evento que representa a geração da nota fiscal do pedido x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID da nota fiscal no ERPX ecommerceOrderId: type: string description: ID do pedido no ecommerce responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productUpdated: post: description: Evento que representa alterações no produto do ERPX ### Resources – res : //senior.com.br/erpx/ecommerce/actions/manageProducts x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id – status properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX status: #/definitions/enumUpdateStatus productSoldOnEcommerce: type: boolean description: Indicativo se o produto pode ser vendido no e-commerce responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /stockUpdated: post: description: Evento que representa alterações no estoque do produto no ERPX x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: productId: type: string description: Id do produto no ERPX companyId: type: string description: Id da empresa no ERPX sku: type: string description: SKU do produto no ERPX responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: enumUpdateStatus: type: string enum: – CREATED – CHANGED – DELETED orderStatus: type: string enum: – IN_PROGRESS – ORDER_CREATED – NOT_PAID – PAID – INVOICED – CANCELED – ERROR updateStatus: type: string enum: – CREATED – CHANGED – DELETED enumTypeOrder: type: string enum: – ASC – DESC order: type: object required: – companyId – externalId – status – customer – itens – totalPaid properties: companyId: type: string description: ID da empresa externalId: type: string description: ID do pedido no ecommerce externalNumber: type: string description: Número do pedido no ecommerce status: #/definitions/orderStatus issueDate: type: string description: Data de emissão format: date expectedDeliveryDate: type: string description: Data de entrega prevista format: date customer: #/definitions/customer shippingAddress: #/definitions/shippingAddress itens: type: array items: #/definitions/item description: Informações dos itens observation: type: string description: Observação do pedido shippingCost: type: string description: Valor de frete totalPaid: type: string description: Valor total discount: type: string description: Valor total de desconto intermediaryTaxNumber: type: string description: CNPJ do Intermediador da Transação intermediaryRegistration: type: string description: Identificador cadastrado no intermediador saleChannelName: type: string description: Nome do canal de venda no e-commerce customer: type: object properties: id: type: string description: ID do ERPX document: type: string description: Número do CPF/CNPJ name: type: string description: Nome completo address: type: string description: Endereço addressNumber: type: string description: Número do endereço addressComplement: type: string description: Complemento do endereço neighborhood: type: string description: Bairro postCode: type: string description: CEP phone: type: string description: Telefone phone2: type: string description: Telefone 2 email: type: string description: E-mail birthDate: type: string description: Data de nascimento format: date shippingAddress: type: object properties: document: type: string description: Número do CPF/CNPJ name: type: string description: Nome completo address: type: string description: Endereço addressNumber: type: string description: Número do endereço addressComplement: type: string description: Complemento do endereço neighborhood: type: string description: Bairro postCode: type: string description: CEP phone: type: string description: Telefone celphone: type: string description: Celular item: type: object required: – price – quantity properties: id: type: string description: ID do produto no ERPX sku: type: string description: SKU do produto no ERPX price: type: string description: Preço unitário quantity: type: number description: Quantidade pedida format: double total: type: string description: Valor total discount: type: string description: Valor de desconto expectedDeliveryDate: type: string description: Data de entrega prevista format: date externalNumber: type: string description: Número do pedido no ecommerce observation: type: string description: Observação do item do pedido erpxOrder: type: object required: – companyId – externalId – status – customer – itens – totalPaid properties: companyId: type: string description: ID da empresa externalId: type: string description: ID do pedido no ecommerce externalNumber: type: string description: Número do pedido no ecommerce status: #/definitions/orderStatus issueDate: type: string description: Data de emissão format: date expectedDeliveryDate: type: string description: Data de entrega prevista format: date customer: #/definitions/customer shippingAddress: #/definitions/shippingAddress itens: type: array items: #/definitions/item description: Informações dos itens observation: type: string description: Observação do pedido shippingCost: type: string description: Valor de frete totalPaid: type: string description: Valor total discount: type: string description: Valor total de desconto intermediaryTaxNumber: type: string description: CNPJ do Intermediador da Transação intermediaryRegistration: type: string description: Identificador cadastrado no intermediador saleChannelName: type: string description: Nome do canal de venda no e-commerce id: type: string description: ID do pedido no ERPX errorMessage: type: string description: Mensagem de erro product: type: object required: – company – family – sku – description – status properties: id: type: string description: Id do produto no ERPX company: #/definitions/company family: #/definitions/family sku: type: string description: Sku do produto description: type: string description: Descrição additionalDescription: type: string description: Descrição complementar barcode: type: string description: Código de barras freeBarcode: type: string description: Código barras livre gtin: type: string description: GTIN unidade tributável productIdentification: type: string description: Identificação produto grossWeight: type: number description: Peso bruto format: double netWeight: type: number description: Peso líquido format: double length: type: number description: Comprimento format: double width: type: number description: Largura format: double height: type: number description: Altura format: double brand: #/definitions/brand referenceCode: type: string description: Código da Referência status: type: string description: Situação deleted: type: boolean description: Indica se o registro foi excluído commercialProduct: #/definitions/commercialProduct taxProduct: #/definitions/taxProduct stockProduct: #/definitions/stockProduct company: type: object required: – code – name – tradeName properties: id: type: string description: Id da empresa no ERPX code: type: integer description: Código da empresa name: type: string description: Nome da empresa tradeName: type: string description: Nome fantasia da empresa family: type: object required: – company – code – description – isKit properties: id: type: string description: Id da família no ERPX company: #/definitions/company code: type: string description: Código description: type: string description: Descrição isKit: type: boolean description: Indicativo que os produtos produzidos desta família são 'kit' c/ vários produtos agregados p/ venda (não gera op) brand: #/definitions/brand deleted: type: boolean description: Indica se o registro foi excluído brand: type: object required: – code – name – status properties: id: type: string description: Id da marca no ERPX code: type: string description: Código da marca/etiqueta vinculada a um produto ou a um pedido name: type: string description: Nome da marca status: type: string description: Situação da marca deleted: type: boolean description: Indica se o registro foi excluído commercialProduct: type: object properties: productCanBeSold: type: boolean description: Indicativo se o produto pode ser vendido productSoldOnEcommerce: type: boolean description: Indicativo se o produto pode ser vendido no e-commerce multiSalesQuantity: type: number description: Quantidade Múltipla Vendas format: double measureUnit: #/definitions/measureUnit measureUnit: type: object required: – measureUnit – description properties: id: type: string description: Id da unidade de medida no ERPX measureUnit: type: string description: Unidade de medida description: type: string description: Descrição da unidade de medida deleted: type: boolean description: Indica se o registro foi excluído taxProduct: type: object properties: ncm: #/definitions/ncm cest: type: string description: Especificador substituição tributária ncm: type: object required: – code – description – startDate – status properties: id: type: string description: Id do NCM code: type: string description: Nomenclatura comum do Mercosul (NCM) description: type: string description: Descrição cest: type: string description: Código especificador da substituição tributária startDate: type: string description: Vigência inicial format: date endDate: type: string description: Vigência final format: date status: type: string description: Situação deleted: type: boolean description: Sinaliza se o registro foi excluido stockProduct: type: object properties: serialControl: type: boolean description: Controla por Série? batchControl: type: boolean description: Controla por Lote? validityControl: type: string description: Controle Validade batchValidityDays: type: integer description: Dias Cálculo Validade Lote costPrice: type: string description: Valor do preço de custo para entrada via produção pageRequest: type: object required: – offset – size properties: offset: type: integer description: Página atual size: type: integer description: Total de páginas orderBy: type: array items: #/definitions/fieldsOrderBy description: Campos da ordenação fieldsOrderBy: type: object required: – field – order properties: field: type: string description: Nome do campo order: #/definitions/enumTypeOrder productPrice: type: object required: – id – basePrice – status properties: id: type: string description: ID do produto no ERPX companyId: type: string description: Id da Empresa sku: type: string description: SKU do produto no ERPX basePrice: type: string description: Preço base discountPercentage: type: number description: Percentual de desconto do produto format: double measureUnit: #/definitions/measureUnit paymentTerms: #/definitions/paymentTerms productPriceValidity: #/definitions/productPriceValidity status: type: string description: Situação paymentTerms: type: object required: – code – description – abbreviation – status properties: id: type: string description: Id da condição de pagamento no ERPX code: type: string description: Código da condição de pagamento description: type: string description: Descrição da condição de pagamento abbreviation: type: string description: Abreviatura da condição de pagamento status: type: string description: Situação da condição de pagamento deleted: type: boolean description: Indica se o registro foi excluído productPriceValidity: type: object required: – description – initialDate – endDate properties: description: type: string description: Descrição da validade initialDate: type: string description: Validade Inicial format: date endDate: type: string description: Validade Final format: date invoice: type: object properties: key: type: string description: Chave de acesso da nota number: type: string description: Número da nota fiscal consultLink: type: string description: Link de consulta para nota ecommerceOrderId: type: string description: ID externo do pedido no ecommerce serie: type: string description: Série da nota fiscal issueDate: type: string description: Data de emissão da nota fiscal format: date-time orderId: type: string description: ID do pedido no ERPX cfops: type: array items: type: string description: Lista de cfops da nota fiscal 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