Shipments

Retrieve a shipment

Returns the details of a shipment.

get/shipments/{id}

Path parameters

idinteger required

ID for the shipment to be included in the filter

Response

Successful.

idinteger

ID of the shipment.

created_atstring date-time

Date and time the shipment was created.

updated_atstring date-time

Date and time the shipment was last updated.

carrier_codestring

Carrier code referring to the carrier of the shipment.

descriptionstring

Text to describe the shipment, which can be used when presenting it.

contentsstring nullable

General description of the contents of the shipment.

term_of_tradestring

Incoterm for the shipments, e.g., DDP when customs should be paid by the sender.

product_idinteger

ID of the product of the shipment.

product_codestring

Product code of the product of the shipment.

service_codesstring nullable

Comma-separated string of codes of services that is booked with the shipment.

servicesstring nullable

Comma-separated string of IDs of services that are booked with the shipment.

customer_numberstring nullable

Customer number of the agreement used to book the shipment. If value is null it is Shipmondo's agreement

pricestring

Price of the shipment including VAT.

referencestring nullable

Sender's reference of the shipment.

additional_referencestring nullable

An secondary reference. When possible, it will be transmitted to the carrier and printed on the label

order_idstring nullable

Order no. from webshop, if shipment is based on an order in Shipmondo.

pkg_nostring nullable

Carrier's shipment number, referring to the whole shipment.

external_pkg_nostring nullable

Package number from an external source.

paperless_tradeboolean

If the shipment is created with paperless trade, then it is not necessary to print out physical proforma invoice.

labelless_codestring 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_idinteger 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_idinteger nullable

ID of the return shipment that has been created for the shipment.

origin_shipment_idinteger nullable

ID of the origin shipment that the shipment was created as return for.

waybill_referencestring nullable

Reference of the bulk waybill that the shipment is included in.

Example response

{
  "id": 1168,
  "created_at": "2017-06-16T06:25:44.557Z",
  "updated_at": "2017-06-16T06:25:44.557Z",
  "carrier_code": "gls",
  "description": "ShopDelivery",
  "contents": "Goods",
  "term_of_trade": "DAP",
  "product_id": 64,
  "product_code": "GLSDK_SD",
  "service_codes": "EMAIL_NT,SMS_NT",
  "services": "23,24",
  "price": "42.5",
  "reference": "5678123",
  "additional_reference": "Invoice 10001",
  "order_id": "5678123",
  "pkg_no": "6064518784",
  "external_pkg_no": "123-4567-890",
  "parties": [
    {
      "type": "sender",
      "name": "Min Virksomhed ApS",
      "attention": "Lene Hansen",
      "address1": "Hvilehøjvej 25",
      "postal_code": "5220",
      "city": "Odense SØ",
      "country_code": "DK",
      "email": "info@minvirksomhed.dk",
      "phone": "+4570400407",
      "attributes": [
        {
          "name": "vat_no",
          "value": "DK36399066"
        }
      ]
    }
  ],
  "receiver": {
    "name": "Lene Hansen",
    "address1": "Skibhusvej 52",
    "zipcode": "5000",
    "city": "Odense C",
    "country_code": "DK",
    "email": "lene@email.dk",
    "vat_id": "DK12345678",
    "mobile": "12345678",
    "telephone": "12345678",
    "instruction": "Place on the front porch.",
    "access_code": "4231",
    "date": "2021-10-14",
    "from_time": "08:00",
    "to_time": "16:00",
    "member_id": "a1b2c3"
  },
  "sender": {
    "name": "Min Virksomhed ApS",
    "attention": "Lene Hansen",
    "address1": "Strandvejen 6B",
    "address2": "Stuen",
    "zipcode": "5240",
    "city": "Odense NØ",
    "country_code": "DK",
    "vat_id": "5323471",
    "email": "info@minvirksomhed.dk",
    "mobile": "70400407",
    "telephone": "70400407"
  },
  "parcels": [
    {
      "quantity": 1,
      "weight": 1000,
      "weight_kg": "10.9",
      "pkg_no": "1064548752",
      "pkg_nos": [
        "1064548752"
      ],
      "external_pkg_no": "123-4567-890",
      "length": 20,
      "width": 10,
      "height": 6,
      "volume": 0.012,
      "running_metre": 1.25,
      "content": "Bike accessories",
      "packaging": "PL1",
      "stackable": true,
      "internal_reference": "parcel-1",
      "labelless_code": "123-456-789",
      "dangerous_goods": [
        {
          "class": "3",
          "un_number": "1202",
          "net_weight": 20100,
          "net_weight_kg": 20.1,
          "gross_weight": 20100,
          "gross_weight_kg": 20.1,
          "quantity": 3,
          "packaging": "drums",
          "description": "DIESEL FUEL, < 62°C (640K)",
          "tunnel_restriction_code": "A",
          "packing_group": "III"
        }
      ],
      "declared_value": {
        "amount": 1250,
        "currency_code": "DKK"
      },
      "attributes": [
        {
          "name": "vat_no",
          "value": "DK36399066"
        }
      ],
      "gls_colli_id": "123-456-789"
    }
  ],
  "customs": {
    "export_reason": "other",
    "term_of_trade": "DAP",
    "declared_value": "1000.00",
    "currency_code": "DKK",
    "contents": "Goods",
    "duty_account_number": "Goods",
    "goods": [
      {
        "quantity": 2,
        "unit": "piece",
        "country_code": "DK",
        "content": "Cotton t-shirt",
        "commodity_code": "6109100010",
        "unit_value": 122.5,
        "unit_weight": 110,
        "attributes": [
          {
            "name": "vat_no",
            "value": "DK36399066"
          }
        ]
      }
    ],
    "billed_to_custom_invoice_text": "Key code: ABC123",
    "sender_custom_invoice_text": "Key code: ABC123",
    "receiver_custom_invoice_text": "Key code: ABC123"
  },
  "service_point": {
    "id": "95558",
    "name": "Påskeløkkens Købmand",
    "address1": "Paaskeløkkevej 11",
    "zipcode": "5000",
    "city": "Odense C",
    "country_code": "DK",
    "shipping_agent": "gls"
  },
  "pick_up": {
    "name": "Min Virksomhed A/S",
    "address1": "Hvilehøjvej 25",
    "country_code": "DK",
    "zipcode": "5220",
    "city": "Odense SØ",
    "telephone": "80808080",
    "instruction": "Goods are placed at gate 21",
    "date": "2021-10-13",
    "from_time": "08:00",
    "to_time": "16:00"
  },
  "bill_to": {
    "name": "Min Virksomhed A/S",
    "address1": "Hvilehøjvej 25",
    "zipcode": "5220",
    "city": "Odense SØ",
    "country_code": "DK",
    "vat_id": "DK12345678",
    "telephone": "80808080",
    "mobile": "80808080",
    "email": "jim@minvirksomhed.dk",
    "customer_number": "12345678"
  },
  "dfm": {
    "insurance_type": "A",
    "insurance_amount": 1000,
    "dot_type": "DO1",
    "dot_time": "15:00",
    "pallets1": 1,
    "pallets2": 1,
    "pallets4": 1,
    "limited_quantity_weight": 1000,
    "has_dangerous_goods": true
  },
  "labelless_code": "123-4567-890",
  "source_id": 1000001234,
  "source_type": "manual",
  "return_shipment_id": 1000001234,
  "origin_shipment_id": 1000001235,
  "carrier_insurance": {
    "amount": 1000,
    "currency_code": "DKK"
  },
  "insurance": {
    "amount": 1000,
    "currency_code": "DKK"
  },
  "label_overlay": {
    "barcode": "1234567890123",
    "left_text": "ABC",
    "right_text": "DEF"
  },
  "waybill_reference": "CS000000000NO",
  "pickup_details": {
    "date": "2021-10-13",
    "from": "08:00:00",
    "to": "16:00:00",
    "instruction": "Goods are placed at gate 21"
  },
  "delivery_details": {
    "date": "2021-10-14",
    "from": "08:00:00",
    "to": "16:00:00",
    "instruction": "Place on the front porch."
  }
}

Changes

Changed in 2 of the 5 revisions of this API.4721

    • the response property bill_to/address1 became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/address2 became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/attention became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/bill_to_custom became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/city became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/country_code became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/customer_number became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/email became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/mobile became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/name became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/telephone became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/vat_id became nullable for the status 200

      response-property-became-nullable

    • the response property bill_to/zipcode became nullable for the status 200

      response-property-became-nullable

    • the response property delivery_details became nullable for the status 200

      response-property-became-nullable

    • the response property parcels/items/declared_value/allOf[DeclaredValue]/amount became nullable for the status 200

      response-property-became-nullable

    • the response property parcels/items/declared_value/allOf[DeclaredValue]/currency_code became nullable for the status 200

      response-property-became-nullable

    • the response property parcels/items/pkg_no became nullable for the status 200

      response-property-became-nullable

    • the response property parcels/items/pkg_nos became nullable for the status 200

      response-property-became-nullable

    • the response property parties/items/address2 became nullable for the status 200

      response-property-became-nullable

    • the response property parties/items/attention became nullable for the status 200

      response-property-became-nullable

    • the response property parties/items/email became nullable for the status 200

      response-property-became-nullable

    • the response property parties/items/phone became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/address1 became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/address2 became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/attention became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/city became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/country_code became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/date became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/from_time became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/instruction became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/name became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/pickup_custom became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/telephone became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/to_time became nullable for the status 200

      response-property-became-nullable

    • the response property pick_up/zipcode became nullable for the status 200

      response-property-became-nullable

    • the response property pickup_details became nullable for the status 200

      response-property-became-nullable

    • the response property pkg_no became nullable for the status 200

      response-property-became-nullable

    • the response property receiver/email became nullable for the status 200

      response-property-became-nullable

    • the response property sender/email became nullable for the status 200

      response-property-became-nullable

    • the response property sender/mobile became nullable for the status 200

      response-property-became-nullable

    • the response property sender/telephone became nullable for the status 200

      response-property-became-nullable

    • the response property service_codes became nullable for the status 200

      response-property-became-nullable

    • the response property service_point/address2 became nullable for the status 200

      response-property-became-nullable

    • the origin_shipment_id response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the return_shipment_id response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the source_id response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

  • ad86900cf9c2121See the full diff
    • the parcels/items/declared_value response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property parcels/items/declared_value/amount from the response with the 200 status

      response-optional-property-removed

    • removed the optional property parcels/items/declared_value/currency_code from the response with the 200 status

      response-optional-property-removed

    • added DeclaredValue to the parcels/items/declared_value response property allOf list for the response status 200

      response-property-all-of-added