Sign in
API / Order
Use case / Order
Use case / Customer portal

Import Order

Create or update orders in Qargo. See the "Transport order creation & status" section for more info.

post/v1/orders/order/upload

Request body

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.

operation'CREATE' | 'UPDATE' | 'DELETE' required
order_identifierstring required

Identifier of the order when created from an external source

input_sourcestring nullable

Source of this order input

order_status'QUOTE' | 'TO_PLAN'

Example request

{
  "import_export": {
    "destination_country_of_goods": "BE",
    "origin_country_of_goods": "BE"
  },
  "consignments": [
    {
      "pickup_stop": {
        "time_window": {
          "start_time": "09:30",
          "end_time": "16:30"
        },
        "date": "2024-12-31",
        "location": {
          "code": "LOC123",
          "display_name": "Main Office",
          "address": "Gaston Crommenlaan 4",
          "city": "Ghent",
          "country": "BE",
          "postal_code": "9050",
          "name": "Qargo HQ"
        },
        "drop_collect_empty": {
          "location": {
            "code": "LOC123",
            "display_name": "Main Office",
            "address": "Gaston Crommenlaan 4",
            "city": "Ghent",
            "country": "BE",
            "postal_code": "9050",
            "name": "Qargo HQ"
          },
          "date": "2024-12-31"
        }
      },
      "delivery_stop": {
        "time_window": {
          "start_time": "09:30",
          "end_time": "16:30"
        },
        "date": "2024-12-31",
        "location": {
          "code": "LOC123",
          "display_name": "Main Office",
          "address": "Gaston Crommenlaan 4",
          "city": "Ghent",
          "country": "BE",
          "postal_code": "9050",
          "name": "Qargo HQ"
        },
        "drop_collect_empty": {
          "location": {
            "code": "LOC123",
            "display_name": "Main Office",
            "address": "Gaston Crommenlaan 4",
            "city": "Ghent",
            "country": "BE",
            "postal_code": "9050",
            "name": "Qargo HQ"
          },
          "date": "2024-12-31"
        }
      },
      "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"
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "setup_stops": [
    {
      "time_window": {
        "start_time": "09:30",
        "end_time": "16:30"
      },
      "date": "2024-12-31",
      "location": {
        "code": "LOC123",
        "display_name": "Main Office",
        "address": "Gaston Crommenlaan 4",
        "city": "Ghent",
        "country": "BE",
        "postal_code": "9050",
        "name": "Qargo HQ"
      },
      "drop_collect_empty": {
        "location": {
          "code": "LOC123",
          "display_name": "Main Office",
          "address": "Gaston Crommenlaan 4",
          "city": "Ghent",
          "country": "BE",
          "postal_code": "9050",
          "name": "Qargo HQ"
        },
        "date": "2024-12-31"
      }
    }
  ],
  "teardown_stops": [
    {
      "time_window": {
        "start_time": "09:30",
        "end_time": "16:30"
      },
      "date": "2024-12-31",
      "location": {
        "code": "LOC123",
        "display_name": "Main Office",
        "address": "Gaston Crommenlaan 4",
        "city": "Ghent",
        "country": "BE",
        "postal_code": "9050",
        "name": "Qargo HQ"
      },
      "drop_collect_empty": {
        "location": {
          "code": "LOC123",
          "display_name": "Main Office",
          "address": "Gaston Crommenlaan 4",
          "city": "Ghent",
          "country": "BE",
          "postal_code": "9050",
          "name": "Qargo HQ"
        },
        "date": "2024-12-31"
      }
    }
  ],
  "container_load_unload_stop": {
    "time_window": {
      "start_time": "09:30",
      "end_time": "16:30"
    },
    "date": "2024-12-31",
    "location": {
      "code": "LOC123",
      "display_name": "Main Office",
      "address": "Gaston Crommenlaan 4",
      "city": "Ghent",
      "country": "BE",
      "postal_code": "9050",
      "name": "Qargo HQ"
    },
    "drop_collect_empty": {
      "location": {
        "code": "LOC123",
        "display_name": "Main Office",
        "address": "Gaston Crommenlaan 4",
        "city": "Ghent",
        "country": "BE",
        "postal_code": "9050",
        "name": "Qargo HQ"
      },
      "date": "2024-12-31"
    }
  }
}

Response

Successful Response

upload_idstring uuid required

Unique identifier for the order import

upload_status'TODO' | 'IN_PROGRESS' | 'READY_TO_UPSERT' | 'UPSERT_IN_PROGRESS' | 'COMPLETED' | 'ERROR' | 'SKIPPED' | 'DUPLICATE' required
upload_urlstring required

URL to check the status of the order import, e.g. /v1/orders/order/upload/{upload_id}

order_idstring uuid nullable

Unique identifier for the order, only available when it's an update to an existing order

order_urlstring nullable

URL to check the status of the order, e.g. /v1/orders/order/{order_id}, only available when it's update to an existing order

Changes

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