Create a shipment draft

Creates a shipment draft.

The shipment draft is an unbooked shipment with any amount of data that can be created through Shipmondo later.

Request body

own_agreementboolean nullable

Whether the shipment is created using an own agreement with the carrier.

customer_numberstring nullable

Customer number used for own agreements with the carrier.

carrier_codestring nullable

Carrier code for the shipment draft.

product_codestring required

Product code for the shipment draft.

service_codesstring[]

Array of service codes applied to the shipment.

terms_of_tradestring nullable

Incoterms for the shipment.

referencestring nullable

Reference for the shipment. Shown on labels and in tracking information.

additional_referencestring nullable

Additional reference for the shipment. Shown on labels and in tracking information.

contentsstring nullable

Description of the contents of the shipment.

origin_shipment_idinteger nullable

ID of the original shipment if this shipment is a return shipment.

service_point_idstring

ID of the service point the shipment should be sent to. Note that the full service point can also be provided in the parties array with type set to service_point.

Example request

{
  "customer_number": "56212",
  "carrier_code": "gls",
  "product_code": "GLSDK_SD",
  "service_codes": [
    "SMS_NT",
    "EMAIL_NT"
  ],
  "terms_of_trade": "DDP",
  "reference": "Order #1234",
  "additional_reference": "Customer #5678",
  "contents": "Books and clothing",
  "origin_shipment_id": 12515120,
  "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"
        }
      ]
    }
  ],
  "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-13",
    "from": "08:00:00",
    "to": "16:00:00",
    "instruction": "Goods are placed at gate 21"
  },
  "parcels": [
    {
      "quantity": 1,
      "weight": 1000,
      "length": 20,
      "width": 10,
      "height": 6,
      "volume": 0.012,
      "loading_meter": 1.25,
      "description": "Bike accessories",
      "package_type": "PL1",
      "stackable": true,
      "internal_reference": "parcel-1",
      "dangerous_goods": [
        {
          "hazard_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"
      }
    }
  ],
  "customs": {
    "attributes": [
      {
        "name": "vat_no",
        "value": "DK36399066"
      }
    ],
    "export_reason": "other",
    "goods": [
      {
        "quantity": 2,
        "country_code": "DK",
        "description": "Cotton t-shirt",
        "commodity_code": "6109100010",
        "unit_value": 122.5,
        "unit_weight": 110,
        "attributes": [
          {
            "name": "vat_no",
            "value": "DK36399066"
          }
        ]
      }
    ]
  },
  "cod": {
    "amount": 326,
    "currency_code": "NOK",
    "account_number": "123456789"
  },
  "carrier_insurance": {
    "amount": 1000,
    "currency_code": "DKK"
  },
  "attributes": [
    {
      "name": "vat_no",
      "value": "DK36399066"
    }
  ],
  "service_point_id": "96271"
}

Response

Successful.

idinteger

ID of the shipment draft.

created_atstring date-time

Timestamp of when the shipment draft was created.

updated_atstring date-time

Timestamp of when the shipment draft was last updated.