Get an order

GET/client_api/v2/orders/{id}

Path parameters

idinteger or stringRequired
The order's id. A reference number does not work here.
Read the ids from List orders in the environment you are calling: they differ between the sandbox and production.

Returns

Returns the order.

Errors

400Bad Request
The request body isn't valid JSON, or something failed on our side.
401Unauthorized
The token is missing, expired or invalid. Sign in again.
404Not Found
The record doesn't exist, or belongs to another company.

View as Markdown

GET /client_api/v2/orders/{id}

1curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/orders/0" \
2  -H "Authorization: Bearer $API_TOKEN"

Response

{
  "order": {
    "id": 24,
    "assigned_admin": null,
    "battery_declaration_link": "",
    "broker_address": null,
    "ccd_status": "ccd_not_required",
    "commercial_invoice_link": "",
    "created_at": "2026/10/23 07:14:46 UTC",
    "customer_reference": "GTC-PO-20417",
    "customs_clearance_document_link": "",
    "date_delivered": null,
    "description_of_contents": "Cotton shirts and denim trousers",
    "destination_address": {
      "id": 116,
      "address_1": "221 Shoreditch High Street",
      "address_2": "Floor 2",
      "address_3": null,
      "city": "London",
      "classification": "business",
      "company": "Bennett & Hale Ltd",
      "country": {
        "id": 18,
        "default_postal_code": null,
        "dhl_export_code": null,
        "dhl_import_code": null,
        "dhl_tax_code": null,
        "export_code_label": "Export Number",
        "import_code_label": "Importer Code",
        "iso_code_2": "GB",
        "iso_code_3": "GBR",
        "name": "United Kingdom",
        "postal_code_required": true,
        "tax_number_label": "Tax Number",
        "vat_rate": 0.17
      },
      "country_id": 18,
      "email": "goods-in@bennetthale.example",
      "import_code": null,
      "latitude": null,
      "longitude": null,
      "name": "Oliver Bennett",
      "phone": "+442079460321",
      "postal_code": "E1 6PJ",
      "province": "Greater London",
      "summary": "United Kingdom",
      "tax_number": null,
      "time_zone_id": null
    },
    "draft_bill_of_lading_link": "",
    "eei_eligible": false,
    "eei_request_document_link": "",
    "export_permit_link": "",
    "final_bill_of_lading_link": "",
    "importer_of_record_address": null,
    "internal_transaction_number": null,
    "invoice_data": {
      "billable_weights": {
        "metric": {
          "packages": 1,
          "mass_unit": "kg",
          "distance_unit": "cm",
          "volumetric_weight": 16.8,
          "weight": 12.5,
          "billable_weight": 16.8,
          "volume": 0.084
        },
        "imperial": {
          "packages": 1,
          "mass_unit": "lb",
          "distance_unit": "inches",
          "volumetric_weight": 37.04,
          "weight": 27.56,
          "billable_weight": 37.04,
          "volume": 2.9664316254643865
        }
      },
      "estimate_id": 19,
      "line_items": [
        {
          "cost": 2184.5,
          "currency_id": "ZAR",
          "description": "Freight"
        },
        {
          "cost": 393.21,
          "currency_id": "ZAR",
          "description": "Fuel surcharge"
        },
        {
          "cost": 450,
          "currency_id": "ZAR",
          "description": "Customs clearance"
        }
      ],
      "quote_expired": false,
      "shipping_company": "FedEx South Africa",
      "shipping_service": "International Priority"
    },
    "invoice_number": null,
    "materials_safety_data_sheet_link": "",
    "measured_weight": 0,
    "origin_address": {
      "id": 115,
      "address_1": "14 Bree Street",
      "address_2": "Unit 3",
      "address_3": null,
      "city": "Cape Town",
      "classification": "business",
      "company": "Global Trade Corp",
      "country": {
        "id": 17,
        "default_postal_code": null,
        "dhl_export_code": null,
        "dhl_import_code": null,
        "dhl_tax_code": null,
        "export_code_label": "Export Number",
        "import_code_label": "Importer Code",
        "iso_code_2": "ZA",
        "iso_code_3": "ZAF",
        "name": "South Africa",
        "postal_code_required": true,
        "tax_number_label": "Tax Number",
        "vat_rate": 0.17
      },
      "country_id": 17,
      "email": "dispatch@globaltradecorp.example",
      "import_code": null,
      "latitude": null,
      "longitude": null,
      "name": "Thandi Mokoena",
      "phone": "+27215550142",
      "postal_code": "8001",
      "province": "Western Cape",
      "summary": "South Africa",
      "tax_number": null,
      "time_zone_id": null
    },
    "packaging_list_link": "",
    "pickup_date": null,
    "pickup_instructions": "",
    "proof_of_delivery_link": "",
    "purpose_of_shipment_id": 50,
    "quote_id": 24,
    "reference_number": "MYSGLO001000001",
    "scheduled_pickup": "",
    "send_consignee_tracking_details": false,
    "shipments": [
      {
        "shipping_service": "International Priority",
        "status": "order_received",
        "tracking_link": null,
        "waybill": null,
        "waybill_document_link": ""
      }
    ],
    "shippers_letter_of_instruction_link": "",
    "status": "order_received",
    "stream_packing_list_link": "",
    "tracking_link": null,
    "value_of_goods": 18500,
    "value_of_goods_currency": "ZAR",
    "waybill": null,
    "waybill_document_link": ""
  }
}