Other endpoints

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

upsertPublicBusinessPartnerRequest

GET/

curl 'https://api-playground.loady.com/public/businessPartners/v1?referenceNumber=<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",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Update or create if not exist business partner by reference number

PUT

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to update or create if not exist a business partner

Update or create if not exist business partner by reference number › query Parameters

referenceNumber

string

ReferenceNumber of business partner that needs to be upserted

Update or create if not exist business partner 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 or create if not exist business partner by reference number › Request Body

referenceNumber

string

companyType

string

automaticSiteCreation

boolean | null

name

string

email

string

telephone

string

faxNumber

string

Update or create if not exist business partner by reference number › Responses

Updated business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

createPublicBusinessPartnerRequest

PUT/

curl https://api-playground.loady.com/public/businessPartners/v1 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "referenceNumber": "referenceNumber",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "name": "name",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}'

Example Request Body

{
  "referenceNumber": "referenceNumber",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "name": "name",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Create business partner

POST

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to create a business partner

Create business partner › 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 business partner › Request Body

name

string

referenceNumber

string

managedByCompanyId

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

Create business partner › Responses

Created business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

POST/

curl https://api-playground.loady.com/public/businessPartners/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",
  "managedByCompanyId": "managedByCompanyId",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Delete business partner by reference number

DELETE

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to delete a business partner

Delete business partner by reference number › query Parameters

referenceNumber

string · required

ReferenceNumber of business partner that needs to be deleted

Delete business partner 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 business partner by reference number › Responses

Success

Get business partner by id

GET

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

/{businessPartnerId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint used to get business partner's information

Get business partner by id › path Parameters

businessPartnerId

string · required

Id of business partner

Get business partner 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 business partner by id › Responses

200

Business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

updatePublicBusinessPartnerRequest

GET/{businessPartnerId}

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

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Update business partner

PUT

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

/{businessPartnerId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to update a business partner

Update business partner › path Parameters

businessPartnerId

string · required

Id of business partner

Update business partner › 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 business partner › Request Body

name

string

email

string

telephone

string

faxNumber

string

Update business partner › Responses

Updated business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

PUT/{businessPartnerId}

curl https://api-playground.loady.com/public/businessPartners/v1/:businessPartnerId \
  --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",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}'

Example Request Body

{
  "name": "name",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Delete business partner by reference number

DELETE

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

/{businessPartnerId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to delete a business partner

Delete business partner by reference number › path Parameters

businessPartnerId

string · required

Id of business partner that needs to be deleted

Delete business partner 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 business partner by reference number › Responses

Success

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.

Business Partners API

Other endpoints

Download schema

Get business partner by reference number

GET

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to get business partner's information

Get business partner by reference number › query Parameters

referenceNumber

string · required

ReferenceNumber of business partner

Get business partner 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 business partner by reference number › Responses

200

Business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

upsertPublicBusinessPartnerRequest

GET/

curl 'https://api-playground.loady.com/public/businessPartners/v1?referenceNumber=<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",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Update or create if not exist business partner by reference number

PUT

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to update or create if not exist a business partner

Update or create if not exist business partner by reference number › query Parameters

referenceNumber

string

ReferenceNumber of business partner that needs to be upserted

Update or create if not exist business partner 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 or create if not exist business partner by reference number › Request Body

referenceNumber

string

companyType

string

automaticSiteCreation

boolean | null

name

string

email

string

telephone

string

faxNumber

string

Update or create if not exist business partner by reference number › Responses

Updated business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

createPublicBusinessPartnerRequest

PUT/

curl https://api-playground.loady.com/public/businessPartners/v1 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'x-company-id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>' \
  --data '{
  "referenceNumber": "referenceNumber",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "name": "name",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}'

Example Request Body

{
  "referenceNumber": "referenceNumber",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "name": "name",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Create business partner

POST

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to create a business partner

Create business partner › 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 business partner › Request Body

name

string

referenceNumber

string

managedByCompanyId

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

Create business partner › Responses

Created business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

POST/

curl https://api-playground.loady.com/public/businessPartners/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",
  "managedByCompanyId": "managedByCompanyId",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}'

Example Request Body

{
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Delete business partner by reference number

DELETE

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

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to delete a business partner

Delete business partner by reference number › query Parameters

referenceNumber

string · required

ReferenceNumber of business partner that needs to be deleted

Delete business partner 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 business partner by reference number › Responses

Success

Get business partner by id

GET

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

/{businessPartnerId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint used to get business partner's information

Get business partner by id › path Parameters

businessPartnerId

string · required

Id of business partner

Get business partner 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 business partner by id › Responses

200

Business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

updatePublicBusinessPartnerRequest

GET/{businessPartnerId}

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

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Update business partner

PUT

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

/{businessPartnerId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to update a business partner

Update business partner › path Parameters

businessPartnerId

string · required

Id of business partner

Update business partner › 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 business partner › Request Body

name

string

email

string

telephone

string

faxNumber

string

Update business partner › Responses

Updated business partner

id

string

name

string

referenceNumber

string

managedByCompanyId

string

managedByName

string

companyType

string

automaticSiteCreation

boolean | null

email

string

telephone

string

faxNumber

string

PUT/{businessPartnerId}

curl https://api-playground.loady.com/public/businessPartners/v1/:businessPartnerId \
  --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",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}'

Example Request Body

{
  "name": "name",
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "referenceNumber": "referenceNumber",
  "managedByCompanyId": "managedByCompanyId",
  "managedByName": "managedByName",
  "companyType": "companyType",
  "automaticSiteCreation": true,
  "email": "email",
  "telephone": "telephone",
  "faxNumber": "faxNumber",
  "address": {
    "addressCountry": "addressCountry",
    "postalCode": "postalCode",
    "addressLocality": "addressLocality",
    "streetAddress": "streetAddress",
    "addressAddition": "addressAddition"
  }
}

json

application/json

Delete business partner by reference number

DELETE

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

/{businessPartnerId}

OAuth 2.0

+Ocp-Apim-Subscription-Key (header)

Endpoint to delete a business partner

Delete business partner by reference number › path Parameters

businessPartnerId

string · required

Id of business partner that needs to be deleted

Delete business partner 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 business partner by reference number › Responses

Success