Get Order Details

Fetch order detail

get/v1/orders/order/{order_id}

Path parameters

order_idstring uuid required

Response

Successful Response

customer_reference_numberstring nullable

planning_instructionsstring nullable

Additional freeform instructions for the planner.

neutral_order_type'NO_NEUTRAL_ORDER' | 'MASK_DELIVERY' | 'MASK_PICKUP' nullable

Neutral order

custom_fieldsobject nullable

User defined additional fields for this order.

contact_emailsstring[] nullable

List of contact emails to notify about the order

is_consignment_info_validatedboolean nullable

Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it.

order_identifierstring nullable

Identifier of the order when created from an external source

idstring uuid required

Unique identifier for order

created_by_userstring nullable

User who created the order

created_timestampstring date-time nullable

Timestamp of creation

quote_namestring nullable

Name of the quote

Example response

{
  "import_export": {
    "destination_country_of_goods": "BE",
    "origin_country_of_goods": "BE"
  },
  "stops": [
    {
      "time_window": {
        "start_time": "09:30",
        "end_time": "16:30"
      },
      "date": "2024-12-31",
      "depot": {
        "unload_timestamp": "2024-12-31T14:30:00Z",
        "load_timestamp": "2024-12-31T08:00:00Z"
      },
      "location": {
        "code": "LOC123",
        "display_name": "Main Office",
        "address": "Gaston Crommenlaan 4",
        "city": "Ghent",
        "country": "BE",
        "postal_code": "9050",
        "name": "Qargo HQ"
      },
      "end_timestamp": "2024-12-31T08:15:00Z",
      "start_timestamp": "2024-12-31T08:00:00Z",
      "status": "PLANNED"
    }
  ],
  "consignments": [
    {
      "pickup_stop": {
        "time_window": {
          "start_time": "09:30",
          "end_time": "16:30"
        },
        "date": "2024-12-31",
        "depot": {
          "unload_timestamp": "2024-12-31T14:30:00Z",
          "load_timestamp": "2024-12-31T08:00:00Z"
        },
        "location": {
          "code": "LOC123",
          "display_name": "Main Office",
          "address": "Gaston Crommenlaan 4",
          "city": "Ghent",
          "country": "BE",
          "postal_code": "9050",
          "name": "Qargo HQ"
        },
        "end_timestamp": "2024-12-31T08:15:00Z",
        "start_timestamp": "2024-12-31T08:00:00Z",
        "status": "PLANNED"
      },
      "delivery_stop": {
        "time_window": {
          "start_time": "09:30",
          "end_time": "16:30"
        },
        "date": "2024-12-31",
        "depot": {
          "unload_timestamp": "2024-12-31T14:30:00Z",
          "load_timestamp": "2024-12-31T08:00:00Z"
        },
        "location": {
          "code": "LOC123",
          "display_name": "Main Office",
          "address": "Gaston Crommenlaan 4",
          "city": "Ghent",
          "country": "BE",
          "postal_code": "9050",
          "name": "Qargo HQ"
        },
        "end_timestamp": "2024-12-31T08:15:00Z",
        "start_timestamp": "2024-12-31T08:00:00Z",
        "status": "PLANNED"
      },
      "goods": [
        {
          "packaged_items": [
            {
              "adr": {
                "adr_name_by_locale": {
                  "de-DE": "SALZSÄURE",
                  "en": "HYDROCHLORIC ACID"
                },
                "technical_name_by_locale": {
                  "de-DE": "NEG Stoffname",
                  "en": "NEG Substance name",
                  "fr-FR": "NEG Nom de la substance",
                  "nl-BE": "NEG Stofnaam"
                }
              }
            }
          ]
        }
      ],
      "buyer": {
        "company": {
          "name": "Qargo",
          "legal_name": "Qargo Ltd",
          "code": "QARGO",
          "contacts": [
            {
              "name": "John Doe",
              "phone_number": "+32485123456"
            }
          ],
          "locale": "en",
          "billing_location": {
            "code": "LOC123",
            "display_name": "Main Office",
            "address": "Gaston Crommenlaan 4",
            "city": "Ghent",
            "country": "BE",
            "postal_code": "9050",
            "name": "Qargo HQ"
          },
          "note": "Additional notes"
        }
      },
      "seller": {
        "company": {
          "name": "Qargo",
          "legal_name": "Qargo Ltd",
          "code": "QARGO",
          "contacts": [
            {
              "name": "John Doe",
              "phone_number": "+32485123456"
            }
          ],
          "locale": "en",
          "billing_location": {
            "code": "LOC123",
            "display_name": "Main Office",
            "address": "Gaston Crommenlaan 4",
            "city": "Ghent",
            "country": "BE",
            "postal_code": "9050",
            "name": "Qargo HQ"
          },
          "note": "Additional notes"
        }
      }
    }
  ],
  "pricing": {
    "by_currency": {
      "EUR": {
        "total_excl_tax": "100.00"
      }
    }
  },
  "customer": {
    "currency": "EUR",
    "name": "John Doe",
    "legal_name": "John Doe",
    "vat_number": "BE1234.123.123",
    "accounting_code": "1234",
    "billing_location": {
      "code": "LOC123",
      "display_name": "Main Office",
      "address": "Gaston Crommenlaan 4",
      "city": "Ghent",
      "country": "BE",
      "postal_code": "9050",
      "name": "Qargo HQ"
    },
    "locale": "en",
    "contacts": [
      {
        "name": "John Doe",
        "phone_number": "+32485123456"
      }
    ]
  },
  "start_stop": {
    "time_window": {
      "start_time": "09:30",
      "end_time": "16:30"
    },
    "date": "2024-12-31",
    "depot": {
      "unload_timestamp": "2024-12-31T14:30:00Z",
      "load_timestamp": "2024-12-31T08:00:00Z"
    },
    "location": {
      "code": "LOC123",
      "display_name": "Main Office",
      "address": "Gaston Crommenlaan 4",
      "city": "Ghent",
      "country": "BE",
      "postal_code": "9050",
      "name": "Qargo HQ"
    },
    "end_timestamp": "2024-12-31T08:15:00Z",
    "start_timestamp": "2024-12-31T08:00:00Z",
    "status": "PLANNED"
  },
  "end_stop": {
    "time_window": {
      "start_time": "09:30",
      "end_time": "16:30"
    },
    "date": "2024-12-31",
    "depot": {
      "unload_timestamp": "2024-12-31T14:30:00Z",
      "load_timestamp": "2024-12-31T08:00:00Z"
    },
    "location": {
      "code": "LOC123",
      "display_name": "Main Office",
      "address": "Gaston Crommenlaan 4",
      "city": "Ghent",
      "country": "BE",
      "postal_code": "9050",
      "name": "Qargo HQ"
    },
    "end_timestamp": "2024-12-31T08:15:00Z",
    "start_timestamp": "2024-12-31T08:00:00Z",
    "status": "PLANNED"
  },
  "container_load_unload_stop": {
    "time_window": {
      "start_time": "09:30",
      "end_time": "16:30"
    },
    "date": "2024-12-31",
    "depot": {
      "unload_timestamp": "2024-12-31T14:30:00Z",
      "load_timestamp": "2024-12-31T08:00:00Z"
    },
    "location": {
      "code": "LOC123",
      "display_name": "Main Office",
      "address": "Gaston Crommenlaan 4",
      "city": "Ghent",
      "country": "BE",
      "postal_code": "9050",
      "name": "Qargo HQ"
    },
    "end_timestamp": "2024-12-31T08:15:00Z",
    "start_timestamp": "2024-12-31T08:00:00Z",
    "status": "PLANNED"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.