Endpoint POST /orders - Inclusão de Pedido

POST /orders

Descrição

O endpoint POST /orders é utilizado para criar um novo pedido no sistema. Ao enviar uma solicitação para este endpoint, você incluirá todas as informações necessárias para registrar um pedido, como detalhes do cliente, itens do pedido, informações de pagamento e opções de entrega.

Parâmetros

Este endpoint não requer parâmetros na URL.

Corpo da Requisição

O corpo da solicitação deve ser enviado no formato JSON e deve incluir as seguintes informações:

  • SalesChannelOrderId: Identificador do pedido no canal de vendas.
  • OriginBranch: Código da filial de origem.
  • FulfillmentBranch: Código da filial responsável pela entrega.
  • IntermediaryCnpj: CNPJ do intermediário, se aplicável.
  • OrderType: Tipo do pedido (por exemplo, online, telefônico).
  • TotalQuantity: Quantidade total de itens no pedido.
  • TotalAmount: Valor total do pedido.
  • Discount: Valor total de desconto aplicado ao pedido.
  • Date: Data em que o pedido foi criado.
  • Observation: Observações adicionais sobre o pedido.
  • ShipmentAmount: Valor do frete.
  • RecipientName: Nome do destinatário do pedido.
  • GiftMessage: Mensagem de presente, se aplicável.
  • Carrier: Nome da transportadora.
  • ShipmentType: Tipo de envio (por exemplo, expressa, padrão).
  • Tracking: Código de rastreamento do pedido.
  • PaymentTypeId: Identificador do tipo de pagamento.
  • SiteId: Identificador do site onde o pedido foi realizado.
  • CampaignId: Identificador da campanha promocional, se aplicável.
  • IsScheduledDelivery: Indica se a entrega é agendada.
  • DeliveryHours: Horário de entrega agendada, se aplicável.
  • DeliveryDate: Data de entrega do pedido.
  • ClearsaleStatus: Status do pedido no Clearsale.
  • DiscountId: Identificador do desconto aplicado.
  • IsLegalEntity: Indica se o cliente é uma pessoa jurídica.
  • B2CTransferStatus: Status da transferência B2C.
  • UpdateDate: Data da última atualização do pedido.

Informações do Cliente

  • Customer: Detalhes do cliente que fez o pedido.
    • CustomerType: Tipo de cliente.
    • CustomerName: Nome do cliente.
    • CpfCnpj: CPF ou CNPJ do cliente.
    • RgIe: RG ou Inscrição Estadual do cliente.
    • Country: País do cliente.
    • ZipCode: CEP do cliente.
    • Neighbourhood: Bairro do cliente.
    • City: Cidade do cliente.
    • AdditionalAddress: Endereço adicional do cliente.
    • Number: Número do endereço do cliente.
    • Street: Rua do cliente.
    • State: Estado do cliente.
    • IsIndividual: Indica se o cliente é uma pessoa física.
    • Gender: Gênero do cliente.
    • Telephone: Telefone do cliente.
    • TelephoneDistrictNumber: Número do telefone com DDD.
    • Email: E-mail do cliente.
    • NickName: Apelido do cliente.
    • DateOfBirth: Data de nascimento do cliente.
    • Contact: Informações de contato do cliente.
      • Company: Nome da empresa do contato.
      • CompanyName: Nome da empresa do cliente.

Endereço de Contato

  • ContactAddress: Endereço de contato do cliente.
    • AddressDescription: Descrição do endereço.
    • Country: País do endereço.
    • ZipCode: CEP do endereço.
    • City: Cidade do endereço.
    • Neighbourhood: Bairro do endereço.
    • State: Estado do endereço.
    • Number: Número do endereço.
    • Street: Rua do endereço.
    • AdditionalAddress: Endereço adicional.

Pagamentos do Pedido

  • OrderPayments: Lista de pagamentos relacionados ao pedido.
    • PaymentNumber: Número do pagamento.
    • PaymentTypeId: Identificador do tipo de pagamento.
    • Amount: Valor do pagamento.
    • Currency: Moeda do pagamento.
    • TitleNumber: Número do título, se aplicável.
    • DueDate: Data de vencimento do pagamento.
    • PaymentDate: Data do pagamento.
    • Bank: Banco responsável pelo pagamento.
    • IsPaymentCaptured: Indica se o pagamento foi capturado.
    • Installments: Número de parcelas, se aplicável.
    • AdministratorId: Identificador do administrador.
    • ApprovalCode: Código de aprovação do pagamento.
    • CreditKey: Chave de crédito, se aplicável.

Itens do Pedido

  • OrderItems: Lista de itens no pedido.
    • Item: Número do item.
    • ProductId: Identificador do produto.
    • ProductColorId: Identificador da cor do produto.
    • Size: Tamanho do produto.
    • Barcode: Código de barras do produto.
    • Quantity: Quantidade do produto.
    • LiquidPrice: Preço líquido do produto.
    • ItemDiscount: Desconto aplicado ao item.
    • Giftwrap: Indica se o item é para presente.
    • SalesmanId: Identificador do vendedor.
    • CreationDate: Data de criação do item.

Lista de Presentes

  • OrderGiftlist: Informações sobre a lista de presentes, se aplicável.
    • EventName: Nome do evento para o qual o presente é destinado.
    • EventDate: Data do evento.
    • ContactName1: Nome do primeiro contato.
    • ContactName2: Nome do segundo contato.
    • ContactName3: Nome do terceiro contato.

Respostas

Sucesso (200)


Json
{
  "backOfficeId": "12345"
}

Quando o pedido é incluído com sucesso, você receberá um identificador do Back Office que confirma a inclusão.

Tipo de Mídia

  • application/json

Pedido Já Reportado (208)

Se o pedido já foi reportado anteriormente, você receberá uma resposta informando sobre isso.

Tipo de Mídia

  • application/json


Json
{
  "erro": "Pedido já reportado",
  "backOfficeId": "12345"
}

Solicitação Inválida (400)

Se houver algum erro nos dados fornecidos, você receberá uma mensagem de erro indicando o problema.

Tipo de Mídia

  • application/json
Json
{
  "erro": "Dados inválidos",
  "stackTrace": "Detalhes do erro, se disponíveis."
}

Não Autorizado (401)

Se você não estiver autorizado a fazer a solicitação, receberá uma mensagem de erro de autorização.

Tipo de Mídia

  • application/json

Erro Interno do Servidor (500)

Se ocorrer um erro interno no servidor ao processar a solicitação, você receberá uma mensagem de erro.

Tipo de Mídia

  • application/json
Json
{
  "erro": "Erro interno do servidor",
  "stackTrace": "Detalhes do erro, se disponíveis."
}

Este endpoint é usado para criar pedidos no sistema. Certifique-se de fornecer todas as informações necessárias para garantir que o pedido seja registrado corretamente. Se precisar de mais detalhes sobre o pedido, como itens e pagamentos, inclua essas informações no corpo da solicitação.


Endpoint PUT /orders/{orderId}/branches/{branchId}/payments/{paymentNumber}/IsPaymentCaptured - Atualização Pagamento

PUT /orders/{orderId}/branches/{branchId}/payments/{paymentNumber}/IsPaymentCaptured

Descrição

O endpoint PUT /orders/{orderId}/branches/{branchId}/payments/{paymentNumber}/IsPaymentCaptured permite atualizar o status de captura de um pagamento específico associado a um pedido. Com ele, você pode informar se um pagamento foi efetivamente capturado.

Parâmetros

Caminho

  • orderId: (Obrigatório) Identificador único do pedido. Deve ser um número inteiro.
  • branchId: (Obrigatório) Código da filial onde o pagamento foi realizado. Deve ser uma string.
  • paymentNumber: (Obrigatório) Identificador da parcela de pagamento. Deve ser uma string

Corpo da Requisição

Você deve enviar os seguintes dados no corpo da solicitação:

Json
{
  "TitleNumber": "12345",
  "IsPaymentCaptured": true,
  "PaymentDate": "2024-07-22T16:11:20.940Z"
}
    
  • TitleNumber: (Opcional) Número do título associado ao pagamento.
  • IsPaymentCaptured: (Obrigatório) Indica se o pagamento foi capturado. Deve ser um valor booleano (true ou false).
  • PaymentDate: (Opcional) Data em que o pagamento foi realizado, no formato de data e hora (ISO 8601).

Sucesso (200)

Se a atualização for bem-sucedida, você receberá uma confirmação de que o pagamento foi atualizado.

Solicitação Inválida (400)

Se a solicitação contiver erros ou dados incorretos, você receberá uma mensagem informando o que precisa ser corrigido.

Json
{
  "erro": "Dados inválidos fornecidos.",
  "stackTrace": "Detalhes adicionais sobre o erro, se disponíveis."
}

Não Autorizado (401)

Se você não tiver permissão para realizar a atualização, receberá uma mensagem informando que a autorização é necessária.

Erro Interno (500)

Se ocorrer um erro interno ao processar a solicitação, você receberá uma mensagem de erro informando que algo deu errado.

Json
{
  "erro": "Erro interno do servidor.",
  "stackTrace": "Detalhes adicionais sobre o erro, se disponíveis."
}  

Este endpoint é útil para atualizar o status de captura dos pagamentos de um pedido. Verifique se todos os parâmetros e dados fornecidos estão corretos para garantir que a atualização seja processada corretamente. Se você encontrar erros, as mensagens de retorno fornecerão informações para ajudar na correção.

Endpoint PUT /orders/{orderId}/CancelStatus - Atualização B2CTransferStatus (STATUS_B2C) = 8 (Cancelado) por Order Id (PEDIDO)

PUT /orders/{orderId}/CancelStatus

Descrição

O endpoint PUT /orders/{orderId}/CancelStatus é usado para atualizar o status de cancelamento de um pedido no sistema. Especificamente, ele marca um pedido como "Cancelado" (STATUS_B2C = 8) com base no identificador do pedido.

Parâmetros

  • orderId: (Obrigatório) O identificador único do pedido que você deseja cancelar. Deve ser um número inteiro.

Corpo da Requisição

Você deve enviar os seguintes dados no corpo da solicitação:


Json
{
  "IsCanceled": true
}
  • IsCanceled: (Obrigatório) Indica se o pedido deve ser marcado como cancelado. Deve ser um valor booleano (true para cancelar, false para não cancelar).

Sucesso (200)

Se a atualização for bem-sucedida, o status do pedido será alterado para "Cancelado".

Não Autorizado (401)

Se você não tiver permissão para realizar a atualização, receberá uma mensagem informando que a autorização é necessária.

Erro Interno (500)


Se ocorrer um erro interno ao processar a solicitação, você receberá uma mensagem de erro informando que algo deu errado.

Json
{
  "erro": "Erro interno do servidor.",
  "stackTrace": "Detalhes adicionais sobre o erro, se disponíveis."
}

Este endpoint é útil para marcar pedidos como cancelados quando necessário. Certifique-se de fornecer o orderId correto e definir o campo IsCanceled para true para que o pedido seja atualizado adequadamente. Se você encontrar problemas, as mensagens de erro ajudarão a identificar e corrigir qualquer problema.

Endpoint PUT /orders/{salesChannelOrderId}/CancelStatusB2C - Atualização B2CTransferStatus (STATUS_B2C) = 8 (Cancelado) por SalesChannelOrderId (PEDIDO_ID_ORIGEM)

PUT /orders/{salesChannelOrderId}/CancelStatusB2C

Descrição

O endpoint PUT /orders/{orderId}/CancelStatus é usado para atualizar o status de cancelamento de um pedido no sistema. Especificamente, ele marca um pedido como "Cancelado" (STATUS_B2C = 8) com base no identificador do pedido.

Parâmetros

  • orderId: (Obrigatório) O identificador único do pedido que você deseja cancelar. Deve ser um número inteiro.

Corpo da Requisição

Você deve enviar os seguintes dados no corpo da solicitação:


Json
{
  "IsCanceled": true
}
  • IsCanceled: (Obrigatório) Indica se o pedido deve ser marcado como cancelado. Deve ser um valor booleano (true para cancelar, false para não cancelar).

Sucesso (200)

Se a atualização for bem-sucedida, o status do pedido será alterado para "Cancelado".

Não Autorizado (401)

Se você não tiver permissão para realizar a atualização, receberá uma mensagem informando que a autorização é necessária.

Erro Interno (500)


Se ocorrer um erro interno ao processar a solicitação, você receberá uma mensagem de erro informando que algo deu errado.

Json
{
  "erro": "Erro interno do servidor.",
  "stackTrace": "Detalhes adicionais sobre o erro, se disponíveis."
}

Este endpoint é útil para marcar pedidos como cancelados quando necessário. Certifique-se de fornecer o orderId correto e definir o campo IsCanceled para true para que o pedido seja atualizado adequadamente. Se você encontrar problemas, as mensagens de erro ajudarão a identificar e corrigir qualquer problema.

Endpoint PUT/orders/{salesChannelOrderId}/StatusOrders - Atualização B2CTransferStatus (STATUS_B2C) por SalesChannelOrderId (PEDIDO_ID_ORIGEM)

PUT /orders/{salesChannelOrderId}/StatusOrders

Descrição

O endpoint PUT /orders/{salesChannelOrderId}/StatusOrders é utilizado para atualizar o status de transferência B2C (STATUS_B2C) de um pedido específico, utilizando o identificador do pedido do canal de vendas.

Parâmetros

  • salesChannelOrderId: (Obrigatório) O identificador do pedido no canal de vendas. Deve ser um número inteiro.

Corpo da Requisição

Você deve enviar os seguintes dados no corpo da solicitação:


Json
{
  "B2CTransferStatus": 11
}
  • B2CTransferStatus: (Obrigatório) O novo status de transferência B2C que deseja atribuir ao pedido. Deve ser um número inteiro representando o status desejado.

Sucesso (200)

Se a solicitação for bem-sucedida, o status de transferência B2C do pedido será atualizado.

Não Autorizado (401)

Se você não tiver permissão para realizar a atualização, receberá uma mensagem indicando que a autorização é necessária.

Não Encontrado (404)

Se o pedido com o identificador fornecido não for encontrado, você receberá uma mensagem informando que o pedido não foi encontrado.

Json
{
  "message": "Pedido não encontrado."
}

Pré-condição Falhada (412)

Se houver uma pré-condição que não foi satisfeita, você receberá uma mensagem indicando qual pré-condição falhou.

Json
{
  "message": "Pré-condição não satisfeita."
}

Erro Interno (500)

Se ocorrer um erro interno ao processar a solicitação, você receberá uma mensagem de erro informando que algo deu errado.

Json
{
  "erro": "Erro interno do servidor.",
  "stackTrace": "Detalhes adicionais sobre o erro, se disponíveis."
}

Este endpoint é útil para atualizar o status de transferência B2C de um pedido específico. Certifique-se de fornecer o salesChannelOrderId correto e definir o campo B2CTransferStatus para o valor desejado. Se você encontrar problemas, as mensagens de erro ajudarão a identificar e resolver qualquer questão.

Endpoint PUT/orders/{orderId}/ClearsalesStatus - Atualização ClearsaleStatus (STATUS_CLEARSALE)

PUT /orders/{orderId}/ClearsaleStatus

Descrição

O endpoint PUT /orders/{orderId}/ClearsaleStatus é utilizado para atualizar o status Clearsale (STATUS_CLEARSALE) de um pedido específico, utilizando o identificador do pedido.

Parâmetros

  • orderId: (Obrigatório) O identificador do pedido. Deve ser um número inteiro.

Corpo da Requisição

Você deve enviar os seguintes dados no corpo da solicitação:


Json
{
  "ClearsaleStatus": "AMA"
}
  • ClearsaleStatus: (Obrigatório) O novo status Clearsale que deseja atribuir ao pedido. Deve ser uma string representando o status desejado.

Sucesso (200)

Se a solicitação for bem-sucedida, o status Clearsale do pedido será atualizado.

Não Autorizado (401)

Se você não tiver permissão para realizar a atualização, receberá uma mensagem indicando que a autorização é necessária.

Erro Interno (500)

Se ocorrer um erro interno ao processar a solicitação, você receberá uma mensagem de erro informando que algo deu errado.

Json
{
  "erro": "Erro interno do servidor.",
  "stackTrace": "Detalhes adicionais sobre o erro, se disponíveis."
}  

Este endpoint é útil para atualizar o status Clearsale de um pedido específico. Certifique-se de fornecer o orderId correto e definir o campo ClearsaleStatus para o valor desejado. Se você encontrar problemas, as mensagens de erro ajudarão a identificar e resolver qualquer questão.

Endpoint GET /orders/{orderId} - Pesquisa pelo Id do Pedido

GET /orders/{orderId}

Descrição

O endpoint GET /orders/{orderId} esta funcionalidade permite que você consulte detalhes de um pedido específico utilizando o ID do pedido. Ao fornecer o ID do pedido, você receberá uma resposta contendo informações detalhadas sobre o pedido, incluindo itens, pagamentos, cliente, endereço de entrega e outras informações relevantes.

Parâmetros

Obrigatório

  • orderId (integer, path): O ID do pedido que você deseja consultar.

Opcionais

  • page_size (integer, query): Define a quantidade de registros por página.
  • current_page (integer, query): Define o número da página corrente.

Respostas

Sucesso (200)


Json
{
  "Pagination": {
    "TotalCount": 0,
    "PageSize": 0,
    "CurrentPage": 0
  },
  "Items": [
    {
      "OrderId": 0,
      "OrderOriginId": "string",
      "DeliveryOriginId": "string",
      "OriginBranch": "string",
      "FulfillmentBranch": "string",
      "SalesChannelOrderId": "string",
      "OrderType": 0,
      "CustomerId": "string",
      "SalesmanId": "string",
      "PriceTable": "string",
      "SalesOperationId": "string",
      "PaymentTypeId": "string",
      "TotalQuantity": 0,
      "TotalAmount": 0,
      "Discount": 0,
      "IsCanceled": true,
      "Observation": "string",
      "Date": "2024-07-22T17:45:20.088Z",
      "IsInvoiced": true,
      "IsCreated": true,
      "PaymentDiscount": 0,
      "User": "string",
      "DeliveryAddressId": 0,
      "ShipmentAmount": 0,
      "RecipientName": "string",
      "GiftMessage": "string",
      "Carrier": "string",
      "Tracking": "string",
      "IsStoreOnlyOperation": true,
      "CancelationReason": "string",
      "IsChecked": true,
      "SiteId": "string",
      "ShipmentType": "string",
      "ClearsaleStatus": "string",
      "CampaignId": 0,
      "DiscountId": "string",
      "FControlStatus": "string",
      "CampaignActionId": 0,
      "OrderExecutionStatus": 0,
      "B2CTransferStatus": 0,
      "IsScheduledDelivery": true,
      "DeliveryHours": "string",
      "DeliveryDate": "2024-07-22T17:45:20.088Z",
      "InvoiceDate": "2024-07-22T17:45:20.088Z",
      "UpdateDate": "2024-07-22T17:45:20.088Z",
      "IsLegalEntity": true,
      "AvoidsCPFECFRecording": true,
      "IsPrintedDAV": true,
      "IsPresale": 0,
      "IntermediaryId": 0,
      "OrderStatus": {
        "OrderId": 0,
        "OriginBranch": "string",
        "Status": "string"
      },
      "OrderItems": [
        {
          "ProductColorId": "string",
          "OrderId": 0,
          "OriginBranch": "string",
          "Item": 0,
          "Barcode": "string",
          "Size": "string",
          "Quantity": 0,
          "LiquidPrice": 0,
          "ItemDiscount": 0,
          "IsCanceled": true,
          "ProductId": "string",
          "SalesmanId": 0,
          "SaleQuantity": 0,
          "Giftwrap": true,
          "PersonalizationName": "string",
          "PersonalizationNumber": "string",
          "PersonalizationNameType": "string",
          "PersonalizationNumberType": "string",
          "Tracking": "string",
          "Checked": true,
          "CheckedQuantity": 0,
          "IsFutureDelivery": true,
          "IsEcommerceItem": true,
          "Quote": 0,
          "ReturnedQuantity": 0,
          "ThirdPartyQuantity": 0,
          "CreationDate": "2024-07-22T17:45:20.088Z"
        }
      ],
      "OrderPayments": [
        {
          "OrderId": 0,
          "OriginBranch": "string",
          "PaymentNumber": "string",
          "PaymentTypeId": "string",
          "Amount": 0,
          "DueDate": "2024-07-22T17:45:20.088Z",
          "TitleNumber": "string",
          "Bank": "string",
          "Currency": "string",
          "AdministratorId": "string",
          "ApprovalCode": "string",
          "Installments": 0,
          "ExchangeRate": 0,
          "IsPaymentCaptured": true,
          "CanceledAmount": 0,
          "CurrencyAmount": 0,
          "MoneyCashback": 0,
          "TacAmount": 0,
          "CreditCardCheck": "string",
          "PaymentDate": "2024-07-22T17:45:20.088Z"
        }
      ],
      "OrderGiftList": {
        "OrderId": 0,
        "OriginBranch": "string",
        "EventName": "string",
        "ContactName1": "string",
        "ContactName2": "string",
        "ContactName3": "string",
        "EventDate": "2024-07-22T17:45:20.088Z"
      },
      "ContactAddress": {
        "AddressId": 0,
        "AddressDescription": "string",
        "Country": "string",
        "ZipCode": "string",
        "Neighbourhood": "string",
        "City": "string",
        "AdditionalAddress": "string",
        "Number": "string",
        "Street": "string",
        "State": "string",
        "IsMainAddress": true,
        "ContactId": "string"
      },
      "Customer": {
        "CustomerName": "string",
        "CpfCnpj": "string",
        "Email": "string",
        "CustomerId": "string",
        "CustomerType": "string",
        "ContactId": "string",
        "BranchId": "string",
        "RgIe": "string",
        "Country": "string",
        "ZipCode": "string",
        "Neighbourhood": "string",
        "City": "string",
        "AdditionalAddress": "string",
        "Number": "string",
        "Street": "string",
        "State": "string",
        "IsIndividual": true,
        "RegisterDate": "2024-07-22T17:45:20.088Z",
        "DateOfBirth": "2024-07-22T17:45:20.088Z",
        "Gender": "string",
        "Telephone": "string",
        "TelephoneDistrictNumber": "string",
        "Mobile": "string",
        "MobileDistrictNumber": "string",
        "StreetType": "string",
        "NickName": "string",
        "HasNewsletter": "string",
        "HasNoCredit": true,
        "HasSPCRegister": true,
        "IsBlockedOnB2C": true,
        "FaxNumber": "string",
        "CreditLimit": 0,
        "TotalCreditLimit": 0,
        "Observation": "string",
        "Status": 0,
        "HasNoCheckAnalysis": true,
        "MaritalStatus": 0,
        "Profession": "string",
        "CustomerExecutionStatus": 0,
        "UpdateDate": "2024-07-22T17:45:20.088Z",
        "BillingAddressId": 0,
        "Contact": {
          "ContactId": "string",
          "ContactName": "string",
          "Email": "string",
          "Company": "string",
          "IsIndividual": true,
          "CpfCnpj": "string",
          "Gender": "string",
          "DateOfBirth": "2024-07-22T17:45:20.088Z",
          "IsRetailCustomer": true,
          "RegisterDate": "2024-07-22T17:45:20.088Z",
          "CompanyName": "string",
          "IsSystemUser": true,
          "IsThirdPartyCustomer": true,
          "IntegratesEmail": true,
          "IntegratesEmailWithCrm": true,
          "ExchangeWorkflow": true,
          "ExchangeCrm": true,
          "Telephone": "string",
          "Address": "string",
          "TelephoneInternationalDistrictNumber": "string",
          "TelephoneDistrictNumber": "string",
          "ZipCode": "string",
          "City": "string"
        }
      },
      "Shipments": [
        {
          "ShipmentId": 0,
          "ShipmentType": "string",
          "ShipmentDate": "2024-07-22T17:45:20.088Z",
          "ShipmentOrder": {
            "OrderId": 0,
            "BranchId": "string",
            "ShipmentId": 0
          }
        }
      ],
      "StockAccountingDate": "2024-07-22T17:45:20.088Z",
      "Invoices": [
        {
          "InvoiceId": "string",
          "InvoiceSerialNumber": "string",
          "BranchId": "string",
          "OperationId": "string",
          "IssueDate": "2024-07-22T17:45:20.088Z",
          "FulfillmentDate": "2024-07-22T17:45:20.088Z",
          "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-22T17:45:20.088Z",
          "CanceledAmount": 0,
          "OriginType": 0,
          "UniqueSequentialNumber": 0,
          "NsuGenerationDate": "2024-07-22T17:45:20.088Z",
          "EletronicInvoiceKey": "string",
          "EletronicInvoiceAuthorizationProtocol": "string",
          "EletronicInvoiceStatus": 0,
          "IsPriority": true,
          "EletronicInvoiceIssueType": 0,
          "EletronicInvoiceCancelationReason": "string",
          "IsEletronicInvoiceIssued": 0,
          "DpecRegistry": "string",
          "Pin": "string",
          "DpecIssueDate": "2024-07-22T17:45:20.088Z",
          "EletronicInvoiceCancelationProtocol": "string",
          "ContingencyDate": "2024-07-22T17:45:20.088Z",
          "ContingencyReason": "string",
          "ReferencedInvoiceId": "string",
          "ReferencedInvoiceSerialNumber": "string",
          "EletronicInvoiceEmail": "string",
          "ApproximatedTaxAmount": 0,
          "RecipientName": "string",
          "DeliveryAddressId": 0,
          "EletronicInvoiceAuthorazionDateHour": "2024-07-22T17:45:20.088Z",
          "IssueDateHour": "2024-07-22T17:45:20.088Z",
          "FulfillmentDateHour": "2024-07-22T17:45:20.088Z",
          "EletronicInvoiceAuthorazionDateUtc": "2024-07-22T17:45:20.088Z",
          "IssueDateUtc": 0,
          "FulfillmentDateUtc": 0,
          "InvoiceOperation": {
            "OperationId": "string",
            "Operation": "string",
            "OperationDescription": "string"
          },
          "RetailBranch": {
            "BranchId": "string",
            "BranchName": "string"
          },
          "InvoiceItems": [
            {
              "ProductColorId": "string",
              "InvoiceId": "string",
              "InvoiceSerialNumber": "string",
              "BranchId": "string",
              "ItemNumber": "string",
              "SubItemSize": 0,
              "ItemCode": "string",
              "Description": "string",
              "ProductId": "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"
            }
          ],
          "InvoiceXml": "string",
          "InvoiceOrder": {
            "OrderId": 0,
            "BranchId": "string",
            "InvoiceId": "string",
            "InvoiceSerialNumber": "string"
          }
        }
      ]
    }
  ]
}  

A requisição foi bem-sucedida. A resposta conterá detalhes do pedido conforme a estrutura acima.

Solicitação Inválida (400)

Se houver algum erro nos dados fornecidos, você receberá uma mensagem de erro indicando o problema.

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

Não autorizado (401)

Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.

Erro Interno (500)


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

Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro fornece uma descrição do erro, e stackTrace pode conter informações adicionais para diagnóstico.

Endpoint GET /orders/transferDate/{date} - Pesquisa por Data alteração (data_para_transferencia)

GET /orders/transferDate/{date}

Descrição

O endpoint GET /orders/transferDate/{date} é utilizado para pesquisa do endpoint que permite pesquisar os pedidos por data de alteração (data_para_transferencia).

Parâmetros 

  • date (obrigatório): Data de alteração (data_para_transferencia) no formato YYYY-MM-DD.
  • issue_date (opcional): Data de emissão (data >=) no formato YYYY-MM-DD.
  • page_size (opcional): Quantidade de registros por página.
  • current_page (opcional): Página corrente.

Respostas

Sucesso (200)


Json
{
  "Pagination": {
    "TotalCount": 0,
    "PageSize": 0,
    "CurrentPage": 0
  },
  "Items": [
    {
      "OrderId": 0,
      "OrderOriginId": "string",
      "DeliveryOriginId": "string",
      "OriginBranch": "string",
      "FulfillmentBranch": "string",
      "SalesChannelOrderId": "string",
      "OrderType": 0,
      "CustomerId": "string",
      "SalesmanId": "string",
      "PriceTable": "string",
      "SalesOperationId": "string",
      "PaymentTypeId": "string",
      "TotalQuantity": 0,
      "TotalAmount": 0,
      "Discount": 0,
      "IsCanceled": true,
      "Observation": "string",
      "Date": "2024-07-22T17:55:35.463Z",
      "IsInvoiced": true,
      "IsCreated": true,
      "PaymentDiscount": 0,
      "User": "string",
      "DeliveryAddressId": 0,
      "ShipmentAmount": 0,
      "RecipientName": "string",
      "GiftMessage": "string",
      "Carrier": "string",
      "Tracking": "string",
      "IsStoreOnlyOperation": true,
      "CancelationReason": "string",
      "IsChecked": true,
      "SiteId": "string",
      "ShipmentType": "string",
      "ClearsaleStatus": "string",
      "CampaignId": 0,
      "DiscountId": "string",
      "FControlStatus": "string",
      "CampaignActionId": 0,
      "OrderExecutionStatus": 0,
      "B2CTransferStatus": 0,
      "IsScheduledDelivery": true,
      "DeliveryHours": "string",
      "DeliveryDate": "2024-07-22T17:55:35.463Z",
      "InvoiceDate": "2024-07-22T17:55:35.463Z",
      "UpdateDate": "2024-07-22T17:55:35.463Z",
      "IsLegalEntity": true,
      "AvoidsCPFECFRecording": true,
      "IsPrintedDAV": true,
      "IsPresale": 0,
      "IntermediaryId": 0,
      "OrderStatus": {
        "OrderId": 0,
        "OriginBranch": "string",
        "Status": "string"
      },
      "OrderItems": [
        {
          "ProductColorId": "string",
          "OrderId": 0,
          "OriginBranch": "string",
          "Item": 0,
          "Barcode": "string",
          "Size": "string",
          "Quantity": 0,
          "LiquidPrice": 0,
          "ItemDiscount": 0,
          "IsCanceled": true,
          "ProductId": "string",
          "SalesmanId": 0,
          "SaleQuantity": 0,
          "Giftwrap": true,
          "PersonalizationName": "string",
          "PersonalizationNumber": "string",
          "PersonalizationNameType": "string",
          "PersonalizationNumberType": "string",
          "Tracking": "string",
          "Checked": true,
          "CheckedQuantity": 0,
          "IsFutureDelivery": true,
          "IsEcommerceItem": true,
          "Quote": 0,
          "ReturnedQuantity": 0,
          "ThirdPartyQuantity": 0,
          "CreationDate": "2024-07-22T17:55:35.463Z"
        }
      ],
      "OrderPayments": [
        {
          "OrderId": 0,
          "OriginBranch": "string",
          "PaymentNumber": "string",
          "PaymentTypeId": "string",
          "Amount": 0,
          "DueDate": "2024-07-22T17:55:35.463Z",
          "TitleNumber": "string",
          "Bank": "string",
          "Currency": "string",
          "AdministratorId": "string",
          "ApprovalCode": "string",
          "Installments": 0,
          "ExchangeRate": 0,
          "IsPaymentCaptured": true,
          "CanceledAmount": 0,
          "CurrencyAmount": 0,
          "MoneyCashback": 0,
          "TacAmount": 0,
          "CreditCardCheck": "string",
          "PaymentDate": "2024-07-22T17:55:35.463Z"
        }
      ],
      "OrderGiftList": {
        "OrderId": 0,
        "OriginBranch": "string",
        "EventName": "string",
        "ContactName1": "string",
        "ContactName2": "string",
        "ContactName3": "string",
        "EventDate": "2024-07-22T17:55:35.463Z"
      },
      "ContactAddress": {
        "AddressId": 0,
        "AddressDescription": "string",
        "Country": "string",
        "ZipCode": "string",
        "Neighbourhood": "string",
        "City": "string",
        "AdditionalAddress": "string",
        "Number": "string",
        "Street": "string",
        "State": "string",
        "IsMainAddress": true,
        "ContactId": "string"
      },
      "Customer": {
        "CustomerName": "string",
        "CpfCnpj": "string",
        "Email": "string",
        "CustomerId": "string",
        "CustomerType": "string",
        "ContactId": "string",
        "BranchId": "string",
        "RgIe": "string",
        "Country": "string",
        "ZipCode": "string",
        "Neighbourhood": "string",
        "City": "string",
        "AdditionalAddress": "string",
        "Number": "string",
        "Street": "string",
        "State": "string",
        "IsIndividual": true,
        "RegisterDate": "2024-07-22T17:55:35.463Z",
        "DateOfBirth": "2024-07-22T17:55:35.463Z",
        "Gender": "string",
        "Telephone": "string",
        "TelephoneDistrictNumber": "string",
        "Mobile": "string",
        "MobileDistrictNumber": "string",
        "StreetType": "string",
        "NickName": "string",
        "HasNewsletter": "string",
        "HasNoCredit": true,
        "HasSPCRegister": true,
        "IsBlockedOnB2C": true,
        "FaxNumber": "string",
        "CreditLimit": 0,
        "TotalCreditLimit": 0,
        "Observation": "string",
        "Status": 0,
        "HasNoCheckAnalysis": true,
        "MaritalStatus": 0,
        "Profession": "string",
        "CustomerExecutionStatus": 0,
        "UpdateDate": "2024-07-22T17:55:35.463Z",
        "BillingAddressId": 0,
        "Contact": {
          "ContactId": "string",
          "ContactName": "string",
          "Email": "string",
          "Company": "string",
          "IsIndividual": true,
          "CpfCnpj": "string",
          "Gender": "string",
          "DateOfBirth": "2024-07-22T17:55:35.463Z",
          "IsRetailCustomer": true,
          "RegisterDate": "2024-07-22T17:55:35.463Z",
          "CompanyName": "string",
          "IsSystemUser": true,
          "IsThirdPartyCustomer": true,
          "IntegratesEmail": true,
          "IntegratesEmailWithCrm": true,
          "ExchangeWorkflow": true,
          "ExchangeCrm": true,
          "Telephone": "string",
          "Address": "string",
          "TelephoneInternationalDistrictNumber": "string",
          "TelephoneDistrictNumber": "string",
          "ZipCode": "string",
          "City": "string"
        }
      },
      "Shipments": [
        {
          "ShipmentId": 0,
          "ShipmentType": "string",
          "ShipmentDate": "2024-07-22T17:55:35.463Z",
          "ShipmentOrder": {
            "OrderId": 0,
            "BranchId": "string",
            "ShipmentId": 0
          }
        }
      ],
      "StockAccountingDate": "2024-07-22T17:55:35.463Z",
      "Invoices": [
        {
          "InvoiceId": "string",
          "InvoiceSerialNumber": "string",
          "BranchId": "string",
          "OperationId": "string",
          "IssueDate": "2024-07-22T17:55:35.463Z",
          "FulfillmentDate": "2024-07-22T17:55:35.463Z",
          "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-22T17:55:35.463Z",
          "CanceledAmount": 0,
          "OriginType": 0,
          "UniqueSequentialNumber": 0,
          "NsuGenerationDate": "2024-07-22T17:55:35.463Z",
          "EletronicInvoiceKey": "string",
          "EletronicInvoiceAuthorizationProtocol": "string",
          "EletronicInvoiceStatus": 0,
          "IsPriority": true,
          "EletronicInvoiceIssueType": 0,
          "EletronicInvoiceCancelationReason": "string",
          "IsEletronicInvoiceIssued": 0,
          "DpecRegistry": "string",
          "Pin": "string",
          "DpecIssueDate": "2024-07-22T17:55:35.463Z",
          "EletronicInvoiceCancelationProtocol": "string",
          "ContingencyDate": "2024-07-22T17:55:35.463Z",
          "ContingencyReason": "string",
          "ReferencedInvoiceId": "string",
          "ReferencedInvoiceSerialNumber": "string",
          "EletronicInvoiceEmail": "string",
          "ApproximatedTaxAmount": 0,
          "RecipientName": "string",
          "DeliveryAddressId": 0,
          "EletronicInvoiceAuthorazionDateHour": "2024-07-22T17:55:35.463Z",
          "IssueDateHour": "2024-07-22T17:55:35.463Z",
          "FulfillmentDateHour": "2024-07-22T17:55:35.463Z",
          "EletronicInvoiceAuthorazionDateUtc": "2024-07-22T17:55:35.463Z",
          "IssueDateUtc": 0,
          "FulfillmentDateUtc": 0,
          "InvoiceOperation": {
            "OperationId": "string",
            "Operation": "string",
            "OperationDescription": "string"
          },
          "RetailBranch": {
            "BranchId": "string",
            "BranchName": "string"
          },
          "InvoiceItems": [
            {
              "ProductColorId": "string",
              "InvoiceId": "string",
              "InvoiceSerialNumber": "string",
              "BranchId": "string",
              "ItemNumber": "string",
              "SubItemSize": 0,
              "ItemCode": "string",
              "Description": "string",
              "ProductId": "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"
            }
          ],
          "InvoiceXml": "string",
          "InvoiceOrder": {
            "OrderId": 0,
            "BranchId": "string",
            "InvoiceId": "string",
            "InvoiceSerialNumber": "string"
          }
        }
      ]
    }
  ]
}

Retorna uma lista de pedidos com informações detalhadas, incluindo paginação.

Solicitação Inválida (400)

Indica que ocorreu um erro na requisição, geralmente devido a parâmetros inválidos.

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

Não autorizado (401)

Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.

Erro Interno (500)


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

Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro fornece uma descrição do erro, e stackTrace pode conter informações adicionais para diagnóstico.

Endpoint GET /orders/salesChannelOrderId/{orderId} - Pesquisa por SalesChannelOrderId (pedido_id_origem)

GET /orders/salesChannelOrderId/{orderId}

Descrição

O endpoint GET /orders/salesChannelOrderId/{orderId} é utilizado para pesquisar pedidos por seu identificador único na origem (SalesChannelOrderId).

Parâmetros 

  • orderId (obrigatório): O identificador único do pedido na origem.
  • page_size (opcional): Quantidade de registros por página.
  • current_page (opcional): Página corrente.

Respostas

Sucesso (200)


{
  "Pagination": {
    "TotalCount": 0,
    "PageSize": 0,
    "CurrentPage": 0
  },
  "Items": [
    {
      "OrderId": 0,
      "OrderOriginId": "string",
      "DeliveryOriginId": "string",
      "OriginBranch": "string",
      "FulfillmentBranch": "string",
      "SalesChannelOrderId": "string",
      "OrderType": 0,
      "CustomerId": "string",
      "SalesmanId": "string",
      "PriceTable": "string",
      "SalesOperationId": "string",
      "PaymentTypeId": "string",
      "TotalQuantity": 0,
      "TotalAmount": 0,
      "Discount": 0,
      "IsCanceled": true,
      "Observation": "string",
      "Date": "2024-07-22T18:05:04.529Z",
      "IsInvoiced": true,
      "IsCreated": true,
      "PaymentDiscount": 0,
      "User": "string",
      "DeliveryAddressId": 0,
      "ShipmentAmount": 0,
      "RecipientName": "string",
      "GiftMessage": "string",
      "Carrier": "string",
      "Tracking": "string",
      "IsStoreOnlyOperation": true,
      "CancelationReason": "string",
      "IsChecked": true,
      "SiteId": "string",
      "ShipmentType": "string",
      "ClearsaleStatus": "string",
      "CampaignId": 0,
      "DiscountId": "string",
      "FControlStatus": "string",
      "CampaignActionId": 0,
      "OrderExecutionStatus": 0,
      "B2CTransferStatus": 0,
      "IsScheduledDelivery": true,
      "DeliveryHours": "string",
      "DeliveryDate": "2024-07-22T18:05:04.529Z",
      "InvoiceDate": "2024-07-22T18:05:04.529Z",
      "UpdateDate": "2024-07-22T18:05:04.529Z",
      "IsLegalEntity": true,
      "AvoidsCPFECFRecording": true,
      "IsPrintedDAV": true,
      "IsPresale": 0,
      "IntermediaryId": 0,
      "OrderStatus": {
        "OrderId": 0,
        "OriginBranch": "string",
        "Status": "string"
      },
      "OrderItems": [
        {
          "ProductColorId": "string",
          "OrderId": 0,
          "OriginBranch": "string",
          "Item": 0,
          "Barcode": "string",
          "Size": "string",
          "Quantity": 0,
          "LiquidPrice": 0,
          "ItemDiscount": 0,
          "IsCanceled": true,
          "ProductId": "string",
          "SalesmanId": 0,
          "SaleQuantity": 0,
          "Giftwrap": true,
          "PersonalizationName": "string",
          "PersonalizationNumber": "string",
          "PersonalizationNameType": "string",
          "PersonalizationNumberType": "string",
          "Tracking": "string",
          "Checked": true,
          "CheckedQuantity": 0,
          "IsFutureDelivery": true,
          "IsEcommerceItem": true,
          "Quote": 0,
          "ReturnedQuantity": 0,
          "ThirdPartyQuantity": 0,
          "CreationDate": "2024-07-22T18:05:04.529Z"
        }
      ],
      "OrderPayments": [
        {
          "OrderId": 0,
          "OriginBranch": "string",
          "PaymentNumber": "string",
          "PaymentTypeId": "string",
          "Amount": 0,
          "DueDate": "2024-07-22T18:05:04.529Z",
          "TitleNumber": "string",
          "Bank": "string",
          "Currency": "string",
          "AdministratorId": "string",
          "ApprovalCode": "string",
          "Installments": 0,
          "ExchangeRate": 0,
          "IsPaymentCaptured": true,
          "CanceledAmount": 0,
          "CurrencyAmount": 0,
          "MoneyCashback": 0,
          "TacAmount": 0,
          "CreditCardCheck": "string",
          "PaymentDate": "2024-07-22T18:05:04.529Z"
        }
      ],
      "OrderGiftList": {
        "OrderId": 0,
        "OriginBranch": "string",
        "EventName": "string",
        "ContactName1": "string",
        "ContactName2": "string",
        "ContactName3": "string",
        "EventDate": "2024-07-22T18:05:04.529Z"
      },
      "ContactAddress": {
        "AddressId": 0,
        "AddressDescription": "string",
        "Country": "string",
        "ZipCode": "string",
        "Neighbourhood": "string",
        "City": "string",
        "AdditionalAddress": "string",
        "Number": "string",
        "Street": "string",
        "State": "string",
        "IsMainAddress": true,
        "ContactId": "string"
      },
      "Customer": {
        "CustomerName": "string",
        "CpfCnpj": "string",
        "Email": "string",
        "CustomerId": "string",
        "CustomerType": "string",
        "ContactId": "string",
        "BranchId": "string",
        "RgIe": "string",
        "Country": "string",
        "ZipCode": "string",
        "Neighbourhood": "string",
        "City": "string",
        "AdditionalAddress": "string",
        "Number": "string",
        "Street": "string",
        "State": "string",
        "IsIndividual": true,
        "RegisterDate": "2024-07-22T18:05:04.529Z",
        "DateOfBirth": "2024-07-22T18:05:04.529Z",
        "Gender": "string",
        "Telephone": "string",
        "TelephoneDistrictNumber": "string",
        "Mobile": "string",
        "MobileDistrictNumber": "string",
        "StreetType": "string",
        "NickName": "string",
        "HasNewsletter": "string",
        "HasNoCredit": true,
        "HasSPCRegister": true,
        "IsBlockedOnB2C": true,
        "FaxNumber": "string",
        "CreditLimit": 0,
        "TotalCreditLimit": 0,
        "Observation": "string",
        "Status": 0,
        "HasNoCheckAnalysis": true,
        "MaritalStatus": 0,
        "Profession": "string",
        "CustomerExecutionStatus": 0,
        "UpdateDate": "2024-07-22T18:05:04.529Z",
        "BillingAddressId": 0,
        "Contact": {
          "ContactId": "string",
          "ContactName": "string",
          "Email": "string",
          "Company": "string",
          "IsIndividual": true,
          "CpfCnpj": "string",
          "Gender": "string",
          "DateOfBirth": "2024-07-22T18:05:04.529Z",
          "IsRetailCustomer": true,
          "RegisterDate": "2024-07-22T18:05:04.529Z",
          "CompanyName": "string",
          "IsSystemUser": true,
          "IsThirdPartyCustomer": true,
          "IntegratesEmail": true,
          "IntegratesEmailWithCrm": true,
          "ExchangeWorkflow": true,
          "ExchangeCrm": true,
          "Telephone": "string",
          "Address": "string",
          "TelephoneInternationalDistrictNumber": "string",
          "TelephoneDistrictNumber": "string",
          "ZipCode": "string",
          "City": "string"
        }
      },
      "Shipments": [
        {
          "ShipmentId": 0,
          "ShipmentType": "string",
          "ShipmentDate": "2024-07-22T18:05:04.529Z",
          "ShipmentOrder": {
            "OrderId": 0,
            "BranchId": "string",
            "ShipmentId": 0
          }
        }
      ],
      "StockAccountingDate": "2024-07-22T18:05:04.529Z",
      "Invoices": [
        {
          "InvoiceId": "string",
          "InvoiceSerialNumber": "string",
          "BranchId": "string",
          "OperationId": "string",
          "IssueDate": "2024-07-22T18:05:04.529Z",
          "FulfillmentDate": "2024-07-22T18:05:04.529Z",
          "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:05:04.529Z",
          "CanceledAmount": 0,
          "OriginType": 0,
          "UniqueSequentialNumber": 0,
          "NsuGenerationDate": "2024-07-22T18:05:04.529Z",
          "EletronicInvoiceKey": "string",
          "EletronicInvoiceAuthorizationProtocol": "string",
          "EletronicInvoiceStatus": 0,
          "IsPriority": true,
          "EletronicInvoiceIssueType": 0,
          "EletronicInvoiceCancelationReason": "string",
          "IsEletronicInvoiceIssued": 0,
          "DpecRegistry": "string",
          "Pin": "string",
          "DpecIssueDate": "2024-07-22T18:05:04.529Z",
          "EletronicInvoiceCancelationProtocol": "string",
          "ContingencyDate": "2024-07-22T18:05:04.529Z",
          "ContingencyReason": "string",
          "ReferencedInvoiceId": "string",
          "ReferencedInvoiceSerialNumber": "string",
          "EletronicInvoiceEmail": "string",
          "ApproximatedTaxAmount": 0,
          "RecipientName": "string",
          "DeliveryAddressId": 0,
          "EletronicInvoiceAuthorazionDateHour": "2024-07-22T18:05:04.529Z",
          "IssueDateHour": "2024-07-22T18:05:04.529Z",
          "FulfillmentDateHour": "2024-07-22T18:05:04.529Z",
          "EletronicInvoiceAuthorazionDateUtc": "2024-07-22T18:05:04.529Z",
          "IssueDateUtc": 0,
          "FulfillmentDateUtc": 0,
          "InvoiceOperation": {
            "OperationId": "string",
            "Operation": "string",
            "OperationDescription": "string"
          },
          "RetailBranch": {
            "BranchId": "string",
            "BranchName": "string"
          },
          "InvoiceItems": [
            {
              "ProductColorId": "string",
              "InvoiceId": "string",
              "InvoiceSerialNumber": "string",
              "BranchId": "string",
              "ItemNumber": "string",
              "SubItemSize": 0,
              "ItemCode": "string",
              "Description": "string",
              "ProductId": "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"
            }
          ],
          "InvoiceXml": "string",
          "InvoiceOrder": {
            "OrderId": 0,
            "BranchId": "string",
            "InvoiceId": "string",
            "InvoiceSerialNumber": "string"
          }
        }
      ]
    }
  ]
}

Retorna uma lista de pedidos com informações detalhadas, incluindo paginação.

Solicitação Inválida (400)

Indica que ocorreu um erro na requisição, geralmente devido a parâmetros inválidos.

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

Não autorizado (401)

Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.

Erro Interno (500)


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

Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro fornece uma descrição do erro, e stackTrace pode conter informações adicionais para diagnóstico.

Exemplo do Swagger: