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.

Other endpoints

Download schema

Get Loading Point for yard integration

GET

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

/loadingPoints

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get loading points by reference number or site reference number. Response includes loading points and relevant assigned products.

Get Loading Point for yard integration › query Parameters

siteReferenceNumber

string · required

Reference Number of Site for Loading Points

referenceNumber

string

Reference Number of Loading Point

offset

string

limit

string

Get Loading Point for yard integration › 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 Loading Point for yard integration › Responses

Found Loading Points

searchResponse_publicYardLoadingPointResponse

count

integer | null · int64

publicYardLoadingPointResponse[]

object

GET/loadingPoints

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

Example Responses

{
  "count": 0,
  "results": [
    {
      "companyId": "companyId",
      "siteReferenceNumber": "siteReferenceNumber",
      "referenceNumber": "referenceNumber",
      "name": "name",
      "buildingName": "buildingName",
      "isWarehouse": true,
      "openingHours": {
        "monday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "tuesday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "wednesday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "thursday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "friday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "saturday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "sunday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "closedDays": [
          {
            "type": "type",
            "from": {
              "year": 0,
              "month": 0,
              "day": 0,
              "dayOfWeek": 0,
              "dayOfYear": 0,
              "dayNumber": 0
            },
            "to": {
              "year": 0,
              "month": 0,
              "day": 0,
              "dayOfWeek": 0,
              "dayOfYear": 0,
              "dayNumber": 0
            }
          }
        ]
      },
      "driveInTimeRestrictions": {
        "earliestDriveInBeforeOpeningMinutes": 0,
        "latestDriveInBeforeClosingMinutes": 0,
        "earliestDriveInBeforePlannedSlotMinutes": 0,
        "latestDriveInBeforePlannedSlotMinutes": 0
      },
      "processes": [
        {
          "id": "id",
          "additionalInformation": "additionalInformation"
        }
      ],
      "assignedProducts": [
        {
          "productName": "productName",
          "referenceNumber": "referenceNumber",
          "processes": [
            {
              "id": "id",
              "additionalInformation": "additionalInformation"
            }
          ],
          "updatedTimeUtc": "2024-08-25T15:00:00Z"
        }
      ],
      "updatedTimeUtc": "2024-08-25T15:00:00Z"
    }
  ],
  "facetResults": {
    "key": [
      {
        "value": {},
        "count": 0
      }
    ]
  }
}

json

application/json

Get Unloading Point for yard integration

GET

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

/unloadingPoints

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get unloading points by reference number or site reference number. Response includes unloading points and relevant assigned products.

Get Unloading Point for yard integration › query Parameters

siteReferenceNumber

string · required

Reference Number of Site for Unloading Points

referenceNumber

string

Reference Number of Unloading Point

offset

string

limit

string

Get Unloading Point for yard integration › 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 Unloading Point for yard integration › Responses

Found Unloading Points

searchResponse_publicYardUnloadingPointResponse

count

integer | null · int64

publicYardUnloadingPointResponse[]

object

GET/unloadingPoints

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

Example Responses

{
  "count": 0,
  "results": [
    {
      "companyId": "companyId",
      "siteReferenceNumber": "siteReferenceNumber",
      "referenceNumber": "referenceNumber",
      "name": "name",
      "buildingName": "buildingName",
      "isWarehouse": true,
      "openingHours": {
        "monday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "tuesday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "wednesday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "thursday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "friday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "saturday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "sunday": {
          "isOpen": true,
          "isOpenAllDay": true,
          "hours": [
            {
              "from": "from",
              "to": "to"
            }
          ]
        },
        "closedDays": [
          {
            "type": "type",
            "from": {
              "year": 0,
              "month": 0,
              "day": 0,
              "dayOfWeek": 0,
              "dayOfYear": 0,
              "dayNumber": 0
            },
            "to": {
              "year": 0,
              "month": 0,
              "day": 0,
              "dayOfWeek": 0,
              "dayOfYear": 0,
              "dayNumber": 0
            }
          }
        ]
      },
      "driveInTimeRestrictions": {
        "earliestDriveInBeforeOpeningMinutes": 0,
        "latestDriveInBeforeClosingMinutes": 0,
        "earliestDriveInBeforePlannedSlotMinutes": 0,
        "latestDriveInBeforePlannedSlotMinutes": 0
      },
      "processes": [
        {
          "id": "id",
          "additionalInformation": "additionalInformation"
        }
      ],
      "assignedProducts": [
        {
          "productName": "productName",
          "referenceNumber": "referenceNumber",
          "processes": [
            {
              "id": "id",
              "additionalInformation": "additionalInformation"
            }
          ],
          "updatedTimeUtc": "2024-08-25T15:00:00Z"
        }
      ],
      "updatedTimeUtc": "2024-08-25T15:00:00Z"
    }
  ],
  "facetResults": {
    "key": [
      {
        "value": {},
        "count": 0
      }
    ]
  }
}

json

application/json

Get Loading Point for yard integration

GET

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

/loadingPoints

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get loading points by reference number or site reference number. Response includes loading points and relevant assigned products.

Get Loading Point for yard integration › query Parameters

siteReferenceNumber

string · required

Reference Number of Site for Loading Points

referenceNumber

string

Reference Number of Loading Point

offset

string

limit

string

Get Loading Point for yard integration › 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 Loading Point for yard integration › Responses

Found Loading Points

searchResponse_publicYardLoadingPointResponse

count

integer | null · int64

publicYardLoadingPointResponse[]

object

Get Unloading Point for yard integration

GET

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

/unloadingPoints

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Get unloading points by reference number or site reference number. Response includes unloading points and relevant assigned products.

Get Unloading Point for yard integration › query Parameters

siteReferenceNumber

string · required

Reference Number of Site for Unloading Points

referenceNumber

string

Reference Number of Unloading Point

offset

string

limit

string

Get Unloading Point for yard integration › 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 Unloading Point for yard integration › Responses

Found Unloading Points

searchResponse_publicYardUnloadingPointResponse

count

integer | null · int64

publicYardUnloadingPointResponse[]

object