Exibir origem

Descrição

O endpoint GET /nfdevolution/salesChannelOrderId/{salesChannelOrderId} é utilizado para a consulta de informações detalhadas sobre um pedido específico, identificado pelo seu ID de origem no canal de vendas. Utilizando este endpoint, você pode recuperar dados importantes relacionados ao pedido, como status, itens, valores e outras informações relevantes.

Parâmetros

salesChannelOrderId (obrigatório): O ID do pedido no canal de vendas. Esse valor deve ser incluído na URL da requisição para identificar o pedido que você deseja consultar.

Sucesso (200)

{
  "Orders": [
    {
      "OrderId": 0,
      "OrderOriginId": "string",
      "DataTransfer": "2024-07-22T18:18:28.026Z",
      "Invoices": [
        {
          "InvoiceId": "string",
          "InvoiceSerialNumber": "string",
          "BranchId": "string",
          "OperationId": "string",
          "IssueDate": "2024-07-22T18:18:28.026Z",
          "FulfillmentDate": "2024-07-22T18:18:28.026Z",
          "IsReceived": true,
          "TotalQuantity": 0,
          "NetWeight": 0,
          "GrossWeight": 0,
          "NumberOfVolumes": 0,
          "VolumeType": "string",
          "Shipment": 0,
          "Insurance": 0,
          "ItemsTotalAmount": 0,
          "Discount": 0,
          "Taxes": 0,
          "TotalAmount": 0,
          "Observation": "string",
          "IsPrinted": true,
          "CarrierName": "string",
          "CarrierCity": "string",
          "CarrierCnpj": "string",
          "CarrierIe": "string",
          "CarrierAddress": "string",
          "IsRetailCustomer": true,
          "AggregatedTaxAmount": 0,
          "IsCanceled": true,
          "CancelationDate": "2024-07-22T18:18:28.026Z",
          "CanceledAmount": 0,
          "OriginType": 0,
          "UniqueSequentialNumber": 0,
          "NsuGenerationDate": "2024-07-22T18:18:28.026Z",
          "EletronicInvoiceKey": "string",
          "EletronicInvoiceAuthorizationProtocol": "string",
          "EletronicInvoiceStatus": 0,
          "IsPriority": true,
          "EletronicInvoiceIssueType": 0,
          "EletronicInvoiceCancelationReason": "string",
          "IsEletronicInvoiceIssued": 0,
          "DpecRegistry": "string",
          "Pin": "string",
          "DpecIssueDate": "2024-07-22T18:18:28.026Z",
          "EletronicInvoiceCancelationProtocol": "string",
          "ContingencyDate": "2024-07-22T18:18:28.026Z",
          "ContingencyReason": "string",
          "ReferencedInvoiceId": "string",
          "ReferencedInvoiceSerialNumber": "string",
          "EletronicInvoiceEmail": "string",
          "ApproximatedTaxAmount": 0,
          "RecipientName": "string",
          "DeliveryAddressId": 0,
          "EletronicInvoiceAuthorazionDateHour": "2024-07-22T18:18:28.026Z",
          "IssueDateHour": "2024-07-22T18:18:28.026Z",
          "FulfillmentDateHour": "2024-07-22T18:18:28.026Z",
          "EletronicInvoiceAuthorazionDateUtc": "2024-07-22T18:18:28.026Z",
          "IssueDateUtc": 0,
          "FulfillmentDateUtc": 0,
          "InvoiceItems": [
            {
              "InvoiceId": "string",
              "InvoiceSerialNumber": "string",
              "BranchId": "string",
              "ItemNumber": "string",
              "Barcode": "string",
              "Sku": "string",
              "SkuAlt": "string",
              "SkuIdUx": "string",
              "SubItemSize": 0,
              "ItemCode": "string",
              "Description": "string",
              "ProductId": "string",
              "ProductColorId": "string",
              "Qty": 0,
              "MeasurementUnit": "string",
              "Amount": 0,
              "UnitPrice": 0,
              "Discount": 0,
              "ItemTaxPercentage": 0,
              "Weight": 0,
              "Observation": "string",
              "OriginTax": "string",
              "IcmsTax": "string",
              "TaxOperation": "string",
              "TaxClassification": "string",
              "TaxException": 0,
              "Account": "string",
              "TaxAmount": 0,
              "DiscountAmount": 0,
              "EletronicInvoiceItemNumber": 0,
              "ShipmentPortionAmount": 0,
              "InsurancePortionAmount": 0,
              "ApproximatedTaxAmount": 0,
              "ItemOrigin": "string"
            }
          ]
        }
      ]
    }
  ]
}

A requisição foi bem-sucedida e o sistema retornou as informações solicitadas.

Solicitação Inválida (400)

A requisição contém erros, como um parâmetro inválido ou ausente.

{
  "erro": "string",
  "stackTrace": "string"
}

Erro de Autorização (401)

A requisição não tem autorização para acessar o recurso.

Erro Interno do Servidor (500)

Se ocorrer um erro interno no servidor, você receberá uma mensagem de erro geral.

{
  "erro": "string",
  "stackTrace": "string"
}

Para obter informações sobre um pedido, substitua {salesChannelOrderId} na URL pelo ID do pedido desejado. Envie uma requisição GET para o endpoint e, se o pedido existir, você receberá todos os detalhes associados a ele. Se houver problemas, você receberá mensagens de erro correspondentes para resolver qualquer situação.

Descrição

O endpoint GET /nfdevolution/transferDate/{date} este endpoint é utilizado para pesquisar informações sobre pedidos que foram modificados em uma data específica. Quando você usa este endpoint, o sistema busca todos os pedidos e notas fiscais cuja data de alteração coincide com a data fornecida.

Parâmetros

date (obrigatório): A data para a qual você deseja consultar as alterações. Este parâmetro deve ser informado no formato de data padrão (por exemplo, 2024-07-22).

Respostas

Sucesso (200)

{
  "Orders": [
    {
      "OrderId": 0,
      "OrderOriginId": "string",
      "DataTransfer": "2024-07-22T18:31:46.231Z",
      "Invoices": [
        {
          "InvoiceId": "string",
          "InvoiceSerialNumber": "string",
          "BranchId": "string",
          "OperationId": "string",
          "IssueDate": "2024-07-22T18:31:46.231Z",
          "FulfillmentDate": "2024-07-22T18:31:46.231Z",
          "IsReceived": true,
          "TotalQuantity": 0,
          "NetWeight": 0,
          "GrossWeight": 0,
          "NumberOfVolumes": 0,
          "VolumeType": "string",
          "Shipment": 0,
          "Insurance": 0,
          "ItemsTotalAmount": 0,
          "Discount": 0,
          "Taxes": 0,
          "TotalAmount": 0,
          "Observation": "string",
          "IsPrinted": true,
          "CarrierName": "string",
          "CarrierCity": "string",
          "CarrierCnpj": "string",
          "CarrierIe": "string",
          "CarrierAddress": "string",
          "IsRetailCustomer": true,
          "AggregatedTaxAmount": 0,
          "IsCanceled": true,
          "CancelationDate": "2024-07-22T18:31:46.231Z",
          "CanceledAmount": 0,
          "OriginType": 0,
          "UniqueSequentialNumber": 0,
          "NsuGenerationDate": "2024-07-22T18:31:46.231Z",
          "EletronicInvoiceKey": "string",
          "EletronicInvoiceAuthorizationProtocol": "string",
          "EletronicInvoiceStatus": 0,
          "IsPriority": true,
          "EletronicInvoiceIssueType": 0,
          "EletronicInvoiceCancelationReason": "string",
          "IsEletronicInvoiceIssued": 0,
          "DpecRegistry": "string",
          "Pin": "string",
          "DpecIssueDate": "2024-07-22T18:31:46.231Z",
          "EletronicInvoiceCancelationProtocol": "string",
          "ContingencyDate": "2024-07-22T18:31:46.231Z",
          "ContingencyReason": "string",
          "ReferencedInvoiceId": "string",
          "ReferencedInvoiceSerialNumber": "string",
          "EletronicInvoiceEmail": "string",
          "ApproximatedTaxAmount": 0,
          "RecipientName": "string",
          "DeliveryAddressId": 0,
          "EletronicInvoiceAuthorazionDateHour": "2024-07-22T18:31:46.231Z",
          "IssueDateHour": "2024-07-22T18:31:46.231Z",
          "FulfillmentDateHour": "2024-07-22T18:31:46.231Z",
          "EletronicInvoiceAuthorazionDateUtc": "2024-07-22T18:31:46.231Z",
          "IssueDateUtc": 0,
          "FulfillmentDateUtc": 0,
          "InvoiceItems": [
            {
              "InvoiceId": "string",
              "InvoiceSerialNumber": "string",
              "BranchId": "string",
              "ItemNumber": "string",
              "Barcode": "string",
              "Sku": "string",
              "SkuAlt": "string",
              "SkuIdUx": "string",
              "SubItemSize": 0,
              "ItemCode": "string",
              "Description": "string",
              "ProductId": "string",
              "ProductColorId": "string",
              "Qty": 0,
              "MeasurementUnit": "string",
              "Amount": 0,
              "UnitPrice": 0,
              "Discount": 0,
              "ItemTaxPercentage": 0,
              "Weight": 0,
              "Observation": "string",
              "OriginTax": "string",
              "IcmsTax": "string",
              "TaxOperation": "string",
              "TaxClassification": "string",
              "TaxException": 0,
              "Account": "string",
              "TaxAmount": 0,
              "DiscountAmount": 0,
              "EletronicInvoiceItemNumber": 0,
              "ShipmentPortionAmount": 0,
              "InsurancePortionAmount": 0,
              "ApproximatedTaxAmount": 0,
              "ItemOrigin": "string"
            }
          ]
        }
      ]
    }
  ]
}

A requisição foi bem-sucedida e o sistema retornou as informações sobre os pedidos modificados na data especificada.

Solicitação Inválida (400)

A requisição contém erros, como um formato inválido para a data ou um parâmetro ausente.

{
  "erro": "string",
  "stackTrace": "string"
}

Erro de Autorização (401)

A requisição não tem autorização para acessar o recurso solicitado.

Erro Interno do Servidor (500)

Ocorreu um erro interno no servidor ao processar a requisição.

{
  "erro": "string",
  "stackTrace": "string"
}

Para pesquisar pedidos modificados em uma data específica, substitua {date} na URL pelo valor da data desejada no formato AAAA-MM-DD. Envie uma requisição GET para o endpoint e, se existirem pedidos alterados nessa data, você receberá uma lista com todos os detalhes correspondentes. Se houver problemas, serão fornecidas mensagens de erro para facilitar a resolução.

Exemplo do Swagger:

Shopping - Linx > NfDevolution > image-2024-7-22_15-34-35.png