Schema

Order

The Order object of the Printags API.

Fields

  • idstring (uuid)
  • referencestring
  • accountIdstring
  • statusstring
  • customerCustomer
  • shipToAddress
  • statusHistoryarray of object
  • statusHistory[].idstring (uuid)
  • statusHistory[].statusstring
  • statusHistory[].createdAtstring (date-time)
  • unitsarray of Unit
  • itemsarray of Item
  • metadataobject, nullable
    Additional metadata for the order
  • shipmentsarray of Shipment
    Shipping information associated with the order
  • totalnumber
  • filesarray of object
    The documents shipped with the order (shippingFiles of createOrder). Returned by getOrder only.
  • files[].idstring (uuid)
  • files[].mimeTypestring
  • files[].sizeinteger
    Size in bytes
  • files[].filenamestring
  • files[].createdAtstring (date-time)
Example
{
  "id": "987e6543-e21a-11d4-a789-0242ac120002",
  "reference": "Order-JeanDupont-2024",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "created",
  "customer": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "firstname": "Jean",
    "lastname": "Dupont",
    "company": "Dupont Entreprises",
    "accountId": "c10e4fdf-a77d-457c-8fd6-2c0b29214800",
    "createdAt": "2024-07-01T09:26:55.737Z"
  },
  "shipTo": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Jean Dupont",
    "phone": "+33612345678",
    "email": "[email protected]",
    "address": {
      "addressLine1": "10 rue de la République",
      "addressLine2": "Appartement 123",
      "city": "Paris",
      "postcode": "75001",
      "countryCode": "FR"
    },
    "servicePoint": {
      "id": "12624766",
      "country": "LU"
    }
  },
  "statusHistory": [
    {
      "id": "987e6543-e21a-11d4-a789-0242ac120002",
      "status": "created",
      "createdAt": "2024-07-01T09:26:55.737Z"
    }
  ],
  "units": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": [],
      "files": [],
      "status": "created",
      "shipments": [],
      "createdAt": "2024-04-08T13:22:37.000Z"
    }
  ],
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productId": "ntag424_pvccard_white",
      "name": "Jean Dupont",
      "quantity": 10
    }
  ],
  "shipments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "trackerId": "1234567890",
      "trackingNumber": "1Z999AA10123456784",
      "unitsByProduct": {
        "ntag424_pvccard_white": 4
      }
    }
  ],
  "total": 50.99,
  "files": [
    {
      "id": "3f1c2b7a-5d4e-4f60-9a8b-1c2d3e4f5a6b",
      "mimeType": "application/pdf",
      "size": 48213,
      "filename": "letter.pdf",
      "createdAt": "2026-11-16T09:26:55.737Z"
    }
  ]
}