Sign in

v1

latestOpenAPI 3.0.12026-07-24373659.1 KB
Pedidos

Recuperar um único pedido

get/api/v1/salesOrders/{id}

Path parameters

idinteger required

Identificador único do pedido no Base.

Response

OK

numberinteger

Número do pedido de venda.

issueDatestring date required

Data de emissão do pedido.

customerIdinteger required

Identificador único do cliente no Base.

observationsstring

Observações adicionais.

externalReferencestring

Identificador único do pedido no seu sistema.

typeOfShipping'EMITENTE' | 'DESTINATARIO' | 'TERCEIROS' | 'SEM_FRETE'

Modalidade do frete.

shippingCompanyIdinteger

Identificador único da transportadora no Base.

costOfShippingnumber

Valor total do frete para o pedido.

discountValuenumber

Valor total desconto para o pedido.

itemsValuenumber

Total dos itens.

orderValuenumber

Total do pedido.

idinteger

Identificador único do pedido no Base.

invoiceNumberinteger

Número da nota fiscal.

invoiceIdinteger

Identificador único da nota fiscal no Base.

invoiceStatus'GRAVADA' | 'ENVIADA' | 'CANCELADA' | 'INUTILIZADA' | 'CONTIGENCIA' | 'PENDENTE' | 'PENDENTE_ENVIO_NOTAS' | 'PENDENTE_ENVIO_NFE_A3' | 'ENVIO_CARTA_CORRECAO' | 'EM_PROCESSO_AUTORIZACAO' | 'EM_PROCESSO_CANCELAMENTO' | 'NEGADA' | 'CANCELAMENTO_NEGADO' | 'DENEGADA' | 'ERRO_ENVIO' | 'NOTA_AUTORIZADA_DFE' | 'INICIADA' | 'PROCESSANDO' | 'EMITIDA' | 'REJEITADA' | 'AJUSTES_NECESSARIOS'

Situação da nota Fiscal.

Example response

{
  "number": 123456,
  "issueDate": "2024-01-20",
  "customerId": 109988777,
  "observations": "Entregar na portaria e solicitar a assinatura do canhoto da nota fiscal",
  "externalReference": "544222",
  "typeOfShipping": "EMITENTE",
  "shippingCompanyId": 109988777,
  "costOfShipping": 3.05,
  "discountValue": 5.65,
  "orderItems": [
    {
      "productId": 1234567890,
      "unitPrice": 10.22,
      "quantity": 3,
      "costOfShipping": 3.05,
      "discountValue": 5.65,
      "itemValue": 25.01,
      "cClassTrib": "000001"
    }
  ],
  "orderPayments": [
    {
      "dueDate": "2024-01-20",
      "receiptDate": "2024-01-18",
      "value": 28.06,
      "bankId": 1099999997,
      "billingType": "BOLETO",
      "paymentId": "pay_080225913252",
      "numberInstallments": 2
    }
  ],
  "itemsValue": 25.01,
  "orderValue": 28.06,
  "id": 10040055
}