v1

latestOpenAPI 3.0.12026-07-24373659.1 KB

Pedidos

Listar pedidos

get/api/v1/salesOrders

Query parameters

numberinteger

Número do pedido de venda.

issueStartDatestring

Data inicial de emissão do pedido.

issueEndDatestring

Data final de emissão do pedido.

customerIdinteger

Identificador único do cliente no Base.

externalReferencestring

Identificador único do pedido no seu sistema.

pageinteger

sizeinteger

Response

totalElementsinteger

totalPagesinteger

lastboolean

numberOfElementsinteger

firstboolean

sizeinteger

numberinteger

emptyboolean

Example response

{
  "content": [
    {
      "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
    }
  ]
}