eCommerce (ecommerce)

2.0info: 1.11.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: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpxsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ecommerce/queries/healthcheck: post: description: Query para o SRE 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ço 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 o SRE 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ço 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 /ecommerce/queries/getOrder: post: description: Retorna as informações de um pedido de venda do ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageOrders tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: ID do pedido no ERPX externalId: type: string maxLength: 36 description: ID do pedido no ecommerce responses: 200: description: Ok schema: type: object required: – order properties: order: type: object allOf: – #/definitions/erpxOrder description: Informações do pedido 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID informado default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de um pedido de venda do ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageOrders tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: ID do pedido no ERPX in: query type: string – name: externalId description: ID do pedido no ecommerce in: query type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – order properties: order: type: object allOf: – #/definitions/erpxOrder description: Informações do pedido 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID informado default: description: Error response schema: #/definitions/genericError /ecommerce/queries/listOrders: post: description: Retorna as informações de pedidos de venda do ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageOrders tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da Empresa initialIssueDate: type: string format: date description: Data de emissão inicial finalIssueDate: type: string format: date 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: type: string allOf: – #/definitions/orderStatus description: Status do pedido pageRequest: type: object allOf: – #/definitions/pageRequest description: Configurações de paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – orders properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de pedidos encontrados orders: type: array items: type: object allOf: – #/definitions/erpxOrder minimum: 1 description: Informações dos pedidos 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecommerce/queries/getProduct: post: description: Retorna as informações de um produto do ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageProducts tags: – Queries x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/product description: Informações do produto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Produto não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de um produto do ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageProducts tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: ID do produto no ERPX in: query type: string – name: companyId description: Id da Empresa in: query type: string – name: sku description: SKU do produto no ERPX in: query type: string responses: 200: description: Ok schema: type: object required: – product properties: product: type: object allOf: – #/definitions/product description: Informações do produto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Produto não encontrado default: description: Error response schema: #/definitions/genericError /ecommerce/queries/getProductPrice: post: description: Retorna as informações de preço de um produto do ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/managePrice tags: – Queries x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/productPrice description: Informações do produto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID informado default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de preço de um produto do ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/managePrice tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: ID do produto no ERPX in: query type: string – name: companyId description: Id da Empresa in: query type: string – name: sku description: SKU do produto no ERPX in: query type: string – name: measureUnitId description: Unidade Medida para venda in: query required: true type: string – name: paymentTermsId description: Condição de pagamento in: query type: string responses: 200: description: Ok schema: type: object required: – productPrice properties: productPrice: type: object allOf: – #/definitions/productPrice description: Informações do produto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID informado default: description: Error response schema: #/definitions/genericError /ecommerce/queries/listProducts: post: description: Retorna as informações de produtos do ERPX\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageProducts tags: – Queries x-senior-visibility: PUBLIC parameters: – 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 default: true pageRequest: type: object allOf: – #/definitions/pageRequest description: Configurações de paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – products properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de produtos encontrados products: type: array items: type: object allOf: – #/definitions/product minimum: 1 description: Informações dos produtos 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecommerce/queries/getInvoice: post: description: Retorna as informações da nota fiscal no ERPX\n### Resources\n- res://senior.com.br/erpx/ecommerce/queries/getInvoice tags: – Queries x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/invoice description: Informações da nota fiscal 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Nota fiscal não encontrada default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações da nota fiscal no ERPX\n### Resources\n- res://senior.com.br/erpx/ecommerce/queries/getInvoice tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: ID da nota fiscal no ERPX in: query required: true type: string responses: 200: description: Ok schema: type: object required: – invoice properties: invoice: type: object allOf: – #/definitions/invoice description: Informações da nota fiscal 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Nota fiscal não encontrada default: description: Error response schema: #/definitions/genericError /ecommerce/queries/getStock: post: description: Retorna as informações de estoque do produto no ERPX\n### Resources\n- res://senior.com.br/erpx/ecommerce/queries/getStock tags: – Queries x-senior-visibility: PUBLIC parameters: – 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 format: int64 description: Saldo disponível do produto companyId: type: string description: Id do empresa no ERPX sku: type: string description: SKU do produto no ERPX 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ou chave de negócio informado default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de estoque do produto no ERPX\n### Resources\n- res://senior.com.br/erpx/ecommerce/queries/getStock tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Id do produto no ERPX in: query type: string – name: companyId description: Id da empresa no ERPX in: query type: string – name: sku description: SKU do produto no ERPX in: query type: string responses: 200: description: Ok schema: type: object properties: availableQuantity: type: integer format: int64 description: Saldo disponível do produto companyId: type: string description: Id do empresa no ERPX sku: type: string description: SKU do produto no ERPX 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ou chave de negócio informado default: description: Error response schema: #/definitions/genericError /ecommerce/queries/listProductPrice: post: description: Retorna a listagem de todos os preços de um produto do ERPX para o e-commerce\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/managePrice tags: – Queries x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/pageRequest description: Configurações de paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – productPrices properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de produtos encontrados productPrices: type: array items: type: object allOf: – #/definitions/productPrice minimum: 1 description: Informações do produto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /ecommerce/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 /ecommerce/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 /ecommerce/actions/createOrder: post: description: Cria um pedido de venda com os dados informados\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageOrders tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – order properties: order: type: object allOf: – #/definitions/order description: Informações do pedido responses: 200: description: Ok schema: type: object required: – externalId properties: externalId: type: string description: ID do pedido criado no ERPX 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /ecommerce/actions/updateOrderStatus: post: description: Altera o status de um pedido no ERPX\n\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageOrders tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – status properties: id: type: string description: ID do pedido no ERPX status: type: string allOf: – #/definitions/orderStatus description: Status a ser definido externalId: type: string maxLength: 36 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 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX informado default: description: Error response schema: #/definitions/genericError /ecommerce/events/orderUpdated: post: description: Evento que representa alterações no pedido de venda do ERPX\n### Resources\n- res://senior.com.br/erpx/ecommerce/actions/manageOrders x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – status properties: id: type: string description: ID do pedido no ERPX externalId: type: string maxLength: 36 description: ID do pedido no ecommerce status: type: string allOf: – #/definitions/orderStatus description: Status do pedido errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecommerce/events/productPriceUpdated: post: description: Evento que representa alterações no preço do produto do ERPX x-senior-event: true tags: – Events parameters: – 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: type: string allOf: – #/definitions/updateStatus description: Status do produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecommerce/events/invoiceGenerated: post: description: Evento que representa a geração da nota fiscal do pedido x-senior-event: true tags: – Events parameters: – 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 maxLength: 36 description: ID do pedido no ecommerce responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecommerce/events/productUpdated: post: description: Evento que representa alterações no produto do ERPX\n### Resources\n- res : //senior.com.br/erpx/ecommerce/actions/manageProducts x-senior-event: true tags: – Events parameters: – 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: type: string allOf: – #/definitions/enumUpdateStatus description: Status do produto productSoldOnEcommerce: type: boolean description: Indicativo se o produto pode ser vendido no e-commerce default: false responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ecommerce/events/stockUpdated: post: description: Evento que representa alterações no estoque do produto no ERPX x-senior-event: true tags: – Events parameters: – 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/genericError /ecommerce/events/createExternalOrderIntegrationSuccess: post: description: Evento de sucesso do recebimento de um pedido externo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalOrderIntegration properties: externalOrderIntegration: type: object allOf: – #/definitions/externalOrder description: Pedido externo criado responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumUpdateStatus: description: Status da integração do produto type: string enum: – CREATED – CHANGED – DELETED orderStatus: description: Status do pedido de venda type: string enum: – IN_PROGRESS – ORDER_CREATED – NOT_PAID – PAID – INVOICED – CANCELED – ERROR updateStatus: description: Status da integração do produto type: string enum: – CREATED – CHANGED – DELETED enumTypeOrder: description: Tipo de ordenação type: string enum: – ASC – DESC 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 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 order: description: Informações do pedido discriminator: _discriminator type: object required: – companyId – externalId – status – customer – itens – totalPaid – _discriminator properties: companyId: type: string description: ID da empresa externalId: type: string maxLength: 36 description: ID do pedido no ecommerce externalNumber: type: string description: Número do pedido no ecommerce status: type: string allOf: – #/definitions/orderStatus description: Status do pedido issueDate: type: string format: date description: Data de emissão expectedDeliveryDate: type: string format: date description: Data de entrega prevista customer: type: object allOf: – #/definitions/customer description: Informações do cliente shippingAddress: type: object allOf: – #/definitions/shippingAddress description: Informações do recebedor itens: type: array items: type: object allOf: – #/definitions/item minimum: 1 description: Informações dos itens observation: type: string maxLength: 999 description: Observação do pedido shippingCost: type: string description: Valor de frete minimum: 0.00 maximum: 9999999999999.99 default: 0 totalPaid: type: string description: Valor total minimum: 0.00 maximum: 9999999999999.99 discount: type: string description: Valor total de desconto minimum: 0.00 maximum: 9999999999999.99 default: 0 intermediaryTaxNumber: type: string maxLength: 20 description: CNPJ do Intermediador da Transação intermediaryRegistration: type: string maxLength: 60 description: Identificador cadastrado no intermediador saleChannelName: type: string description: Nome do canal de venda no e-commerce _discriminator: type: string description: erpxOrder: description: Informações do pedido allOf: – #/definitions/order – type: object properties: id: type: string description: ID do pedido no ERPX errorMessage: type: string description: Mensagem de erro productPriceValidity: description: Validade da tabela de preço type: object required: – description – initialDate – endDate properties: description: type: string maxLength: 205 description: Descrição da validade initialDate: type: string format: date description: Validade Inicial endDate: type: string format: date description: Validade Final customer: description: Informações do cliente type: object properties: id: type: string description: ID do ERPX document: type: string maxLength: 20 description: Número do CPF/CNPJ name: type: string maxLength: 100 description: Nome completo address: type: string maxLength: 100 description: Endereço addressNumber: type: string maxLength: 60 description: Número do endereço addressComplement: type: string maxLength: 200 description: Complemento do endereço neighborhood: type: string maxLength: 75 description: Bairro postCode: type: string maxLength: 10 description: CEP phone: type: string maxLength: 20 description: Telefone phone2: type: string maxLength: 20 description: Telefone 2 email: type: string maxLength: 100 description: E-mail birthDate: type: string format: date description: Data de nascimento shippingAddress: description: Informações do endereço de entegra type: object properties: document: type: string maxLength: 20 description: Número do CPF/CNPJ name: type: string maxLength: 100 description: Nome completo address: type: string maxLength: 100 description: Endereço addressNumber: type: string maxLength: 60 description: Número do endereço addressComplement: type: string maxLength: 200 description: Complemento do endereço neighborhood: type: string maxLength: 75 description: Bairro postCode: type: string maxLength: 10 description: CEP phone: type: string maxLength: 20 description: Telefone celphone: type: string maxLength: 20 description: Celular item: description: Informações do item do pedido 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 minimum: 0.00 maximum: 99999999999.9999999999 quantity: type: number format: double description: Quantidade pedida minimum: 0.00 maximum: 999999999.99999 total: type: string description: Valor total minimum: 0.00 maximum: 9999999999999.99 discount: type: string description: Valor de desconto minimum: 0.00 maximum: 9999999999999.99 default: 0.0 expectedDeliveryDate: type: string format: date description: Data de entrega prevista externalNumber: type: string description: Número do pedido no ecommerce observation: type: string maxLength: 999 description: Observação do item do pedido product: description: Informações do produto type: object required: – company – family – sku – description – status properties: id: type: string description: Id do produto no ERPX company: type: object allOf: – #/definitions/company description: Empresa family: type: object allOf: – #/definitions/family description: Família sku: type: string maxLength: 23 description: Sku do produto description: type: string maxLength: 120 description: Descrição additionalDescription: type: string maxLength: 255 description: Descrição complementar barcode: type: string maxLength: 13 description: Código de barras freeBarcode: type: string maxLength: 30 description: Código barras livre gtin: type: string maxLength: 14 description: GTIN unidade tributável productIdentification: type: string maxLength: 20 description: Identificação produto grossWeight: type: number format: double description: Peso bruto minimum: 0.00 maximum: 999999.99999 netWeight: type: number format: double description: Peso líquido minimum: 0.00 maximum: 999999.99999 length: type: number format: double description: Comprimento minimum: 0.00 maximum: 999999.99999 width: type: number format: double description: Largura minimum: 0.00 maximum: 999999.99999 height: type: number format: double description: Altura minimum: 0.00 maximum: 999999.99999 brand: type: object allOf: – #/definitions/brand description: Marca referenceCode: type: string maxLength: 40 description: Código da Referência status: type: string description: Situação deleted: type: boolean description: Indica se o registro foi excluído default: false commercialProduct: type: object allOf: – #/definitions/commercialProduct description: Dados comerciais do produto taxProduct: type: object allOf: – #/definitions/taxProduct description: Dados fiscais do produto stockProduct: type: object allOf: – #/definitions/stockProduct description: Dados de estoque do produto commercialProduct: description: Dados comerciais do produto type: object properties: productCanBeSold: type: boolean description: Indicativo se o produto pode ser vendido default: false productSoldOnEcommerce: type: boolean description: Indicativo se o produto pode ser vendido no e-commerce default: false multiSalesQuantity: type: number format: double description: Quantidade Múltipla Vendas minimum: 0.00 maximum: 9999999.99999 measureUnit: type: object allOf: – #/definitions/measureUnit description: Unidade Medida para venda taxProduct: description: Dados fiscais do produto type: object properties: ncm: type: object allOf: – #/definitions/ncm description: NCM cest: type: string maxLength: 7 description: Especificador substituição tributária stockProduct: description: Dados de estoque do produto 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 format: int64 description: Dias Cálculo Validade Lote minimum: 0 maximum: 999999 costPrice: type: string description: Valor do preço de custo para entrada via produção minimum: 0.00 maximum: 999999999.99999 company: description: Empresa type: object required: – code – name – tradeName properties: id: type: string description: Id da empresa no ERPX code: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 name: type: string maxLength: 100 description: Nome da empresa tradeName: type: string maxLength: 100 description: Nome fantasia da empresa family: description: Família type: object required: – company – code – description – isKit properties: id: type: string description: Id da família no ERPX company: type: object allOf: – #/definitions/company description: Empresa code: type: string maxLength: 6 description: Código description: type: string maxLength: 50 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: type: object allOf: – #/definitions/brand description: Código da marca/etiqueta da família deleted: type: boolean description: Indica se o registro foi excluído default: false brand: description: Marca type: object required: – code – name – status properties: id: type: string description: Id da marca no ERPX code: type: string maxLength: 10 description: Código da marca/etiqueta vinculada a um produto ou a um pedido name: type: string maxLength: 40 description: Nome da marca status: type: string description: Situação da marca deleted: type: boolean description: Indica se o registro foi excluído default: false measureUnit: description: Unidade de medida type: object required: – measureUnit – description properties: id: type: string description: Id da unidade de medida no ERPX measureUnit: type: string maxLength: 6 description: Unidade de medida description: type: string maxLength: 100 description: Descrição da unidade de medida deleted: type: boolean description: Indica se o registro foi excluído default: false ncm: description: Cadastro para definição do Nomenclatura comercial do Mercosul(NCM) para os produtos type: object required: – code – description – startDate – status properties: id: type: string description: Id do NCM code: type: string maxLength: 8 description: Nomenclatura comum do Mercosul (NCM) description: type: string maxLength: 250 description: Descrição cest: type: string maxLength: 7 description: Código especificador da substituição tributária startDate: type: string format: date description: Vigência inicial endDate: type: string format: date description: Vigência final status: type: string description: Situação deleted: type: boolean description: Sinaliza se o registro foi excluido default: false pageRequest: description: Configurações de paginação e ordenação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de páginas orderBy: type: array items: type: object allOf: – #/definitions/fieldsOrderBy description: Campos da ordenação fieldsOrderBy: description: Definição de campo a ser ordenado type: object required: – field – order properties: field: type: string description: Nome do campo order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação (ASC / DESC) productPrice: description: Preço do produto 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 minimum: 0.00 maximum: 9999999999999.99 discountPercentage: type: number format: double description: Percentual de desconto do produto minimum: 0.00 maximum: 999.99 measureUnit: type: object allOf: – #/definitions/measureUnit description: Unidade Medida para venda paymentTerms: type: object allOf: – #/definitions/paymentTerms description: Condição de pagamento productPriceValidity: type: object allOf: – #/definitions/productPriceValidity description: Validade da tabela de preço status: type: string description: Situação paymentTerms: description: Condição de pagamento type: object required: – code – description – abbreviation – status properties: id: type: string description: Id da condição de pagamento no ERPX code: type: string maxLength: 6 description: Código da condição de pagamento description: type: string maxLength: 50 description: Descrição da condição de pagamento abbreviation: type: string maxLength: 10 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 default: false invoice: description: Informações da nota fiscal do pedido 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 maxLength: 36 description: ID externo do pedido no ecommerce serie: type: string description: Série da nota fiscal issueDate: type: string format: date-time description: Data de emissão da nota fiscal orderId: type: string description: ID do pedido no ERPX cfops: type: array items: type: string description: Lista de cfops da nota fiscal externalOrder: description: Dados de integração do pedido do e-commerce type: object properties: id: type: string description: Id da integração idExterno: type: string description: Id externo do e-commerce status: type: string allOf: – #/definitions/orderStatus description: Status da integração errorMessage: type: string description: Mensagme de erro na integração orderPayload: type: string description: Payload enviado pelo e-commerce 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