Other endpoints

unlimitedValidation

boolean | null

validFrom

string | null · date-time

validTo

string | null · date-time

assignmentValidFrom

string | null · date-time

assignmentValidTo

string | null · date-time

POST/referenceNumbers

curl https://api-playground.loady.com/public/lanes/v1/referenceNumbers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignedPartners": [
    "string"
  ],
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z",
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}'

Example Request Body

{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignedPartners": [
    "string"
  ],
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z",
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}

json

Example Responses

{
  "loady2GoLink": "loady2GoLink",
  "loady2GoLinkValidity": 0,
  "loady2ShareLink": "loady2ShareLink",
  "loady2ShareLinkValidity": 0,
  "id": "id",
  "companyFromId": "companyFromId",
  "companyFromName": "companyFromName",
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "productId": "productId",
  "productName": "productName",
  "productReferenceNumber": "productReferenceNumber",
  "siteFromId": "siteFromId",
  "siteFromName": "siteFromName",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointId": "loadingPointId",
  "loadingPointName": "loadingPointName",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "companyToId": "companyToId",
  "companyToName": "companyToName",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToId": "siteToId",
  "siteToName": "siteToName",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductId": "unloadedProductId",
  "unloadedProductName": "unloadedProductName",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointId": "unloadingPointId",
  "unloadingPointName": "unloadingPointName",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "assignedPartners": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z"
}

json

application/json

Get lane by id

GET

https://api-playground.loady.com/public/lanes/v1

/{laneId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to get lane's information

Get lane by id › path Parameters

laneId

string · required

Id of lane

Get lane by id › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Get lane by id › Responses

200

Lane

id

string

companyFromId

string

companyFromName

string

companyFromReferenceNumber

string

productId

string

productName

string

productReferenceNumber

string

siteFromId

string

siteFromName

string

siteFromReferenceNumber

string

loadingPointId

string

loadingPointName

string

loadingPointReferenceNumber

string

companyToId

string

companyToName

string

companyToReferenceNumber

string

siteToId

string

siteToName

string

siteToReferenceNumber

string

unloadedProductId

string

unloadedProductName

string

unloadedProductReferenceNumber

string

unloadingPointId

string

unloadingPointName

string

unloadingPointReferenceNumber

string

unlimitedValidation

boolean | null

validFrom

string | null · date-time

validTo

string | null · date-time

assignmentValidFrom

string | null · date-time

assignmentValidTo

string | null · date-time

GET/{laneId}

curl https://api-playground.loady.com/public/lanes/v1/:laneId \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "id": "id",
  "companyFromId": "companyFromId",
  "companyFromName": "companyFromName",
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "productId": "productId",
  "productName": "productName",
  "productReferenceNumber": "productReferenceNumber",
  "siteFromId": "siteFromId",
  "siteFromName": "siteFromName",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointId": "loadingPointId",
  "loadingPointName": "loadingPointName",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "companyToId": "companyToId",
  "companyToName": "companyToName",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToId": "siteToId",
  "siteToName": "siteToName",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductId": "unloadedProductId",
  "unloadedProductName": "unloadedProductName",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointId": "unloadingPointId",
  "unloadingPointName": "unloadingPointName",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "assignedPartners": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z"
}

json

application/json

Delete lane by id

DELETE

https://api-playground.loady.com/public/lanes/v1

/{laneId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint provides possibility to delete a lane

Delete lane by id › path Parameters

laneId

string · required

Id of lane

Delete lane by id › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Delete lane by id › Responses

No description

No data returned

Get lane using reference numbers

POST

https://api-playground.loady.com/public/lanes/v1

/search

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to get lane's information

Get lane using reference numbers › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Get lane using reference numbers › Request Body

companyFromReferenceNumber

string

siteFromReferenceNumber

string

loadingPointReferenceNumber

string

productReferenceNumber

string

companyToReferenceNumber

string

siteToReferenceNumber

string

unloadedProductReferenceNumber

string

unloadingPointReferenceNumber

string

dataValidity

string · date-time

Data validity for temperature requirements

Get lane using reference numbers › Responses

200

Lane

id

string

companyFromId

string

companyFromName

string

companyFromReferenceNumber

string

productId

string

productName

string

productReferenceNumber

string

siteFromId

string

siteFromName

string

siteFromReferenceNumber

string

loadingPointId

string

loadingPointName

string

loadingPointReferenceNumber

string

companyToId

string

companyToName

string

companyToReferenceNumber

string

siteToId

string

siteToName

string

siteToReferenceNumber

string

unloadedProductId

string

unloadedProductName

string

unloadedProductReferenceNumber

string

unloadingPointId

string

unloadingPointName

string

unloadingPointReferenceNumber

string

unlimitedValidation

boolean | null

validFrom

string | null · date-time

validTo

string | null · date-time

assignmentValidFrom

string | null · date-time

assignmentValidTo

string | null · date-time

POST/search

curl https://api-playground.loady.com/public/lanes/v1/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "dataValidity": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "dataValidity": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "id",
  "companyFromId": "companyFromId",
  "companyFromName": "companyFromName",
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "productId": "productId",
  "productName": "productName",
  "productReferenceNumber": "productReferenceNumber",
  "siteFromId": "siteFromId",
  "siteFromName": "siteFromName",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointId": "loadingPointId",
  "loadingPointName": "loadingPointName",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "companyToId": "companyToId",
  "companyToName": "companyToName",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToId": "siteToId",
  "siteToName": "siteToName",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductId": "unloadedProductId",
  "unloadedProductName": "unloadedProductName",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointId": "unloadingPointId",
  "unloadingPointName": "unloadingPointName",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "assignedPartners": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z"
}

json

application/json

Create links to Loady2Go and Loady2Share

POST

https://api-playground.loady.com/public/lanes/v1

/{laneId}/loadyLink

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to create links to Loady2Go and Loady2Share

Create links to Loady2Go and Loady2Share › path Parameters

laneId

string · required

Id of lane

Create links to Loady2Go and Loady2Share › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Create links to Loady2Go and Loady2Share › Request Body

createLinksPublicLaneDto

createLoady2GoLink

boolean | null

createLoady2ShareLink

boolean | null

loady2GoLinkValidity

integer | null · int32

loady2ShareLinkValidity

integer | null · int32

Create links to Loady2Go and Loady2Share › Responses

Created links

publicLinksDto

loady2GoLink

string

loady2GoLinkValidity

integer · int32

loady2ShareLink

string

loady2ShareLinkValidity

integer · int32

POST/{laneId}/loadyLink

curl https://api-playground.loady.com/public/lanes/v1/:laneId/loadyLink \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}'

Example Request Body

{
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}

json

Example Responses

{
  "loady2GoLink": "loady2GoLink",
  "loady2GoLinkValidity": 0,
  "loady2ShareLink": "loady2ShareLink",
  "loady2ShareLinkValidity": 0
}

json

application/json

Get Logistics Requirements of a Lane (for Freight Order) in the text format

GET

https://api-playground.loady.com/public/lanes/v1

/{laneId}/logisticsRequirementsText

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get logistics requirements (loading and unloading) of a lane for a specific freight order by Loady IDs in the text format.

Get Logistics Requirements of a Lane (for Freight Order) in the text format › path Parameters

laneId

string · required

Id of lane

Get Logistics Requirements of a Lane (for Freight Order) in the text format › query Parameters

dataValidity

string

Data validity for temperature requirements

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Accept-Language

string

Language to be used in response

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Responses

200

Logistics Requirements in text format

GET/{laneId}/logisticsRequirementsText

curl https://api-playground.loady.com/public/lanes/v1/:laneId/logisticsRequirementsText \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "loadingRequirements": {
    "productCleaningRequirement": [
      "string"
    ],
    "productSafety": [
      "string"
    ],
    "loadingPointSlotBooking": [
      "string"
    ],
    "loadingPointVehicleAccessRestrictions": [
      "string"
    ],
    "loadingPointAvailableEquipmentPackedGoods": [
      "string"
    ],
    "loadingPointOpeningHours": [
      "string"
    ],
    "loadingPointContacts": [
      "string"
    ],
    "siteFromSafetySecurityRequirements": [
      "string"
    ],
    "assignedProductTechnicalRequirementsVehicle": [
      "string"
    ],
    "assignedProductTechnicalRequirementsBulk": [
      "string"
    ],
    "assignedProductTechnicalRequirementsEquipmentPacked": [
      "string"
    ],
    "assignedProductTechnicalRequirementCargoSecuring": [
      "string"
    ],
    "assignedProductPacking": [
      "string"
    ],
    "assignedProductTechnicalRequirementsTemperatureRequirements": [
      "string"
    ],
    "assignedProductDocuments": [
      "string"
    ],
    "assignedProductInstructions": [
      "string"
    ],
    "assignedProductTransportPlanning": [
      "string"
    ]
  },
  "unloadingRequirements": {
    "companyToSiteCheckIn": [
      "string"
    ],
    "siteToSafetySecurityRequirements": [
      "string"
    ],
    "companyToUnloadingPointSlotBooking": [
      "string"
    ],
    "unloadingPointVehicleAccessRestrictions": [
      "string"
    ],
    "unloadingPointAvailableEquipmentPackedGoods": [
      "string"
    ],
    "unloadingPointOpeningHours": [
      "string"
    ],
    "unloadingPointContacts": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsVehicle": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsBulk": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsEquipmentPacked": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementCargoSecuring": [
      "string"
    ],
    "companyToAssignedProductPacking": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsTemperatureRequirements": [
      "string"
    ],
    "companyToAssignedProductDocuments": [
      "string"
    ],
    "companyToAssignedProductInstructions": [
      "string"
    ],
    "companyToAssignedProductInstructionsCustoms": [
      "string"
    ],
    "companyToAssignedProductTransportPlanning": [
      "string"
    ]
  }
}

json

application/json

Get Logistics Requirements of a Lane (for Freight Order) in the text format

POST

https://api-playground.loady.com/public/lanes/v1

/logisticsRequirementsText/byReferenceNumber

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get logistics requirements (loading and unloading) of a lane for a specific freight order by by reference numbers in the text format.

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Accept-Language

string

Language to be used in response

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Request Body

companyFromReferenceNumber

string

siteFromReferenceNumber

string

loadingPointReferenceNumber

string

productReferenceNumber

string

companyToReferenceNumber

string

siteToReferenceNumber

string

unloadedProductReferenceNumber

string

unloadingPointReferenceNumber

string

dataValidity

string · date-time

Data validity for temperature requirements

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Responses

200

Logistics Requirements in text format

POST/logisticsRequirementsText/byReferenceNumber

curl https://api-playground.loady.com/public/lanes/v1/logisticsRequirementsText/byReferenceNumber \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "dataValidity": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "dataValidity": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "loadingRequirements": {
    "productCleaningRequirement": [
      "string"
    ],
    "productSafety": [
      "string"
    ],
    "loadingPointSlotBooking": [
      "string"
    ],
    "loadingPointVehicleAccessRestrictions": [
      "string"
    ],
    "loadingPointAvailableEquipmentPackedGoods": [
      "string"
    ],
    "loadingPointOpeningHours": [
      "string"
    ],
    "loadingPointContacts": [
      "string"
    ],
    "siteFromSafetySecurityRequirements": [
      "string"
    ],
    "assignedProductTechnicalRequirementsVehicle": [
      "string"
    ],
    "assignedProductTechnicalRequirementsBulk": [
      "string"
    ],
    "assignedProductTechnicalRequirementsEquipmentPacked": [
      "string"
    ],
    "assignedProductTechnicalRequirementCargoSecuring": [
      "string"
    ],
    "assignedProductPacking": [
      "string"
    ],
    "assignedProductTechnicalRequirementsTemperatureRequirements": [
      "string"
    ],
    "assignedProductDocuments": [
      "string"
    ],
    "assignedProductInstructions": [
      "string"
    ],
    "assignedProductTransportPlanning": [
      "string"
    ]
  },
  "unloadingRequirements": {
    "companyToSiteCheckIn": [
      "string"
    ],
    "siteToSafetySecurityRequirements": [
      "string"
    ],
    "companyToUnloadingPointSlotBooking": [
      "string"
    ],
    "unloadingPointVehicleAccessRestrictions": [
      "string"
    ],
    "unloadingPointAvailableEquipmentPackedGoods": [
      "string"
    ],
    "unloadingPointOpeningHours": [
      "string"
    ],
    "unloadingPointContacts": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsVehicle": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsBulk": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsEquipmentPacked": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementCargoSecuring": [
      "string"
    ],
    "companyToAssignedProductPacking": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsTemperatureRequirements": [
      "string"
    ],
    "companyToAssignedProductDocuments": [
      "string"
    ],
    "companyToAssignedProductInstructions": [
      "string"
    ],
    "companyToAssignedProductInstructionsCustoms": [
      "string"
    ],
    "companyToAssignedProductTransportPlanning": [
      "string"
    ]
  }
}

json

application/json

Try this APIPGCredentials required

Requests run against https://api-playground.loady.com/public and can change real PG data. You are responsible for every request you send.

Values stay in this tab's memory only and are cleared when the page reloads. They are sent directly to the configured Loady authentication and API endpoints.

Lanes API

Other endpoints

Download schema

Create lane using reference numbers

POST

https://api-playground.loady.com/public/lanes/v1

/referenceNumbers

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to create a lane using reference numbers

Create lane using reference numbers › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Create lane using reference numbers › Request Body

createPublicLaneDto

companyFromReferenceNumber

string

siteFromReferenceNumber

string

loadingPointReferenceNumber

string

productReferenceNumber

string

companyToReferenceNumber

string

siteToReferenceNumber

string

unloadedProductReferenceNumber

string

unloadingPointReferenceNumber

string

unlimitedValidation

boolean | null

validFrom

string | null · date-time

validTo

string | null · date-time

assignedPartners

string[]

assignmentValidFrom

string · date-time

assignmentValidTo

string | null · date-time

createLoady2GoLink

boolean | null

createLoady2ShareLink

boolean | null

loady2GoLinkValidity

integer | null · int32

loady2ShareLinkValidity

integer | null · int32

Create lane using reference numbers › Responses

Created lane

createdPublicLaneDto

loady2GoLink

string

loady2GoLinkValidity

integer · int32

loady2ShareLink

string

loady2ShareLinkValidity

integer · int32

id

string

companyFromId

string

companyFromName

string

companyFromReferenceNumber

string

productId

string

productName

string

productReferenceNumber

string

siteFromId

string

siteFromName

string

siteFromReferenceNumber

string

loadingPointId

string

loadingPointName

string

loadingPointReferenceNumber

string

companyToId

string

companyToName

string

companyToReferenceNumber

string

siteToId

string

siteToName

string

siteToReferenceNumber

string

unloadedProductId

string

unloadedProductName

string

unloadedProductReferenceNumber

string

unloadingPointId

string

unloadingPointName

string

unloadingPointReferenceNumber

string

unlimitedValidation

boolean | null

validFrom

string | null · date-time

validTo

string | null · date-time

assignmentValidFrom

string | null · date-time

assignmentValidTo

string | null · date-time

POST/referenceNumbers

curl https://api-playground.loady.com/public/lanes/v1/referenceNumbers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignedPartners": [
    "string"
  ],
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z",
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}'

Example Request Body

{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignedPartners": [
    "string"
  ],
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z",
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}

json

Example Responses

{
  "loady2GoLink": "loady2GoLink",
  "loady2GoLinkValidity": 0,
  "loady2ShareLink": "loady2ShareLink",
  "loady2ShareLinkValidity": 0,
  "id": "id",
  "companyFromId": "companyFromId",
  "companyFromName": "companyFromName",
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "productId": "productId",
  "productName": "productName",
  "productReferenceNumber": "productReferenceNumber",
  "siteFromId": "siteFromId",
  "siteFromName": "siteFromName",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointId": "loadingPointId",
  "loadingPointName": "loadingPointName",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "companyToId": "companyToId",
  "companyToName": "companyToName",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToId": "siteToId",
  "siteToName": "siteToName",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductId": "unloadedProductId",
  "unloadedProductName": "unloadedProductName",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointId": "unloadingPointId",
  "unloadingPointName": "unloadingPointName",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "assignedPartners": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z"
}

json

application/json

Get lane by id

GET

https://api-playground.loady.com/public/lanes/v1

/{laneId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to get lane's information

Get lane by id › path Parameters

laneId

string · required

Id of lane

Get lane by id › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Get lane by id › Responses

200

Lane

id

string

companyFromId

string

companyFromName

string

companyFromReferenceNumber

string

productId

string

productName

string

productReferenceNumber

string

siteFromId

string

siteFromName

string

siteFromReferenceNumber

string

loadingPointId

string

loadingPointName

string

loadingPointReferenceNumber

string

companyToId

string

companyToName

string

companyToReferenceNumber

string

siteToId

string

siteToName

string

siteToReferenceNumber

string

unloadedProductId

string

unloadedProductName

string

unloadedProductReferenceNumber

string

unloadingPointId

string

unloadingPointName

string

unloadingPointReferenceNumber

string

unlimitedValidation

boolean | null

validFrom

string | null · date-time

validTo

string | null · date-time

assignmentValidFrom

string | null · date-time

assignmentValidTo

string | null · date-time

GET/{laneId}

curl https://api-playground.loady.com/public/lanes/v1/:laneId \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "id": "id",
  "companyFromId": "companyFromId",
  "companyFromName": "companyFromName",
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "productId": "productId",
  "productName": "productName",
  "productReferenceNumber": "productReferenceNumber",
  "siteFromId": "siteFromId",
  "siteFromName": "siteFromName",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointId": "loadingPointId",
  "loadingPointName": "loadingPointName",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "companyToId": "companyToId",
  "companyToName": "companyToName",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToId": "siteToId",
  "siteToName": "siteToName",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductId": "unloadedProductId",
  "unloadedProductName": "unloadedProductName",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointId": "unloadingPointId",
  "unloadingPointName": "unloadingPointName",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "assignedPartners": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z"
}

json

application/json

Delete lane by id

DELETE

https://api-playground.loady.com/public/lanes/v1

/{laneId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint provides possibility to delete a lane

Delete lane by id › path Parameters

laneId

string · required

Id of lane

Delete lane by id › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Delete lane by id › Responses

No description

No data returned

Get lane using reference numbers

POST

https://api-playground.loady.com/public/lanes/v1

/search

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to get lane's information

Get lane using reference numbers › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Get lane using reference numbers › Request Body

companyFromReferenceNumber

string

siteFromReferenceNumber

string

loadingPointReferenceNumber

string

productReferenceNumber

string

companyToReferenceNumber

string

siteToReferenceNumber

string

unloadedProductReferenceNumber

string

unloadingPointReferenceNumber

string

dataValidity

string · date-time

Data validity for temperature requirements

Get lane using reference numbers › Responses

200

Lane

id

string

companyFromId

string

companyFromName

string

companyFromReferenceNumber

string

productId

string

productName

string

productReferenceNumber

string

siteFromId

string

siteFromName

string

siteFromReferenceNumber

string

loadingPointId

string

loadingPointName

string

loadingPointReferenceNumber

string

companyToId

string

companyToName

string

companyToReferenceNumber

string

siteToId

string

siteToName

string

siteToReferenceNumber

string

unloadedProductId

string

unloadedProductName

string

unloadedProductReferenceNumber

string

unloadingPointId

string

unloadingPointName

string

unloadingPointReferenceNumber

string

unlimitedValidation

boolean | null

validFrom

string | null · date-time

validTo

string | null · date-time

assignmentValidFrom

string | null · date-time

assignmentValidTo

string | null · date-time

POST/search

curl https://api-playground.loady.com/public/lanes/v1/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "dataValidity": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "productReferenceNumber": "productReferenceNumber",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "dataValidity": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "id",
  "companyFromId": "companyFromId",
  "companyFromName": "companyFromName",
  "companyFromReferenceNumber": "companyFromReferenceNumber",
  "productId": "productId",
  "productName": "productName",
  "productReferenceNumber": "productReferenceNumber",
  "siteFromId": "siteFromId",
  "siteFromName": "siteFromName",
  "siteFromReferenceNumber": "siteFromReferenceNumber",
  "loadingPointId": "loadingPointId",
  "loadingPointName": "loadingPointName",
  "loadingPointReferenceNumber": "loadingPointReferenceNumber",
  "companyToId": "companyToId",
  "companyToName": "companyToName",
  "companyToReferenceNumber": "companyToReferenceNumber",
  "siteToId": "siteToId",
  "siteToName": "siteToName",
  "siteToReferenceNumber": "siteToReferenceNumber",
  "unloadedProductId": "unloadedProductId",
  "unloadedProductName": "unloadedProductName",
  "unloadedProductReferenceNumber": "unloadedProductReferenceNumber",
  "unloadingPointId": "unloadingPointId",
  "unloadingPointName": "unloadingPointName",
  "unloadingPointReferenceNumber": "unloadingPointReferenceNumber",
  "assignedPartners": [
    {
      "id": "id",
      "name": "name"
    }
  ],
  "unlimitedValidation": true,
  "validFrom": "2024-08-25T15:00:00Z",
  "validTo": "2024-08-25T15:00:00Z",
  "assignmentValidFrom": "2024-08-25T15:00:00Z",
  "assignmentValidTo": "2024-08-25T15:00:00Z"
}

json

application/json

Create links to Loady2Go and Loady2Share

POST

https://api-playground.loady.com/public/lanes/v1

/{laneId}/loadyLink

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to create links to Loady2Go and Loady2Share

Create links to Loady2Go and Loady2Share › path Parameters

laneId

string · required

Id of lane

Create links to Loady2Go and Loady2Share › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Create links to Loady2Go and Loady2Share › Request Body

createLinksPublicLaneDto

createLoady2GoLink

boolean | null

createLoady2ShareLink

boolean | null

loady2GoLinkValidity

integer | null · int32

loady2ShareLinkValidity

integer | null · int32

Create links to Loady2Go and Loady2Share › Responses

Created links

publicLinksDto

loady2GoLink

string

loady2GoLinkValidity

integer · int32

loady2ShareLink

string

loady2ShareLinkValidity

integer · int32

POST/{laneId}/loadyLink

curl https://api-playground.loady.com/public/lanes/v1/:laneId/loadyLink \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}'

Example Request Body

{
  "createLoady2GoLink": true,
  "createLoady2ShareLink": true,
  "loady2GoLinkValidity": 0,
  "loady2ShareLinkValidity": 0
}

json

Example Responses

{
  "loady2GoLink": "loady2GoLink",
  "loady2GoLinkValidity": 0,
  "loady2ShareLink": "loady2ShareLink",
  "loady2ShareLinkValidity": 0
}

json

application/json

Get Logistics Requirements of a Lane (for Freight Order) in the text format

GET

https://api-playground.loady.com/public/lanes/v1

/{laneId}/logisticsRequirementsText

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get logistics requirements (loading and unloading) of a lane for a specific freight order by Loady IDs in the text format.

Get Logistics Requirements of a Lane (for Freight Order) in the text format › path Parameters

laneId

string · required

Id of lane

Get Logistics Requirements of a Lane (for Freight Order) in the text format › query Parameters

dataValidity

string

Data validity for temperature requirements

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Accept-Language

string

Language to be used in response

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Responses

200

Logistics Requirements in text format

GET/{laneId}/logisticsRequirementsText

curl https://api-playground.loady.com/public/lanes/v1/:laneId/logisticsRequirementsText \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'

Example Responses

{
  "loadingRequirements": {
    "productCleaningRequirement": [
      "string"
    ],
    "productSafety": [
      "string"
    ],
    "loadingPointSlotBooking": [
      "string"
    ],
    "loadingPointVehicleAccessRestrictions": [
      "string"
    ],
    "loadingPointAvailableEquipmentPackedGoods": [
      "string"
    ],
    "loadingPointOpeningHours": [
      "string"
    ],
    "loadingPointContacts": [
      "string"
    ],
    "siteFromSafetySecurityRequirements": [
      "string"
    ],
    "assignedProductTechnicalRequirementsVehicle": [
      "string"
    ],
    "assignedProductTechnicalRequirementsBulk": [
      "string"
    ],
    "assignedProductTechnicalRequirementsEquipmentPacked": [
      "string"
    ],
    "assignedProductTechnicalRequirementCargoSecuring": [
      "string"
    ],
    "assignedProductPacking": [
      "string"
    ],
    "assignedProductTechnicalRequirementsTemperatureRequirements": [
      "string"
    ],
    "assignedProductDocuments": [
      "string"
    ],
    "assignedProductInstructions": [
      "string"
    ],
    "assignedProductTransportPlanning": [
      "string"
    ]
  },
  "unloadingRequirements": {
    "companyToSiteCheckIn": [
      "string"
    ],
    "siteToSafetySecurityRequirements": [
      "string"
    ],
    "companyToUnloadingPointSlotBooking": [
      "string"
    ],
    "unloadingPointVehicleAccessRestrictions": [
      "string"
    ],
    "unloadingPointAvailableEquipmentPackedGoods": [
      "string"
    ],
    "unloadingPointOpeningHours": [
      "string"
    ],
    "unloadingPointContacts": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsVehicle": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsBulk": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsEquipmentPacked": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementCargoSecuring": [
      "string"
    ],
    "companyToAssignedProductPacking": [
      "string"
    ],
    "companyToAssignedProductTechnicalRequirementsTemperatureRequirements": [
      "string"
    ],
    "companyToAssignedProductDocuments": [
      "string"
    ],
    "companyToAssignedProductInstructions": [
      "string"
    ],
    "companyToAssignedProductInstructionsCustoms": [
      "string"
    ],
    "companyToAssignedProductTransportPlanning": [
      "string"
    ]
  }
}

json

application/json

Get Logistics Requirements of a Lane (for Freight Order) in the text format

POST

https://api-playground.loady.com/public/lanes/v1

/logisticsRequirementsText/byReferenceNumber

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get logistics requirements (loading and unloading) of a lane for a specific freight order by by reference numbers in the text format.

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Headers

x-company-id

string · required

Identifies the company within which the operation is performed

Authorization

string · required

Contains an authorization token

Ocp-Apim-Subscription-Key

string · required

Subscription key required to use API

Accept-Language

string

Language to be used in response

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Request Body

companyFromReferenceNumber

string

siteFromReferenceNumber

string

loadingPointReferenceNumber

string

productReferenceNumber

string

companyToReferenceNumber

string

siteToReferenceNumber

string

unloadedProductReferenceNumber

string

unloadingPointReferenceNumber

string

dataValidity

string · date-time

Data validity for temperature requirements

Get Logistics Requirements of a Lane (for Freight Order) in the text format › Responses

200

Logistics Requirements in text format