Business invitations

PreviousAnalyses NextBusiness connections

Last updated 6 months ago

Invite a business to join your commercial network.

Creates a business invitation, which represents an invitation to a business to join your commercial network so that you can get access to their data.

post

/business-invitations

Authorizations

Body

emailstringrequired

email of the user representing the business that this invitation is for

Example: user@example.com

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.tradeaware.live-eo.com/business-invitations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user@example.com"
  }'

201

401

403

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sentByUser": {
    "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
    "business": "[Circular Reference]",
    "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "firstName": "Paul",
    "lastName": "Smith",
    "locale": "id-ID",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "completed": "false",
    "businessInvitations": "[Circular Reference]",
    "userInvitations": "[Circular Reference]",
    "email": "user@example.com",
    "consentedAt": "2023-07-28T09:13:37Z",
    "entitlements": {
      "canTriggerPrecisionAnalysis": false
    }
  },
  "business": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "email": "user@example.com",
    "name": "Example Inc.",
    "username": "John Doe",
    "addressStreet": "Salawati 143",
    "addressZip": "98451",
    "addressPostcode": "12345",
    "addressArea": "Brandenburg",
    "addressCity": "West Papua",
    "addressCountryCode": "ID",
    "addressCountry": "Indonesia",
    "addressLine1": "Salawati 123",
    "addressLine2": "3rd floor",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "initialLocale": "id-ID",
    "units": "metric",
    "plots": "[Circular Reference]",
    "newlyCreated": "true",
    "members": "[Circular Reference]",
    "connectionsAsSource": "[Circular Reference]",
    "connectionsAsTarget": "[Circular Reference]",
    "businessInvitations": "[Circular Reference]",
    "contactPerson": "[Circular Reference]",
    "machineToMachineClientId": "1234567890asdfghjk",
    "eori": "text",
    "vat": "text"
  },
  "email": "user@example.com",
  "status": "PENDING",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "sourceIsInvitee": "true"
}

List all the business invitations you received.

List all business invitations you have received from other businesses. Business invitations cancelled by the sender will not be included in the response.

get

/business-invitations

Authorizations

Query parameters

statusstring · enum[]

Filters by status. If missing, includes all statuses. To include multiple statuses, use the 'explode' syntax, for example, '?status=ACCEPTED&status=PENDING'

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.tradeaware.live-eo.com/business-invitations' \
  --header 'Authorization: Bearer JWT'

200

401

403

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "sentByUser": {
      "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
      "business": "[Circular Reference]",
      "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "firstName": "Paul",
      "lastName": "Smith",
      "locale": "id-ID",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "completed": "false",
      "businessInvitations": "[Circular Reference]",
      "userInvitations": "[Circular Reference]",
      "email": "user@example.com",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false
      }
    },
    "business": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": "[Circular Reference]",
      "newlyCreated": "true",
      "members": "[Circular Reference]",
      "connectionsAsSource": "[Circular Reference]",
      "connectionsAsTarget": "[Circular Reference]",
      "businessInvitations": "[Circular Reference]",
      "contactPerson": "[Circular Reference]",
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text"
    },
    "email": "user@example.com",
    "status": "PENDING",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "updatedAt": "2020-01-01T00:00:00.000Z",
    "sourceIsInvitee": "true"
  }
]

List all the business invitations you have sent.

List all business invitations you have sent to other businesses to join your commercial network.

get

/business-invitations/sent

Authorizations

Query parameters

statusstring · enum[]

Filters by status. If missing, includes all statuses. To include multiple statuses, use the 'explode' syntax, for example, '?status=ACCEPTED&status=PENDING'

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.tradeaware.live-eo.com/business-invitations/sent' \
  --header 'Authorization: Bearer JWT'

200

401

403

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "sentByUser": {
      "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
      "business": "[Circular Reference]",
      "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "firstName": "Paul",
      "lastName": "Smith",
      "locale": "id-ID",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "completed": "false",
      "businessInvitations": "[Circular Reference]",
      "userInvitations": "[Circular Reference]",
      "email": "user@example.com",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false
      }
    },
    "business": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": "[Circular Reference]",
      "newlyCreated": "true",
      "members": "[Circular Reference]",
      "connectionsAsSource": "[Circular Reference]",
      "connectionsAsTarget": "[Circular Reference]",
      "businessInvitations": "[Circular Reference]",
      "contactPerson": "[Circular Reference]",
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text"
    },
    "email": "user@example.com",
    "status": "PENDING",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "updatedAt": "2020-01-01T00:00:00.000Z",
    "sourceIsInvitee": "true"
  }
]

Update a business invitation.

Update the properties of the specified business invitation. Handles updates partially, i.e. properties missing in the request body will not be changed. Use this endpoint to update the status of the business invitation, i.e. to ACCEPTED or REJECTED.

If you have sent the invitation, you can also cancel it with this endpoint and the status CANCELLED.

patch

/business-invitations/{id}

Authorizations

Path parameters

idstringrequired

Body

statusall ofrequired

new status for this invitation

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.tradeaware.live-eo.com/business-invitations/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "PENDING"
  }'

200

401

403

404

422

501

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sentByUser": {
    "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
    "business": "[Circular Reference]",
    "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "firstName": "Paul",
    "lastName": "Smith",
    "locale": "id-ID",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "completed": "false",
    "businessInvitations": "[Circular Reference]",
    "userInvitations": "[Circular Reference]",
    "email": "user@example.com",
    "consentedAt": "2023-07-28T09:13:37Z",
    "entitlements": {
      "canTriggerPrecisionAnalysis": false
    }
  },
  "business": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "email": "user@example.com",
    "name": "Example Inc.",
    "username": "John Doe",
    "addressStreet": "Salawati 143",
    "addressZip": "98451",
    "addressPostcode": "12345",
    "addressArea": "Brandenburg",
    "addressCity": "West Papua",
    "addressCountryCode": "ID",
    "addressCountry": "Indonesia",
    "addressLine1": "Salawati 123",
    "addressLine2": "3rd floor",
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-28T09:13:37Z",
    "initialLocale": "id-ID",
    "units": "metric",
    "plots": "[Circular Reference]",
    "newlyCreated": "true",
    "members": "[Circular Reference]",
    "connectionsAsSource": "[Circular Reference]",
    "connectionsAsTarget": "[Circular Reference]",
    "businessInvitations": "[Circular Reference]",
    "contactPerson": "[Circular Reference]",
    "machineToMachineClientId": "1234567890asdfghjk",
    "eori": "text",
    "vat": "text"
  },
  "email": "user@example.com",
  "status": "PENDING",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "sourceIsInvitee": "true"
}

Invite a business to join your commercial network.

List all the business invitations you received.

Show child attributes

List all the business invitations you have sent.

Show child attributes

Update a business invitation.

Show child attributes