---
title: "Import Order"
method: POST
path: "/v1/orders/order/upload"
tags: ["API / Order", "Use case / Order", "Use case / Customer portal"]
---

# Import Order

`POST /v1/orders/order/upload`

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

## Request body

- OrderInput
  - `transport_service` Entity
    - `name` string, nullable — Human readable identifier
    - `code` string, nullable — Machine readable identifier
  - `customer_reference_number` string, nullable
  - `service_level` ServiceLevel
    - `name` string, nullable — Human readable identifier
    - `code` string, nullable — Machine readable identifier
    - `custom_fields` object — Store values for user defined fields
  - `planning_instructions` string, nullable — Additional freeform instructions for the planner.
  - `department` Department
    - `name` string, nullable — Name of the department
    - `code` string, nullable — Code of the department
  - `neutral_order_type` 'NO_NEUTRAL_ORDER' | 'MASK_DELIVERY' | 'MASK_PICKUP', nullable — Neutral order
  - `container` ContainerExtraFields
    - `seal_number` string, nullable — Container seal number
    - `port_of_loading` string, nullable — Port of loading
    - `port_of_unloading` string, nullable — Port of unloading
    - `origin_of_goods` string, nullable — Origin of goods
    - `unique_consignment_number` string, nullable — Unique consignment number
    - `ocean_liner_name` string, nullable — Ocean liner name
    - `ocean_liner_scac` string, nullable — Ocean liner SCAC
    - `pin_code` string, nullable — PIN code
    - `ship_name` string, nullable — Ship name
    - `closing_date` string, date-time, nullable — Closing date
    - `tare_weight` number, nullable — Tare weight
    - `container_number` string, nullable — Number of the container
    - `container_type` ContainerType
      - `name` string, nullable — Human readable identifier
      - `code` string, nullable — Machine readable identifier
      - `custom_fields` object — Store values for user defined fields
      - `container_iso_code` string, nullable — International standard ISO code identifying the container size and type (e.g. '22G1', '42G1')
    - `container_scenario` 'IMPORT' | 'EXPORT'
    - `secure_release` boolean, nullable — Is secure release enabled
  - `custom_fields` object, nullable — User defined additional fields for this order.
  - `vehicle_category` VehicleCategory
    - `name` string, nullable — Human readable identifier
    - `code` string, nullable — Machine readable identifier
    - `custom_fields` object — Store values for user defined fields
  - `palletforce` PalletforceExtraFields
    - `ni_company_name` string, nullable — Northern Ireland company name
    - `ni_description` string, nullable — Northern Ireland shipping info
    - `ni_gbeori` string, nullable — Northern Ireland GBEORI
    - `ni_tss_job_reference` string, nullable — Northern Ireland TSS JON reference
    - `ni_tss_registration` string, nullable — Northern Ireland TSS registration
  - `kuehne_nagel` KuehneNagelExtraFields
    - `sender_depot_code` string, nullable — Sender depot code
    - `receiver_depot_code` string, nullable — Receiver depot code
  - `palletline` PalletlineExtraFields
    - `terms_of_carriage` '1300' | '5000' | '10000' | 'cmr' | 'other', nullable
  - `transporeon` TransporeonOrderExtraFields
    - `transport_id` string, nullable — Transporeon Transport ID
    - `transport_number` string, nullable — Transporeon Transport Number
  - `dachser` DachserExtraFields
    - `consolidator_reference_number` string, nullable — Consolidator reference number
  - `contact_emails` string[], nullable — List of contact emails to notify about the order
  - `import_export` ImportExportExtraFields
    - `incoterm` 'EXW' | 'FCA' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'CPT' | 'CIP' | 'DAP' | 'DPU' | 'DDP'
    - `destination_country_of_goods` string, nullable — Destination country of goods in ISO 3166-1 alpha-2 format
    - `origin_country_of_goods` string, nullable — Origin country of goods in ISO 3166-1 alpha-2 format
  - `is_consignment_info_validated` boolean, 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_identifier` string, required — Identifier of the order when created from an external source
  - `import_configuration` ImportConfiguration
    - `code` string — Import source in Qargo to route the order uploads to
  - `consignments` ConsignmentInputInput[], required
    - `consignment_reference_number` string, nullable — Consignment reference number
    - `cmr_reference_number` string, nullable
    - `planning_instructions` string, nullable — Additional freeform instructions for the planner.
    - `custom_fields` object — Additional user defined fields to fill in
    - `transport_network` ConsignmentTransportNetwork
      - `requesting_depot_code` string, nullable — Depot code of the requesting depot
      - `collection_depot_code` string, nullable — Depot code of the collection depot
      - `delivery_depot_code` string, nullable — Depot code of the delivery depot
    - `central_transport_network` CentralTransportNetworkConsignmentExtraFields
      - `hub` string, nullable — Central Transport Network hub
      - `trunk` string, nullable — Central Transport Network trunk
      - `alternative_hubs` string, nullable — Alternative hubs as a comma separated list e.g. `Central,South`
    - `palletline` PalletlineConsignmentExtraFields
      - `palletline_id` string, nullable — Palletline ID
    - `palletforce` PalletforceConsignmentExtraFields
      - `palletforce_id` string, nullable — Palletforce ID
    - `transporeon` TransporeonConsignmentExtraFields
      - `delivery_id` string, nullable — Transporeon Delivery ID
    - `pickup_stop` StopInputInput, required
      - `activity_label` string, nullable — Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer
      - `note` string, nullable — Additional freeform data for this stop
      - `reference_number` string, nullable
      - `email` string, nullable
      - `phone_number` string, nullable
      - `mobile_number` string, nullable
      - `time_window` TimeWindow
        - `name` string, nullable — Human readable identifier
        - `code` string, nullable — Machine readable identifier
        - `start_time` string, time, nullable — Start of time window
        - `end_time` string, time, nullable — End of time window
        - `custom_fields` object — Store values for user defined fields
        - `is_enforced` boolean, nullable — Enforce the time window for this stop
        - `use_location_opening_hours` boolean, nullable — When true, the stop's time window is derived from the location's opening hours instead of explicit start/end times
      - `planning_instructions` string, nullable — Additional freeform instructions for the planner.
      - `extras` StopExtra[], nullable — Additional services/options for stop
        - `name` string, nullable
        - `code` string, nullable
        - `amazon` AmazonExtraFields
          - `asn_number` string, nullable — Amazon Shipment ID
          - `fba_number` string, nullable — Amazon FBA ID
          - `po_number` string, nullable — Amazon PO ID
          - `amazon_number` string, nullable — Amazon order number
          - `carton_count` string, nullable — Number of cartons
          - `unit_count` string, nullable — Number of units
          - `booking_date` string, nullable — Amazon booking date
          - `booking_time` string, nullable — Amazon booking time
        - `custom_fields` object — Store values for user defined fields
      - `custom_fields` object — Additional user defined fields to fill in
      - `date` string, date, nullable — Date on which stop happens. Optional for delivery stops when a service level is set on the order
      - `custom_activity_label` string, nullable — Custom activity related to the order
      - `duration` integer, nullable — Duration of the stop in seconds
      - `location` Location, required
        - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
        - `display_name` string, nullable — Human-readable label for a location in operational views.
        - `external_id` string, nullable — Identifier from an external (master data) system.
        - `address` string, nullable — First address line of the location
        - `address_second_line` string, nullable — Second address line of the location
        - `city` string, nullable — City of the location
        - `state` string, nullable — State of the location
        - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
        - `postal_code` string, nullable — Postal code of the location
        - `name` string, nullable — Name of the location
        - `id` string, uuid, nullable — Identifier of the location
        - `latitude` number, nullable
        - `longitude` number, nullable
        - `description` string, nullable — Location description
        - `location_identifier` string, nullable — External location identifier
      - `drop_collect_empty` DropCollectEmptyInput
        - `location` Location
          - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
          - `display_name` string, nullable — Human-readable label for a location in operational views.
          - `external_id` string, nullable — Identifier from an external (master data) system.
          - `address` string, nullable — First address line of the location
          - `address_second_line` string, nullable — Second address line of the location
          - `city` string, nullable — City of the location
          - `state` string, nullable — State of the location
          - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
          - `postal_code` string, nullable — Postal code of the location
          - `name` string, nullable — Name of the location
          - `id` string, uuid, nullable — Identifier of the location
          - `latitude` number, nullable
          - `longitude` number, nullable
          - `description` string, nullable — Location description
          - `location_identifier` string, nullable — External location identifier
        - `date` string, date, nullable — Date the main drop/collect
    - `delivery_stop` StopInputInput, required
      - `activity_label` string, nullable — Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer
      - `note` string, nullable — Additional freeform data for this stop
      - `reference_number` string, nullable
      - `email` string, nullable
      - `phone_number` string, nullable
      - `mobile_number` string, nullable
      - `time_window` TimeWindow
        - `name` string, nullable — Human readable identifier
        - `code` string, nullable — Machine readable identifier
        - `start_time` string, time, nullable — Start of time window
        - `end_time` string, time, nullable — End of time window
        - `custom_fields` object — Store values for user defined fields
        - `is_enforced` boolean, nullable — Enforce the time window for this stop
        - `use_location_opening_hours` boolean, nullable — When true, the stop's time window is derived from the location's opening hours instead of explicit start/end times
      - `planning_instructions` string, nullable — Additional freeform instructions for the planner.
      - `extras` StopExtra[], nullable — Additional services/options for stop
        - `name` string, nullable
        - `code` string, nullable
        - `amazon` AmazonExtraFields
          - `asn_number` string, nullable — Amazon Shipment ID
          - `fba_number` string, nullable — Amazon FBA ID
          - `po_number` string, nullable — Amazon PO ID
          - `amazon_number` string, nullable — Amazon order number
          - `carton_count` string, nullable — Number of cartons
          - `unit_count` string, nullable — Number of units
          - `booking_date` string, nullable — Amazon booking date
          - `booking_time` string, nullable — Amazon booking time
        - `custom_fields` object — Store values for user defined fields
      - `custom_fields` object — Additional user defined fields to fill in
      - `date` string, date, nullable — Date on which stop happens. Optional for delivery stops when a service level is set on the order
      - `custom_activity_label` string, nullable — Custom activity related to the order
      - `duration` integer, nullable — Duration of the stop in seconds
      - `location` Location, required
        - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
        - `display_name` string, nullable — Human-readable label for a location in operational views.
        - `external_id` string, nullable — Identifier from an external (master data) system.
        - `address` string, nullable — First address line of the location
        - `address_second_line` string, nullable — Second address line of the location
        - `city` string, nullable — City of the location
        - `state` string, nullable — State of the location
        - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
        - `postal_code` string, nullable — Postal code of the location
        - `name` string, nullable — Name of the location
        - `id` string, uuid, nullable — Identifier of the location
        - `latitude` number, nullable
        - `longitude` number, nullable
        - `description` string, nullable — Location description
        - `location_identifier` string, nullable — External location identifier
      - `drop_collect_empty` DropCollectEmptyInput
        - `location` Location
          - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
          - `display_name` string, nullable — Human-readable label for a location in operational views.
          - `external_id` string, nullable — Identifier from an external (master data) system.
          - `address` string, nullable — First address line of the location
          - `address_second_line` string, nullable — Second address line of the location
          - `city` string, nullable — City of the location
          - `state` string, nullable — State of the location
          - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
          - `postal_code` string, nullable — Postal code of the location
          - `name` string, nullable — Name of the location
          - `id` string, uuid, nullable — Identifier of the location
          - `latitude` number, nullable
          - `longitude` number, nullable
          - `description` string, nullable — Location description
          - `location_identifier` string, nullable — External location identifier
        - `date` string, date, nullable — Date the main drop/collect
    - `goods` GoodInputInput[], nullable
      - `description` string, nullable
      - `quantity` integer, nullable
      - `total_loading_meters` number, nullable
      - `total_pallet_spaces` number, nullable
      - `total_volume_m3` number, nullable
      - `total_weight_kg` number, nullable
      - `unit_height_m` number, nullable
      - `unit_length_m` number, nullable
      - `unit_loading_meters` number, nullable
      - `unit_pallet_spaces` number, nullable
      - `unit_weight_kg` number, nullable
      - `unit_width_m` number, nullable
      - `stackable` boolean, nullable
      - `packaged_items` PackagedItemInput[]
        - `adr` ADRInput
          - `adr_name_by_locale` object, nullable — ADR name by locale, generated from ADR master data. This field is read-only; values submitted during order import are ignored. Keys, when present, are one of: `en`, `en-GB`, `en-US`, `nl-BE`, `fi-FI`, `fr-FR`, `de-DE`, `it-IT`, `es-ES`, `hu-HU`, `pt-PT`, `tr-TR`, `pl-PL`, `ro-RO`, `ru-RU`, `bg-BG`, `lt-LT`, `mk-MK`, or `cs-CZ`. Values are the corresponding localized ADR names.
          - `un_number` string, nullable — See https://adr-tool.com/lists-of-un-numbers
          - `packaging_type` 'BOX' | 'COMPOSITE_PACKAGING' | 'DRUM' | 'GAS_RECEPTABLE' | 'INTERMEDIATE_BULK_CONTAINER' | 'JERRICAN' | 'LARGE_PACKAGING' | 'LIGHT_GAUGE_METAL_PACKAGINGS' | 'BAG' | 'TANK_CONTAINER'
          - `emergency_phone_number` string, nullable — Emergency phone number
          - `technical_name_by_locale` object, nullable — Technical name by locale. Keys are locale codes and values are the corresponding localized technical names. Supported locale codes: `en`, `en-GB`, `en-US`, `nl-BE`, `fi-FI`, `fr-FR`, `de-DE`, `it-IT`, `es-ES`, `hu-HU`, `pt-PT`, `tr-TR`, `pl-PL`, `ro-RO`, `ru-RU`, `bg-BG`, `lt-LT`, `mk-MK`, and `cs-CZ`.
          - `classification_code` string, nullable — ADR classification code
          - `transport_category_tunnel_restriction_code` string, nullable — A letter code (A-E) that reflects restrictions for carrying the substance through road tunnels - Helps improve ADR matching beyond just using UN number
          - `packing_group` string, nullable — Indicates danger level - Helps improve ADR matching beyond just using UN number
          - `adr_class` string, nullable — Identifies the primary hazard category of the substance - Helps improve ADR matching beyond just using UN number
          - `physical_state` 'UNKNOWN' | 'SOLID' | 'LIQUID' | 'GAS' | 'GAS_OR_LIQUID'
          - `hazard_identification_number` string, nullable — Also known as Kemler code. Used in ADR labeling
          - `division` string, nullable — ADR division/subclass (e.g. '1.2', '2.1'). Populated for classes 1, 2, 4, 5 and 6
          - `labels` string, nullable — Subsidiary hazard class labels (ADR), '+'-separated when multiple. Example: '6.1+5.1'.
          - `special_provisions` string, nullable — ADR special provisions code(s) applying to this substance. Example: '274 640D'.
        - `barcodes` string[], nullable — List of barcodes associated with the packaged item
        - `custom_fields` object — Store values for user defined fields
        - `import_export` PackagedItemsImportExportExtraFields
          - `hs_code_import` HSCode
            - `code` string, nullable — Harmonized System Code for the good
            - `description` string, nullable — Description of the HS code
          - `hs_code_export` HSCode
            - `code` string, nullable — Harmonized System Code for the good
            - `description` string, nullable — Description of the HS code
          - `shipping_marks` string[], nullable — Shipping marks for the good
          - `commercial_invoice` PackagedItemCommercialInvoiceExtraField
            - `value` number, nullable — Value of the commercial invoice
          - `sps_flag` boolean, nullable — Sanitary & phytosanitary flag
          - `sps_reference` string, nullable — CHED / IPAFFS reference
          - `ggb_reference` string, nullable — GGB reference (NL only)
        - `packaging_type` PackagingType
          - `name` string, nullable — Human readable identifier
          - `code` string, nullable — Machine readable identifier
          - `export_alias` string, nullable — Alias defined in the Qargo config
          - `packaging_size` PackagingSize
            - `name` string, nullable — Human readable identifier
            - `code` string, nullable — Machine readable identifier
            - `height_m` number, nullable — Height in meters
            - `length_m` number, nullable — Length in meters
            - `width_m` number, nullable — Width in meters
            - `weight_kg` number, nullable — Weight in kg
            - `loading_meters` number, nullable — Loading meters
            - `pallet_spaces` number, nullable — Pallet spaces
          - `custom_fields` object — Store values for user defined fields
        - `quantity` integer, nullable — Quantity of packaged items
        - `total_net_weight_kg` number, nullable — Total net weight of packaged items in KG
        - `total_volume_l` number, nullable — Total volume of packaged items in liter
        - `total_weight_kg` number, nullable — Total weight of packaged items in KG
        - `unit_height_m` number, nullable
        - `unit_length_m` number, nullable
        - `unit_width_m` number, nullable
        - `description` string, nullable — Description of the packaged item
      - `adr_type` 'ADR' | 'LIMITED_QUANTITY'
      - `absolute_min_temperature_degrees` number, nullable
      - `absolute_max_temperature_degrees` number, nullable
      - `ordered_transport_temperature_degrees` number, nullable
      - `specific_gravity` number, nullable
      - `product` Product
        - `name` string, nullable — Human readable identifier
        - `code` string, nullable — Machine readable identifier
        - `product_type` Entity
          - `name` string, nullable — Human readable identifier
          - `code` string, nullable — Machine readable identifier
        - `custom_fields` object — Store values for user defined fields
      - `packaging_type` PackagingType
        - `name` string, nullable — Human readable identifier
        - `code` string, nullable — Machine readable identifier
        - `export_alias` string, nullable — Alias defined in the Qargo config
        - `packaging_size` PackagingSize
          - `name` string, nullable — Human readable identifier
          - `code` string, nullable — Machine readable identifier
          - `height_m` number, nullable — Height in meters
          - `length_m` number, nullable — Length in meters
          - `width_m` number, nullable — Width in meters
          - `weight_kg` number, nullable — Weight in kg
          - `loading_meters` number, nullable — Loading meters
          - `pallet_spaces` number, nullable — Pallet spaces
        - `custom_fields` object — Store values for user defined fields
      - `extras` ExtraField[], nullable — Additional extra services/options for good
        - `name` string, nullable — Human readable identifier
        - `code` string, nullable — Machine readable identifier
        - `custom_fields` object — Store values for user defined fields
      - `custom_fields` object — Store values for user defined fields
      - `handling_units` HandlingUnitInputInput[], nullable — List of handling units. A handling unit is used to transport, store or handle goods
        - `barcode` BarcodeInput
          - `value` string, nullable — Barcode value
          - `source` 'EXTERNAL' | 'QARGO' | 'HAZCHEM' | 'PALLETFORCE' | 'PALLETLINE' | 'PALLETWAYS' | 'PALLETXPRESS_IE' | 'PALLET_TRACK' | 'PALLEX' | 'POLE' | 'TPN' | 'UPN'
    - `import_export` ConsignmentImportExportExtraFieldsInputInput
      - `commercial_invoice` ConsignmentCommercialInvoiceExtraField
        - `name` string, nullable — Name of the commercial invoice
        - `value` number, nullable — Value of the commercial invoice
        - `currency_code` string, nullable — Currency code of the commercial invoice
      - `export_declaration` ConsignmentCustomsExportInfo
        - `country` string, nullable — ISO 3166-1 alpha-2 country of the export declaration
        - `declaration_type` 'EU' | 'EX'
        - `additional_border_processes` AdditionalExportBorderProcessEnum[], nullable — Additional border processes for this declaration
        - `mrn` string, nullable — Movement Reference Number of the export declaration
        - `exs_mrn` string, nullable — Exit Summary Declaration MRN
        - `ducr` string, nullable — Declaration Unique Consignment Reference (UK only)
        - `location_id` string, uuid, nullable — Identifier of the customs location
        - `emails` string[], nullable — Email addresses associated with this declaration
      - `import_declaration` ConsignmentCustomsImportInfo
        - `country` string, nullable — ISO 3166-1 alpha-2 country of the import declaration
        - `declaration_type` 'IM'
        - `additional_border_processes` AdditionalImportBorderProcessEnum[], nullable — Additional border processes for this declaration
        - `mrn` string, nullable — Movement Reference Number of the import declaration
        - `ens_mrn` string, nullable — Entry Summary Declaration MRN
        - `ducr` string, nullable — Declaration Unique Consignment Reference (UK only)
        - `temporary_storage_ucn` string, nullable — Temporary storage UCN
        - `temporary_storage_crn` string, nullable — Temporary storage CRN (BE only)
        - `emails` string[], nullable — Email addresses associated with this declaration
      - `transit_declarations` ConsignmentCustomsTransitInfoInput[], nullable — At most one transit declaration on input. (Multi-transit available via UI; the public API will lift this cap in a later release.)
        - `sequence_number` integer, required — Identifier and ordering key for partial updates (required)
        - `declaration_type` 'T1' | 'T2'
        - `additional_border_processes` AdditionalTransitBorderProcessEnum[], nullable — Additional border processes for this declaration
        - `lrn` string, nullable — Local Reference Number
        - `mrn` string, nullable — Movement Reference Number
        - `start_office` TransitOffice
          - `code` string, nullable — Customs office code
        - `end_office` TransitOffice
          - `code` string, nullable — Customs office code
        - `valid_to_date` string, date, nullable — Validity end date (ISO 8601)
        - `id` string, uuid, nullable — Existing transit declaration identifier (for updates)
    - `buyer` Entity
      - `name` string, nullable — Human readable identifier
      - `code` string, nullable — Machine readable identifier
    - `seller` Entity
      - `name` string, nullable — Human readable identifier
      - `code` string, nullable — Machine readable identifier
  - `customer` Entity, required
    - `name` string, nullable — Human readable identifier
    - `code` string, nullable — Machine readable identifier
  - `transport_network` Entity
    - `name` string, nullable — Human readable identifier
    - `code` string, nullable — Machine readable identifier
  - `pricing` OrderPricingInput
    - `requested_price` union — Requested price
      - string
      - number
  - `input_source` string, nullable — Source of this order input
  - `raw_input` RawInput
    - `content` string
    - `mime_type` string
    - `filename` string
  - `order_status` 'QUOTE' | 'TO_PLAN'
  - `setup_stops` StopInputInput[], nullable — List of stops for a container export scenario
    - `activity_label` string, nullable — Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer
    - `note` string, nullable — Additional freeform data for this stop
    - `reference_number` string, nullable
    - `email` string, nullable
    - `phone_number` string, nullable
    - `mobile_number` string, nullable
    - `time_window` TimeWindow
      - `name` string, nullable — Human readable identifier
      - `code` string, nullable — Machine readable identifier
      - `start_time` string, time, nullable — Start of time window
      - `end_time` string, time, nullable — End of time window
      - `custom_fields` object — Store values for user defined fields
      - `is_enforced` boolean, nullable — Enforce the time window for this stop
      - `use_location_opening_hours` boolean, nullable — When true, the stop's time window is derived from the location's opening hours instead of explicit start/end times
    - `planning_instructions` string, nullable — Additional freeform instructions for the planner.
    - `extras` StopExtra[], nullable — Additional services/options for stop
      - `name` string, nullable
      - `code` string, nullable
      - `amazon` AmazonExtraFields
        - `asn_number` string, nullable — Amazon Shipment ID
        - `fba_number` string, nullable — Amazon FBA ID
        - `po_number` string, nullable — Amazon PO ID
        - `amazon_number` string, nullable — Amazon order number
        - `carton_count` string, nullable — Number of cartons
        - `unit_count` string, nullable — Number of units
        - `booking_date` string, nullable — Amazon booking date
        - `booking_time` string, nullable — Amazon booking time
      - `custom_fields` object — Store values for user defined fields
    - `custom_fields` object — Additional user defined fields to fill in
    - `date` string, date, nullable — Date on which stop happens. Optional for delivery stops when a service level is set on the order
    - `custom_activity_label` string, nullable — Custom activity related to the order
    - `duration` integer, nullable — Duration of the stop in seconds
    - `location` Location, required
      - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
      - `display_name` string, nullable — Human-readable label for a location in operational views.
      - `external_id` string, nullable — Identifier from an external (master data) system.
      - `address` string, nullable — First address line of the location
      - `address_second_line` string, nullable — Second address line of the location
      - `city` string, nullable — City of the location
      - `state` string, nullable — State of the location
      - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
      - `postal_code` string, nullable — Postal code of the location
      - `name` string, nullable — Name of the location
      - `id` string, uuid, nullable — Identifier of the location
      - `latitude` number, nullable
      - `longitude` number, nullable
      - `description` string, nullable — Location description
      - `location_identifier` string, nullable — External location identifier
    - `drop_collect_empty` DropCollectEmptyInput
      - `location` Location
        - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
        - `display_name` string, nullable — Human-readable label for a location in operational views.
        - `external_id` string, nullable — Identifier from an external (master data) system.
        - `address` string, nullable — First address line of the location
        - `address_second_line` string, nullable — Second address line of the location
        - `city` string, nullable — City of the location
        - `state` string, nullable — State of the location
        - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
        - `postal_code` string, nullable — Postal code of the location
        - `name` string, nullable — Name of the location
        - `id` string, uuid, nullable — Identifier of the location
        - `latitude` number, nullable
        - `longitude` number, nullable
        - `description` string, nullable — Location description
        - `location_identifier` string, nullable — External location identifier
      - `date` string, date, nullable — Date the main drop/collect
  - `teardown_stops` StopInputInput[], nullable — List of stops for a container import scenario
    - `activity_label` string, nullable — Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer
    - `note` string, nullable — Additional freeform data for this stop
    - `reference_number` string, nullable
    - `email` string, nullable
    - `phone_number` string, nullable
    - `mobile_number` string, nullable
    - `time_window` TimeWindow
      - `name` string, nullable — Human readable identifier
      - `code` string, nullable — Machine readable identifier
      - `start_time` string, time, nullable — Start of time window
      - `end_time` string, time, nullable — End of time window
      - `custom_fields` object — Store values for user defined fields
      - `is_enforced` boolean, nullable — Enforce the time window for this stop
      - `use_location_opening_hours` boolean, nullable — When true, the stop's time window is derived from the location's opening hours instead of explicit start/end times
    - `planning_instructions` string, nullable — Additional freeform instructions for the planner.
    - `extras` StopExtra[], nullable — Additional services/options for stop
      - `name` string, nullable
      - `code` string, nullable
      - `amazon` AmazonExtraFields
        - `asn_number` string, nullable — Amazon Shipment ID
        - `fba_number` string, nullable — Amazon FBA ID
        - `po_number` string, nullable — Amazon PO ID
        - `amazon_number` string, nullable — Amazon order number
        - `carton_count` string, nullable — Number of cartons
        - `unit_count` string, nullable — Number of units
        - `booking_date` string, nullable — Amazon booking date
        - `booking_time` string, nullable — Amazon booking time
      - `custom_fields` object — Store values for user defined fields
    - `custom_fields` object — Additional user defined fields to fill in
    - `date` string, date, nullable — Date on which stop happens. Optional for delivery stops when a service level is set on the order
    - `custom_activity_label` string, nullable — Custom activity related to the order
    - `duration` integer, nullable — Duration of the stop in seconds
    - `location` Location, required
      - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
      - `display_name` string, nullable — Human-readable label for a location in operational views.
      - `external_id` string, nullable — Identifier from an external (master data) system.
      - `address` string, nullable — First address line of the location
      - `address_second_line` string, nullable — Second address line of the location
      - `city` string, nullable — City of the location
      - `state` string, nullable — State of the location
      - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
      - `postal_code` string, nullable — Postal code of the location
      - `name` string, nullable — Name of the location
      - `id` string, uuid, nullable — Identifier of the location
      - `latitude` number, nullable
      - `longitude` number, nullable
      - `description` string, nullable — Location description
      - `location_identifier` string, nullable — External location identifier
    - `drop_collect_empty` DropCollectEmptyInput
      - `location` Location
        - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
        - `display_name` string, nullable — Human-readable label for a location in operational views.
        - `external_id` string, nullable — Identifier from an external (master data) system.
        - `address` string, nullable — First address line of the location
        - `address_second_line` string, nullable — Second address line of the location
        - `city` string, nullable — City of the location
        - `state` string, nullable — State of the location
        - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
        - `postal_code` string, nullable — Postal code of the location
        - `name` string, nullable — Name of the location
        - `id` string, uuid, nullable — Identifier of the location
        - `latitude` number, nullable
        - `longitude` number, nullable
        - `description` string, nullable — Location description
        - `location_identifier` string, nullable — External location identifier
      - `date` string, date, nullable — Date the main drop/collect
  - `container_load_unload_stop` StopInputInput
    - `activity_label` string, nullable — Activity to execute at this location, ie. pickup/collect, couple/uncouple trailer
    - `note` string, nullable — Additional freeform data for this stop
    - `reference_number` string, nullable
    - `email` string, nullable
    - `phone_number` string, nullable
    - `mobile_number` string, nullable
    - `time_window` TimeWindow
      - `name` string, nullable — Human readable identifier
      - `code` string, nullable — Machine readable identifier
      - `start_time` string, time, nullable — Start of time window
      - `end_time` string, time, nullable — End of time window
      - `custom_fields` object — Store values for user defined fields
      - `is_enforced` boolean, nullable — Enforce the time window for this stop
      - `use_location_opening_hours` boolean, nullable — When true, the stop's time window is derived from the location's opening hours instead of explicit start/end times
    - `planning_instructions` string, nullable — Additional freeform instructions for the planner.
    - `extras` StopExtra[], nullable — Additional services/options for stop
      - `name` string, nullable
      - `code` string, nullable
      - `amazon` AmazonExtraFields
        - `asn_number` string, nullable — Amazon Shipment ID
        - `fba_number` string, nullable — Amazon FBA ID
        - `po_number` string, nullable — Amazon PO ID
        - `amazon_number` string, nullable — Amazon order number
        - `carton_count` string, nullable — Number of cartons
        - `unit_count` string, nullable — Number of units
        - `booking_date` string, nullable — Amazon booking date
        - `booking_time` string, nullable — Amazon booking time
      - `custom_fields` object — Store values for user defined fields
    - `custom_fields` object — Additional user defined fields to fill in
    - `date` string, date, nullable — Date on which stop happens. Optional for delivery stops when a service level is set on the order
    - `custom_activity_label` string, nullable — Custom activity related to the order
    - `duration` integer, nullable — Duration of the stop in seconds
    - `location` Location, required
      - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
      - `display_name` string, nullable — Human-readable label for a location in operational views.
      - `external_id` string, nullable — Identifier from an external (master data) system.
      - `address` string, nullable — First address line of the location
      - `address_second_line` string, nullable — Second address line of the location
      - `city` string, nullable — City of the location
      - `state` string, nullable — State of the location
      - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
      - `postal_code` string, nullable — Postal code of the location
      - `name` string, nullable — Name of the location
      - `id` string, uuid, nullable — Identifier of the location
      - `latitude` number, nullable
      - `longitude` number, nullable
      - `description` string, nullable — Location description
      - `location_identifier` string, nullable — External location identifier
    - `drop_collect_empty` DropCollectEmptyInput
      - `location` Location
        - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
        - `display_name` string, nullable — Human-readable label for a location in operational views.
        - `external_id` string, nullable — Identifier from an external (master data) system.
        - `address` string, nullable — First address line of the location
        - `address_second_line` string, nullable — Second address line of the location
        - `city` string, nullable — City of the location
        - `state` string, nullable — State of the location
        - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
        - `postal_code` string, nullable — Postal code of the location
        - `name` string, nullable — Name of the location
        - `id` string, uuid, nullable — Identifier of the location
        - `latitude` number, nullable
        - `longitude` number, nullable
        - `description` string, nullable — Location description
        - `location_identifier` string, nullable — External location identifier
      - `date` string, date, nullable — Date the main drop/collect

## Response `200`

Successful Response

- OrderImport
  - `upload_id` string, 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_url` string, required — URL to check the status of the order import, e.g. /v1/orders/order/upload/{upload_id}
  - `order_id` string, uuid, nullable — Unique identifier for the order, only available when it's an update to an existing order
  - `order_url` string, 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

## Other responses

- `400` — Bad Request — invalid input or malformed request
- `401` — Unauthorized — missing or invalid authentication credentials
- `403` — Forbidden — insufficient permissions for this operation
- `422` — Validation Error
- `429` — Too Many Requests — rate limit exceeded. See the `Retry-After` header
- `500` — Internal Server Error
- `503` — Service Unavailable — temporarily unable to handle the request

---

[API](https://skmtc.dev/qargo/apis/qargo-tms-api.md) · [All operations](https://skmtc.dev/qargo/apis/qargo-tms-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/qargo/qargo-tms-api/revisions/17297902e7ce/schema)