Skip to main content

Get order details

note

The id and the other values in this example are placeholders — replace them with your own.

Use order query to retrieve a single order by ID. This example reads the order itself in full: the order fields (identifiers, dates, status, channel, payment data and totals), its lines, the billing details and the shippings with their carrier, shipping lines and fulfilment lines, and parcels. The entities that have their own guide are referenced by id only: the warehouse, the item lines a warehouse fulfils (itemLines), the labels, the proforma, the fiscal and accounting documents, the sale transactions and the repayment requests (returns). Select only the parts you need: the query complexity grows with every field (see Rate limiting).

The order and shipping statuses, the identifiers, the dates and the totals are explained in Things to know about orders. Lines of kind coupon carry an order-level discount as a negative price; line-level discounts are already included in discountedUnitaryPrice. To read the referenced entities in full: Warehouse queries for the warehouse, Get the order documents for the fiscal document, the accounting documents, the proforma and the labels, Query external transactions and disputes for the transactions and Get repayment request details for the repayment requests. The shipping lines, the item lines, the fulfilment lines and the parcels are what the warehouse declares in Confirm or cancel a fulfilment.

Request
query orderDetails {
  order(id: "12345") {
    id
    createdAt
    updatedAt
    receivedAt
    paidAt
    cancelledAt
    number
    deliveryId
    status
    channel {
      id
      code
      name
      platform
    }
    currency
    paymentMethod
    note
    invoiceRequired
    documentationLanguage
    totalNetAmount
    totalVatAmount
    totalGrossAmount
    totalPaidAmount
    lines {
      id
      kind
      quantity
      sku
      skuDescription
      number
      originalUnitaryPrice
      discountedUnitaryPrice
      vatPercentage
      unitaryVatAmount
    }
    billing {
      id
      firstName
      lastName
      email
      address1
      address2
      city
      zipCode
      province
      country
      isoCountry
      companyName
      telephone
      pec
      destinationCode
      fiscalCode
      vatNumber
      currency
      exchangeRate
    }
    shippings {
      id
      number
      firstName
      lastName
      email
      address1
      address2
      city
      zipCode
      province
      country
      isoCountry
      companyName
      telephone
      status
      fulfillmentStatus
      bookingStatus
      carrier {
        id
        code
        name
      }
      carrierName
      trackingNumber
      trackingUrl
      warehouse {
        # id only, detailed in Warehouse queries
        id
      }
      lines {
        id
        quantity
        fulfilledQuantity
        unfulfilledQuantity
        orderLine {
          id
        }
        fulfillmentLines {
          id
          quantity
          serialNumber
          batch {
            id
            number
          }
        }
      }
      itemLines {
        # id only, detailed in Confirm or cancel a fulfilment
        id
      }
      parcels {
        id
        kind
        weight
        length
        width
        height
        tailLiftRequired
      }
      labels {
        # id only, detailed in Get the order documents
        id
      }
      proforma {
        # id only, detailed in Get the order documents
        id
      }
    }
    fiscalDocument {
      # id only, detailed in Get the order documents
      id
    }
    accountingDocuments {
      # id only, detailed in Get the order documents
      id
    }
    saleTransactions {
      # id only, detailed in Query external transactions and disputes
      id
    }
    repaymentRequests {
      # id only, detailed in Get repayment request details
      id
    }
  }
}
Response
{
  "data": {
    "order": {
      "id": "12345",
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-01-28T14:20:00.000Z",
      "receivedAt": "2026-01-15T10:31:00.000Z",
      "paidAt": "2026-01-15T10:32:00.000Z",
      "cancelledAt": null,
      "number": "36351",
      "deliveryId": "UWGDLUDLU",
      "status": "delivered",
      "channel": {
        "id": "1",
        "code": "ECOM",
        "name": "Web shop",
        "platform": "shopify"
      },
      "currency": "EUR",
      "paymentMethod": "credit_card",
      "note": null,
      "invoiceRequired": false,
      "documentationLanguage": "IT",
      "totalNetAmount": 180.0,
      "totalVatAmount": 39.6,
      "totalGrossAmount": 219.6,
      "totalPaidAmount": 219.6,
      "lines": [
        {
          "id": "987",
          "kind": "item",
          "quantity": 2,
          "sku": "SKU-1",
          "skuDescription": "Demo product",
          "number": "1",
          "originalUnitaryPrice": 100.0,
          "discountedUnitaryPrice": 90.0,
          "vatPercentage": 22.0,
          "unitaryVatAmount": 19.8
        }
      ],
      "billing": {
        "id": "456",
        "firstName": "Mario",
        "lastName": "Rossi",
        "email": "example@example.com",
        "address1": "Via Roma 1",
        "address2": null,
        "city": "Treviso",
        "zipCode": "31100",
        "province": "TV",
        "country": "Italy",
        "isoCountry": "IT",
        "companyName": "Company",
        "telephone": "0039000000000",
        "pec": "example@example.pec.it",
        "destinationCode": "ABC1234",
        "fiscalCode": "ABCDEFG00A00L407A",
        "vatNumber": "12345678901",
        "currency": "EUR",
        "exchangeRate": 1.0
      },
      "shippings": [
        {
          "id": "789",
          "number": "1",
          "firstName": "Mario",
          "lastName": "Rossi",
          "email": "shipping@example.com",
          "address1": "Via Milano 2",
          "address2": "Scala B",
          "city": "Milano",
          "zipCode": "20100",
          "province": "MI",
          "country": "Italy",
          "isoCountry": "IT",
          "companyName": "Company",
          "telephone": "0039111111111",
          "status": "delivered",
          "fulfillmentStatus": "completed",
          "bookingStatus": "confirmed",
          "carrier": {
            "id": "3",
            "code": "DHL",
            "name": "DHL Express"
          },
          "carrierName": "DHL",
          "trackingNumber": "IT2206513911",
          "trackingUrl": "https://track.example.test/IT2206513911",
          "warehouse": {
            "id": "12"
          },
          "lines": [
            {
              "id": "1001",
              "quantity": 2,
              "fulfilledQuantity": 2,
              "unfulfilledQuantity": 0,
              "orderLine": {
                "id": "987"
              },
              "fulfillmentLines": [
                {
                  "id": "33",
                  "quantity": 2,
                  "serialNumber": null,
                  "batch": {
                    "id": "7",
                    "number": "LOT-2026-01"
                  }
                }
              ]
            }
          ],
          "itemLines": [
            {
              "id": "1001"
            }
          ],
          "parcels": [
            {
              "id": "150",
              "kind": "box",
              "weight": 2500.0,
              "length": 40.0,
              "width": 30.0,
              "height": 20.0,
              "tailLiftRequired": false
            }
          ],
          "labels": [
            {
              "id": "904"
            }
          ],
          "proforma": {
            "id": "903"
          }
        }
      ],
      "fiscalDocument": {
        "id": "902"
      },
      "accountingDocuments": [
        {
          "id": "902"
        }
      ],
      "saleTransactions": [
        {
          "id": "3410"
        }
      ],
      "repaymentRequests": [
        {
          "id": "567"
        }
      ]
    }
  },
  "extensions": {
    "queryComplexity": 118,
    "bucketBalance": 9882,
    "bucketRestoreRate": 100
  }
}

Relevant permissions

The operations in this page require the following permissions on the API credentials — they are configured for you by Calicantus.

  • order:query:order
  • order:read
  • channel:read
  • order_line:read
  • billing:read
  • shipping:read
  • warehouse:read
  • shipping_label:read
  • accounting_proforma:read
  • accounting_document:read
  • payment_transaction:read
  • repayment_request:read
  • shipping_carrier:read
  • shipping_line:read
  • shipping_parcel:read
  • fulfillment_line:read
  • stock_batch:read