Other endpoints

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

GET/

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

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Unloading Point by Reference Number

PUT

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update an Unloading Point by Reference Number

Update Unloading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of an Unloading Point

siteReferenceNumber

string · required

Reference number of a Site to which an Unloading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which an Unloading Point belongs

Update Unloading Point by Reference Number › 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

Update Unloading Point by Reference Number › Request Body

name

string · minLength: 1 · required

Name of the Unloading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Unloading Point

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

Update Unloading Point by Reference Number › Responses

The updated Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

publicCreateUnloadingPointCommand

Contacts of the Unloading Point

PUT/

curl 'https://api-playground.loady.com/public/unloadingPoints/v1?referenceNumber=<string>&siteReferenceNumber=<string>' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Create Unloading Point

POST

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to create an Unloading Point

Create Unloading Point › 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 Unloading Point › Request Body

name

string · minLength: 1 · required

Name of the Unloading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site for which the Unloading Point should be created

siteReferenceNumber

string | null

Reference number of the Site for which the Unloading Point should be created. Either SiteId or SiteReferenceNumber must be present. SiteId takes precedence.

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

businessPartnerReferenceNumber

string

Create Unloading Point › Responses

The created Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

POST/

curl https://api-playground.loady.com/public/unloadingPoints/v1 \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  },
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber"
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  },
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Delete Unloading Point by Reference Number

DELETE

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to delete an Unloading Point by Reference Number

Delete Unloading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of an Unloading Point

siteReferenceNumber

string · required

Reference number of a Site to which an Unloading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which an Unloading Point belongs

Delete Unloading Point by Reference Number › 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 Unloading Point by Reference Number › Responses

The Unloading Point was successfully deleted

No data returned

Get Unloading Point by ID

GET

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

/{unloadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to get an Unloading Point by ID

Get Unloading Point by ID › path Parameters

unloadingPointId

string · required

ID of the Unloading Point

Get Unloading Point 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 Unloading Point by ID › Responses

The requested Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

GET/{unloadingPointId}

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

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Unloading Point by ID

PUT

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

/{unloadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update an Unloading Point by ID

Update Unloading Point by ID › path Parameters

unloadingPointId

string · required

ID of an Unloading Point

Update Unloading Point 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

Update Unloading Point by ID › Request Body

name

string · minLength: 1 · required

Name of the Unloading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Unloading Point

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

Update Unloading Point by ID › Responses

The updated Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

PUT/{unloadingPointId}

curl https://api-playground.loady.com/public/unloadingPoints/v1/:unloadingPointId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Delete Unloading Point by ID

DELETE

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

/{unloadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to delete an Unloading Point by ID

Delete Unloading Point by ID › path Parameters

unloadingPointId

string · required

ID of an Unloading Point

Delete Unloading Point 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 Unloading Point by ID › Responses

The Unloading Point was successfully deleted

No data returned

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.

Unloading Points API

Other endpoints

Download schema

Get Unloading Point by Reference Number

GET

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to get an Unloading Point by Reference Number

Get Unloading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of an Unloading Point

siteReferenceNumber

string · required

Reference number of a Site to which an Unloading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which an Unloading Point belongs

Get Unloading Point by Reference Number › 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 by Reference Number › Responses

The requested Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

GET/

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

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Unloading Point by Reference Number

PUT

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update an Unloading Point by Reference Number

Update Unloading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of an Unloading Point

siteReferenceNumber

string · required

Reference number of a Site to which an Unloading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which an Unloading Point belongs

Update Unloading Point by Reference Number › 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

Update Unloading Point by Reference Number › Request Body

name

string · minLength: 1 · required

Name of the Unloading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Unloading Point

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

Update Unloading Point by Reference Number › Responses

The updated Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

publicCreateUnloadingPointCommand

Contacts of the Unloading Point

PUT/

curl 'https://api-playground.loady.com/public/unloadingPoints/v1?referenceNumber=<string>&siteReferenceNumber=<string>' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Create Unloading Point

POST

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to create an Unloading Point

Create Unloading Point › 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 Unloading Point › Request Body

name

string · minLength: 1 · required

Name of the Unloading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site for which the Unloading Point should be created

siteReferenceNumber

string | null

Reference number of the Site for which the Unloading Point should be created. Either SiteId or SiteReferenceNumber must be present. SiteId takes precedence.

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

businessPartnerReferenceNumber

string

Create Unloading Point › Responses

The created Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

POST/

curl https://api-playground.loady.com/public/unloadingPoints/v1 \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  },
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber"
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  },
  "businessPartnerReferenceNumber": "businessPartnerReferenceNumber"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Delete Unloading Point by Reference Number

DELETE

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to delete an Unloading Point by Reference Number

Delete Unloading Point by Reference Number › query Parameters

referenceNumber

string · required

Reference Number of an Unloading Point

siteReferenceNumber

string · required

Reference number of a Site to which an Unloading Point belongs

businessPartnerReferenceNumber

string

Reference number of a Business Partner to which an Unloading Point belongs

Delete Unloading Point by Reference Number › 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 Unloading Point by Reference Number › Responses

The Unloading Point was successfully deleted

No data returned

Get Unloading Point by ID

GET

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

/{unloadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to get an Unloading Point by ID

Get Unloading Point by ID › path Parameters

unloadingPointId

string · required

ID of the Unloading Point

Get Unloading Point 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 Unloading Point by ID › Responses

The requested Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

GET/{unloadingPointId}

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

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "siteId": "siteId",
  "siteName": "siteName",
  "siteReferenceNumber": "siteReferenceNumber",
  "buildingName": "buildingName",
  "address": {
    "location": {
      "longitude": 0,
      "latitude": 0
    },
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition",
    "addressCountry": "addressCountry"
  },
  "contacts": {
    "contacts": [
      {
        "id": "id",
        "values": [
          {
            "languageCode": "languageCode",
            "phone": "phone",
            "additionalPhone": "additionalPhone",
            "email": "email",
            "name": "name",
            "description": "description",
            "isEmpty": true
          }
        ]
      }
    ]
  }
}

json

application/json

Update Unloading Point by ID

PUT

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

/{unloadingPointId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

The endpoint provides the ability to update an Unloading Point by ID

Update Unloading Point by ID › path Parameters

unloadingPointId

string · required

ID of an Unloading Point

Update Unloading Point 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

Update Unloading Point by ID › Request Body

name

string · minLength: 1 · required

Name of the Unloading Point

referenceNumber

string · minLength: 1 · required

ERP reference number of the Unloading Point

address

Address of the Unloading Point

contacts

Contacts of the Unloading Point

Update Unloading Point by ID › Responses

The updated Unloading Point

id

string

ID of the Unloading Point

name

string

Name of the Unloading Point

referenceNumber

string

ERP reference number of the Unloading Point

siteId

string | null

ID of the Site to which the Unloading Point belongs

siteName

string | null

Name of the Site to which the Unloading Point belongs

siteReferenceNumber

string | null

Reference Number of the Site to which the Unloading Point belongs

buildingName

string | null

Name of the Building

address

Address of the Unloading Point

contacts