--- title: "List all shipments" method: GET path: "/shipments" tags: ["Shipments"] --- # List all shipments `GET /shipments` Returns a list of shipments. ## Query parameters - `id` integer - `order_id` string - `package_number` string - `carrier_code` 'airmee' | 'alpi' | 'asendia' | 'best' | 'bft' | 'bhs_logistics' | 'bws' | 'bpost' | 'bring' | 'brink' | 'budbee' | 'burd' | 'city_mail' | 'cm_transport' | 'collicare' | 'dachser' | 'dansk_distribution_brabrand' | 'dansk_distribution' | 'dansk_distribution_taulov' | 'dfm' | 'dao' | 'db_schenker' | 'deutsche_post' | 'dhl_express' | 'dhl_freight_se' | 'dhl_parcel' | 'dpd' | 'dsv_parcel' | 'dsv' | 'dsv_xpress' | 'early_bird' | 'esbjerg_gods' | 'esbjerg_gods_sjaelland' | 'fed_ex' | 'freja' | 'geodis' | 'gls' | 'gls_de' | 'gordon' | 'helthjem' | 'instabox' | 'interfjord' | 'jetpak' | 'jetpak_se' | 'jjd' | 'joervi_transport' | 'kht' | 'leman' | 'lgt_logistics' | 'link_logistics' | 'b2c_europe' | 'mover' | 'nonbo_fragt' | 'packeta' | 'posti' | 'post_nl' | 'pdk' | 'post_nord' | 'sand_distribution' | 'sdl' | 'simptra' | 'tjw' | 'tnt' | 'ups' | 'webrinq' | 'xpressen' | 'unspecified' - `sender_country` string - `receiver_country` string - `waybill_reference` string - `created_at_min` string, date-time - `created_at_max` string, date-time - `per_page` integer - `page` integer - `reference` string - `additional_reference` string ## Response `200` Successful. - Shipment[] - `id` integer — ID of the shipment. - `created_at` string, date-time — Date and time the shipment was created. - `updated_at` string, date-time — Date and time the shipment was last updated. - `carrier_code` string — Carrier code referring to the carrier of the shipment. - `description` string — Text to describe the shipment, which can be used when presenting it. - `contents` string, nullable — General description of the contents of the shipment. - `term_of_trade` string — Incoterm for the shipments, e.g., DDP when customs should be paid by the sender. - `product_id` integer — ID of the product of the shipment. - `product_code` string — Product code of the product of the shipment. - `service_codes` string — Comma-separated string of codes of services that is booked with the shipment. - `services` string, nullable — Comma-separated string of IDs of services that are booked with the shipment. - `customer_number` string, nullable — Customer number of the agreement used to book the shipment. If value is *null* it is Shipmondo's agreement - `price` string — Price of the shipment including VAT. - `reference` string, nullable — Sender's reference of the shipment. - `additional_reference` string, nullable — An secondary reference. When possible, it will be transmitted to the carrier and printed on the label - `order_id` string, nullable — Order no. from webshop, if shipment is based on an order in Shipmondo. - `pkg_no` string — Carrier's shipment number, referring to the whole shipment. - `external_pkg_no` string, nullable — Package number from an external source. - `parties` ShipmentParty[] — Array of parties associated with the shipment. - `type` 'sender' | 'receiver' | 'pickup' | 'importer' | 'freight_payer' | 'service_point' | 'return', required — Type of party. Parties with `sender` and `receiver` are required for all shipments. - `name` string — Name of the party. For companies, this should be the company name. - `attention` string — Attention field can be used for the name of a specific person at the address. - `address1` string — First address line. This should be the street name and number. - `address2` string — Second address line can be used for floor/room number, building name etc. - `postal_code` string — Postal code of the address. - `city` string — City of the address. - `country_code` string — Country code of the address in ISO3166 alpha-2 format. - `email` string — E-mail address of the party. - `phone` string — Phone number of the party. - `attributes` DynamicAttribute[] — Attributes for the party. Used for additional information about the party. - `name` string, required — Name of the attribute. - `value` string, required — Value of the attribute. - `receiver` ShipmentReceiver — Receiver address for the object - `name` string, required — Name of the receiver. Can be either a company name or the name of a private person. - `attention` string, nullable — Attention of the receiver. If the receiver is a company, it is the contact person. - `address1` string, required — Address of the receiver, including address number. - `address2` string, nullable — Second address line of the receiver. Can be used for floor/room number, building name etc. - `zipcode` string, required — Zip code of the address. - `city` string, required — Name of the city that the zip code refers to. - `country_code` string, required — ISO 3166-1 alpha-2 country code of the receiver. - `email` string — Email address of the receiver - `vat_id` string, nullable — Sender's VAT ID in receiver country. - `mobile` string, nullable — Mobile number of the receiver - `telephone` string, nullable — Landline phone number of the receiver - `instruction` string, nullable — Delivery instruction to the carrier. Only applicable for products which support receiver instructions. - `access_code` string, nullable — Gate/door code for the carrier to access the receiver's address. - `date` string, date, nullable — Requested delivery date. format: YYYY-MM-DD - `from_time` string, time, nullable — Requested earliest delivery time. Format HH:MM - `to_time` string, time, nullable — Requested latest delivery time. Format HH:MM - `member_id` string, nullable — Carrier member ID. Some products support/require this; e.g., DHL Parcel shipments to Packstations (DHL PostNumber). - `sender` ShipmentSender — Sender address for the object - `name` string, required — Name of the sender. Can be either a company name or the name of a private person. - `attention` string, nullable — Attention of the sender. If the sender is a company, it is the contact person. - `address1` string, required — Address of the sender, including address number. - `address2` string, nullable — Second address line of the sender. Can be used for floor/room number, building name etc. - `zipcode` string, required — Zip code of the address. - `city` string, required — Name of the city that the zip code refers to. - `country_code` string, required — ISO 3166-1 alpha-2 country code of the sender address. - `vat_id` string, nullable — Sender's VAT ID in receiver country, e.g., VOEC for Norway or GB EORI for Great Britain. - `email` string — Email address of the sender - `mobile` string — Mobile number of the sender - `telephone` string — Landline phone number of the sender - `parcels` Parcel[] - `quantity` integer — Number of parcels of this kind. Maximum quantity depends on the product. - `weight` integer — Weight in grams. - `weight_kg` string — Weight in kilogram. - `pkg_no` string — Carrier's package number refers to the specific package/colli. - `pkg_nos` string[] — Carrier's package numbers for all packages if quantity is larger than 1. - `external_pkg_no` string, nullable — Relevant tracking information other than package number. - `length` integer, nullable — Length in cm - `width` integer, nullable — Width in cm - `height` integer, nullable — Height in cm - `volume` number, nullable — Volume in cubic metres - `running_metre` number, nullable — Running metre in metre - `content` string, nullable — Describes the contents of the parcel. - `packaging` string — Package type for the parcel. Must be a valid package type for the customer. - `stackable` boolean — Whether the parcel can be stacked. - `internal_reference` string, nullable — A reference for internal use to track parcels, not sent to the carrier. - `labelless_code` string, nullable — Labelless code for the parcel. Used for labelless shipments. - `dangerous_goods` DangerousGood[] - `class` string — ADR class of the dangerous goods. - `un_number` string — UN number of the dangerous goods. - `net_weight` integer — Net weight in grams of the dangerous goods. Use either this or net_weight_kg. - `net_weight_kg` number — Net weight in kilograms of the dangerous goods. Use either this or net_weight. - `gross_weight` integer — Gross weight in grams of the dangerous goods. Use either this or gross_weight_kg. - `gross_weight_kg` number — gross weight in kilograms of the dangerous goods. Maximum 3 decimal places. Use either this or gross_weight. - `quantity` integer — Number of pieces of this kind of dangerous goods. - `packaging` string — Packaging the dangerous goods are contained in. - `description` string — Description of the dangerous goods. - `tunnel_restriction_code` string — Tunnel restriction code that applies to the dangerous goods. - `packing_group` string — Packing group that applies to the dangerous goods. - `environmentally_hazardous` boolean — Whether or not the dangerous goods are hazardous to the environment. - `declared_value` DeclaredValue, nullable — Value of the goods in the parcel. Used in terms of insurance for certain carriers. - `amount` number — Valued amount. - `currency_code` string — Currency code for the currency of the amount. - `attributes` DynamicAttribute[] — Attributes for the parcel. Used for additional information. - `name` string, required — Name of the attribute. - `value` string, required — Value of the attribute. - `gls_colli_id` string, nullable — GLS colli ID for the parcel. Used for GLS shipments. - `customs` CustomsResponse, nullable — Custom details used to generate proforma invoice or sent directly to the carrier. This object is only used for shipments where customs declaration is required. - `export_reason` 'sale_of_goods' | 'gift' | 'documents' | 'commercial_samples' | 'returned_goods' | 'other', nullable — Reason for exporting the goods. - `term_of_trade` string, nullable — Incoterm for the shipments, e.g., DDP when customs should be paid by the sender. - `declared_value` string, nullable — Total value of the goods in the shipment. - `currency_code` string, nullable — Currency code for prices declared in goods - `contents` string, nullable — General description of the contents of the shipment. - `duty_payment_type` string, nullable — Legacy field. Use `term_of_trade = 'DDP'` instead. - `duty_account_number` string, nullable — Legacy field. see `'importer'` with attribute `name = 'customer_number'`. - `goods` CustomsGood[] - `quantity` number — Quantity of the goods in the `unit`. Example: 2.0 pieces or 0.5 m2. - `unit` 'piece' | 'm2' — Unit of the `quantity`. - `country_code` string — Country code of origin of the good. - `content` string — Description of the good. - `commodity_code` string — Commodity code (tariff/HS code) of the good. - `unit_value` number — Value of the good per unit. - `unit_weight` integer — Weight in grams of the good per unit. - `attributes` DynamicAttribute[] — Attributes for the commodity good. Used for additional information. - `name` string, required — Name of the attribute. - `value` string, required — Value of the attribute. - `billed_to_custom_invoice_text` string, nullable — Legacy field. See `importer` party with attribute `name` = `invoice_note`. A custom text for the shipment importer. Will appear on proforma/commercial invoice under "Importer" if filled. - `sender_custom_invoice_text` string, nullable — Legacy field. See `sender` party with attribute `name` = `invoice_note`. A custom text for the shipment sender. Will appear on proforma/commercial invoice under "Sender" if filled. - `receiver_custom_invoice_text` string, nullable — Legacy field. See `receiver` party with attribute `name` = `invoice_note`. A custom text for the shipment receiver. Will appear on proforma/commercial invoice under "Delivery to" if filled. - `service_point` ShipmentServicePoint - `id` string — Identifier of the service point. - `name` string — Name of the service point. - `address1` string — Address line 1 of the service point. - `address2` string — Second address line can be used for floor/room number, building name etc. - `zipcode` string — Zip code of the service point. - `city` string — City of the provided zipcode. - `country_code` string — ISO 3166-1 alpha-2 country code of the service point. - `shipping_agent` string — Carrier code of the carrier that the service point belongs to. - `pick_up` PickUp - `name` string - `attention` string - `address1` string - `address2` string — Second address line. Can be used for floor/room number, building name etc. - `country_code` string - `zipcode` string - `city` string - `telephone` string - `instruction` string — Pickup instruction to the carrier. Only applicable for products which supports pickup instructions. - `date` string, date — Requested pickup date. - `from_time` string, time — Requested earliest pickup time. - `to_time` string, time — Requested latest pickup time. - `pickup_custom` boolean — Whether the shipment includes a pickup address other than sender address. - `bill_to` ShipmentBillTo — Customs billing information if it is other than sender/receiver. - `name` string - `attention` string - `address1` string - `address2` string — Second address line can be used for floor/room number, building name etc. - `zipcode` string - `city` string - `country_code` string - `vat_id` string — VAT no. of the customs billing party. - `telephone` string - `mobile` string - `email` string - `bill_to_custom` boolean — Whether the shipment includes a billing address for customs other sender address. - `customer_number` string — Separate carrier customer number to bill if applicable with the given carrier. - `dfm` Dfm, nullable — Special object for extra information when shipping with Danske Fragtmænd. Otherwise it can be ignored. - `insurance_type` 'A' | 'B' | 'C' | 'D', nullable — Type of insurance to be booked. - `insurance_amount` number, nullable — Amount in DKK that should be insured for the shipment. - `dot_type` 'DO1' | 'DO2' | 'DO3' | 'DO4', nullable — Type of DOT used for the shipment. - `dot_time` string, time, nullable — Requested time of DOT delivery. Only valid for DO2, DO3 and DO4. Format: HH:MM - `pallets1` integer, nullable — Legacy field. Use `pallet_exchange` instead. - `pallets2` integer, nullable — Legacy field. Use `pallet_exchange` instead. - `pallets4` integer, nullable — Legacy field. Use `pallet_exchange` instead. - `limited_quantity_weight` integer, nullable — Legacy field. Use `parcels.dangerous_goods` instead. - `has_dangerous_goods` boolean, nullable — Legacy field. Use `parcels.dangerous_goods` instead. - `paperless_trade` boolean — If the shipment is created with paperless trade, then it is not necessary to print out physical proforma invoice. - `labelless_code` string, nullable — If labelless is supported on the certain shipment by the carrier, then this element will be available with the code that can be written on the parcel. - `source_id` string, nullable — ID of the source of the shipment from which it has been created. - `source_type` 'manual' | 'imported' | 'fulfillment' | 'return' | 'repurchase' | 'api' | 'address_book' — The type of the source from which the shipment has been created - `return_shipment_id` string, nullable — ID of the return shipment that has been created for the shipment. - `origin_shipment_id` string, nullable — ID of the origin shipment that the shipment was created as return for. - `carrier_insurance` CarrierInsurance — Object for indicating carrier insurance on the shipment. Only usable for specific carriers and when an insurance service code is provided. - `amount` number, nullable — Amount in the given currency that should be insured for the shipment. - `currency_code` string, nullable — Indicates the currency code for the insured value. - `insurance` object — Object is deprecated. Use "carrier_insurance" instead. - `amount` number, nullable — Amount in the given currency that should be insured for the shipment. - `currency_code` string, nullable — Indicates the currency code for the insured value. - `label_overlay` ShipmentLabelOverlay, nullable — Extra section so that shipment label includes a custom barcode and texts. The size of the label will be in 10 x 21 cm instead of 10 x 19 cm. - `barcode` string - `left_text` string - `right_text` string - `waybill_reference` string, nullable — Reference of the bulk waybill that the shipment is included in. - `pickup_details` object — Details for pickup. - `date` string, date — Requested pickup date. - `from` string, time — Requested earliest pickup time. Format HH:MM:SS. - `to` string, time — Requested latest pickup time. Format HH:MM:SS. - `instruction` string — Pickup instruction to the carrier. Only applicable for products which supports pickup instructions. - `delivery_details` object — Details for delivery. - `date` string, date — Requested delivery date. format: YYYY-MM-DD. - `from` string, time — Requested earliest delivery time. Format HH:MM:SS. - `to` string, time — Requested latest delivery time. Format HH:MM:SS. - `instruction` string — Delivery instruction to the carrier. Only applicable for products which support delivery instructions. ## Other responses - `401` — Unauthorized. - `404` — Resource not found. --- [API](https://skmtc.net/shipmondo/apis/shipmondo-api.md) · [All operations](https://skmtc.net/shipmondo/apis/shipmondo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipmondo/shipmondo-api/versions/dbe9a4ea0826/schema)