Create an order

POST/client_api/v2/orders

Book one of a quote's estimates. The order starts as order_received; ask for its waybill next.

Parameters

orderobjectRequired
The order to place.

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.
422Unprocessable Content
The request was refused. error says why in one sentence, and errors lists each reason.

View as Markdown

POST /client_api/v2/orders

1curl -X POST "https://sandbox-api.vatit-stream.com/client_api/v2/orders" \
2  -H "Authorization: Bearer $API_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "order": {
6      "quote_estimate_id": 16,
7      "purpose_of_shipment_id": 50,
8      "customer_reference": "GTC-PO-20417",
9      "description_of_contents": "Cotton shirts and denim trousers",
10      "origin_address": {
11        "name": "Thandi Mokoena",
12        "company": "Global Trade Corp",
13        "address_1": "14 Bree Street",
14        "address_2": "Unit 3",
15        "city": "Cape Town",
16        "province": "Western Cape",
17        "postal_code": "8001",
18        "country_id": 17,
19        "email": "dispatch@globaltradecorp.example",
20        "phone": "+27 21 555 0142",
21        "classification": "business"
22      },
23      "destination_address": {
24        "name": "Oliver Bennett",
25        "company": "Bennett & Hale Ltd",
26        "address_1": "221 Shoreditch High Street",
27        "address_2": "Floor 2",
28        "city": "London",
29        "province": "Greater London",
30        "postal_code": "E1 6PJ",
31        "country_id": 18,
32        "email": "goods-in@bennetthale.example",
33        "phone": "+44 20 7946 0321",
34        "classification": "business"
35      }
36    }
37  }'

Response

{
  "order": {
    "id": 21,
    "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": 98,
      "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": 16,
      "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": 97,
      "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": 21,
    "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": ""
  }
}