v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB

Shipment templates

List all shipment templates

Returns a list of shipment templates.

get/shipment_templates

Query parameters

idinteger

ID for the shipment template to be included in the filter

sender_countrystring

Example:DK

Country code (ISO Alpha-2) to be included in the filter.

receiver_countrystring

Example:DK

Country code (ISO Alpha-2) to be included in the filter.

per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

Response

Successful.

idinteger

ID of the shipment template. Used when referencing a specific template in other requests.

namestring

Given name of the template.

defaultboolean

Whether or not the template is the default to be used when no other is selected.

product_codestring

Code for the product that is booked when using the template.

own_agreementboolean

Whether or not the shipments are booked with the template is using own agreement or Shipmondo agreement.

customer_numberstring

The customer number that is attached to the template.

service_codesstring

Comma-separated string of service codes referring to which services that is booked when using the template.

Example response

[
  {
    "id": 11460,
    "name": "GLS Shipments",
    "default": true,
    "product_code": "GLSDK_HD",
    "customer_number": "123456789",
    "service_codes": "EMAIL_NT,SMS_NT",
    "sender": {
      "country_code": "DK"
    },
    "receiver": {
      "country_code": "DK"
    },
    "parcels": [
      {
        "quantity": 1,
        "weight": 1000,
        "length": 20,
        "width": 10,
        "height": 6,
        "volume": 0.012,
        "running_metre": 1.25,
        "description": "Bike accessories",
        "packaging": "PL1",
        "stackable": true,
        "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"
          }
        ]
      }
    ]
  }
]