AddShipmentRequest

Request to create a new shipment with one or more freights

externalShipmentIdstringrequired

Unique shipment identifier in your source system

Possible values: non-empty

Example: SH-2024-001

assigneestringnullable

User identifier for owner / Assignee of freight in Swipload / Email in the case of a department user

Example: albrektm / email@domain.tld

shippersReferencestringnullable

Shipper's internal shipment reference

Example: OurInternalShipmentReference

projectNamestringnullable

Project name to associate with the shipment

projectNumberstringnullable

Project number. If set, this is used as the unique project identifier. If not set, ProjectName is used instead.

freights object[]required

Freights to be added to the Shipment

Array [

freightTypeFreightType (string)

Freight type id enum.

Possible values: [Standard, Return, PickupByCustomer]

statusIdFreightStatusCode (string)

Freight status id enum.

Possible values: [Draft, PendingApproval, Open, InTransit, Delivered, Deleted, PendingDetails, PendingPickup, Cancelled]

externalFreightIdstringrequired

Unique freight id in source system

Possible values: non-empty

Example: a62f7d2b-2ddf-4c1c-9a93-98c39f05f382

shippersReferencestringnullable

Shipper's internal freight order reference

Example: OurInternalFreightOrderReference

consignorsReferencestringnullable

Consignors reference on Freight.

Example: G1444-45

consigneesReferencestringnullable

Consignees reference on Freight.

Example: G1444-45

senderContactCompanystringrequired

Sender company name

Possible values: non-empty

Example: Our company AS

senderContactPersonstringnullable

Sender contact person name

Example: John Doe

senderContactCellphonestringnullable

Sender contact person phone, in E.164 format.

Example: +4740484410

recipientContactCompanystringrequired

Receiving company name

Possible values: non-empty

Example: Cargo Receiver AS

recipientContactPersonstringnullable

Receiving contact person name

Example: Jane Doe

recipientContactCellphonestringnullable

Receiving contact person phone, in E.164 format.

Example: +4740484410

pickupLocation objectrequired

A pickup or delivery location with address, coordinates, and time window

addressstringnullable

Address

Example: Elgfaret 72

zipCodestringnullable

Zip

Possible values: <= 12 characters

Example: 3930

citystringnullable

City

Example: Porsgrunn

countryCodestringnullable

Country code

Example: NO

latitudenumber<double>nullable

Latitude of location

Example: 59.915318

longitudenumber<double>nullable

Longitude of location

Example: 10.745938

contactCompanystringnullable

Name of company or location

fromDatestring<date-time>

Earliest point in time, if null this will be set to the current time

toDatestring<date-time>nullable

Latest point in time

dateTimeOffsetSpanstring<date-span>nullable

Extra info to use in DateTimeOffsets if and when needed

deliveryLocation objectrequired

A pickup or delivery location with address, coordinates, and time window

addressstringnullable

Address

Example: Elgfaret 72

zipCodestringnullable

Zip

Possible values: <= 12 characters

Example: 3930

citystringnullable

City

Example: Porsgrunn

countryCodestringnullable

Country code

Example: NO

latitudenumber<double>nullable

Latitude of location

Example: 59.915318

longitudenumber<double>nullable

Longitude of location

Example: 10.745938

contactCompanystringnullable

Name of company or location

fromDatestring<date-time>

Earliest point in time, if null this will be set to the current time

toDatestring<date-time>nullable

Latest point in time

dateTimeOffsetSpanstring<date-span>nullable

Extra info to use in DateTimeOffsets if and when needed

pickupCommentstringnullable

Additional pickup details

Example: Please contact sender when it comes to the departure day.

deliveryCommentstringnullable

Additional delivery details

Example: Contact warehouse manager for instructions where to unload the goods.

sumQtyinteger<int32>nullable

Total quantity

Example: 1

sumWeightnumber<double>nullable

Total weight in kilograms

Example: 1200

sumVolumenumber<double>nullable

Total volume in m^3

Example: 12

lengthinteger<int32>nullable

Length in centimeters (cm)

Example: 230

widthinteger<int32>nullable

Width in centimeters (cm)

Example: 60

heightinteger<int32>nullable

Height in centimeters (cm)

Example: 192

jobDescriptionstringnullable

Description of the order

Example: A blue container filled with rocks. Ready at the terminal on given time. Remember to always drive carefully - stay safe!

sumPalletsnumber<double>nullable

Total pallets

Example: 3

sumLoadingMetersnumber<double>nullable

Total loading meters

Example: 9

sumChargeableWeightnumber<double>nullable

Total chargeable weight in kilograms

Example: 1200

freightLines object[]nullable

Individual freight lines (cargo items) within this freight

Array [

namestringnullable

Arbitrary product name.

Possible values: <= 250 characters

Example: Block of concrete

itemNumberstringnullable

Arbitrary item number.

Possible values: <= 50 characters

Example: B-123

descriptionstringnullable

Description of product

Possible values: <= 250 characters

Example: Nicely patinated with colorcode #532943

ianstringnullable

International Article Number (also known as European Article Number or EAN)

Possible values: <= 13 characters

Example: 4131618458562

ssccstringnullable

Serial Shipping Container Codes (SSCCs)

Possible values: <= 18 characters

Example: 230874513969584500

locationstringnullable

Location if product, i.e. warehouse code

Possible values: <= 50 characters

Example: P3

quantitynumber<double>nullable

Quantity

Example: 2

palletsinteger<int32>nullable

Pallets

weightnumber<double>nullable

Weight in kilograms

Example: 1.1111

volumenumber<double>nullable

Volume in m^3

Example: 1.111111

lengthnumber<double>nullable

Lenght in centimeters (cm)

Example: 1.1111

widthnumber<double>nullable

Width in centimeters (cm)

Example: 1.1111

heightnumber<double>nullable

Height in centimeters (cm)

Example: 1.1111

loadingMetersnumber<double>nullable

Loading meter (LDM)

Example: 1.1111

thknumber<double>nullable

Thickness of horizontal elements (cm)

Example: 1.1111

]

documentList object[]nullable

Documents to attach to the freight (e.g. packing lists, CMR)

Array [

fileNamestringnullable

Name of the file including extension

Example: delivery_note.pdf

fileContentTypestringnullable

MIME content type of the file. If omitted, it will be inferred from the file extension.

Example: application/pdf

fileContentBase64stringnullable

File content encoded as a Base64 string. Do not include the Data URI prefix (e.g. "data:image/png;base64,").

Example: JVBERi0xLjQKJcOkw7zDtsOf...

]

]

targetDepartmentstringnullable

If company departments are enabled for the shipper, this is required

AddShipmentRequest

{
  "externalShipmentId": "SH-2024-001",
  "assignee": "albrektm / email@domain.tld",
  "shippersReference": "OurInternalShipmentReference",
  "projectName": "string",
  "projectNumber": "string",
  "freights": [
    {
      "freightType": "Standard",
      "statusId": "Draft",
      "externalFreightId": "a62f7d2b-2ddf-4c1c-9a93-98c39f05f382",
      "shippersReference": "OurInternalFreightOrderReference",
      "consignorsReference": "G1444-45",
      "consigneesReference": "G1444-45",
      "senderContactCompany": "Our company AS",
      "senderContactPerson": "John Doe",
      "senderContactCellphone": "+4740484410",
      "recipientContactCompany": "Cargo Receiver AS",
      "recipientContactPerson": "Jane Doe",
      "recipientContactCellphone": "+4740484410",
      "pickupLocation": {
        "address": "Elgfaret 72",
        "zipCode": "3930",
        "city": "Porsgrunn",
        "countryCode": "NO",
        "latitude": 59.915318,
        "longitude": 10.745938,
        "contactCompany": "string",
        "fromDate": "2024-07-29T15:51:28.071Z",
        "toDate": "2024-07-29T15:51:28.071Z",
        "dateTimeOffsetSpan": "string"
      },
      "deliveryLocation": {
        "address": "Elgfaret 72",
        "zipCode": "3930",
        "city": "Porsgrunn",
        "countryCode": "NO",
        "latitude": 59.915318,
        "longitude": 10.745938,
        "contactCompany": "string",
        "fromDate": "2024-07-29T15:51:28.071Z",
        "toDate": "2024-07-29T15:51:28.071Z",
        "dateTimeOffsetSpan": "string"
      },
      "pickupComment": "Please contact sender when it comes to the departure day.",
      "deliveryComment": "Contact warehouse manager for instructions where to unload the goods.",
      "sumQty": 1,
      "sumWeight": 1200,
      "sumVolume": 12,
      "length": 230,
      "width": 60,
      "height": 192,
      "jobDescription": "A blue container filled with rocks. Ready at the terminal on given time. Remember to always drive carefully - stay safe!",
      "sumPallets": 3,
      "sumLoadingMeters": 9,
      "sumChargeableWeight": 1200,
      "freightLines": [
        {
          "name": "Block of concrete",
          "itemNumber": "B-123",
          "description": "Nicely patinated with colorcode #532943",
          "ian": "4131618458562",
          "sscc": "230874513969584500",
          "location": "P3",
          "quantity": 2,
          "pallets": 0,
          "weight": 1.1111,
          "volume": 1.111111,
          "length": 1.1111,
          "width": 1.1111,
          "height": 1.1111,
          "loadingMeters": 1.1111,
          "thk": 1.1111
        }
      ],
      "documentList": [
        {
          "fileName": "delivery_note.pdf",
          "fileContentType": "application/pdf",
          "fileContentBase64": "JVBERi0xLjQKJcOkw7zDtsOf..."
        }
      ]
    }
  ],
  "targetDepartment": "string"
}