Eezee API Documentation BETA (latest) (1.1)

Download OpenAPI specification:Download

This page contains the documentation on how to use Eezee through API calls.

Previous API versions

API V1.0

Authentication

apiKey

Security Scheme Type API Key
Header parameter name: X-EEZEE-API-KEY

Enterprise

Every organisation on eezee is represented by an Enterprise object. An enterprise can be both a seller and a buyer.

Create an enterprise

Create an enterprise

Authorizations:
Request Body schema: application/json
punchoutBuyerId
string (PunchoutBuyerId)

The uid of the buyer as identified on your platform

punchoutSellerId
string (PunchoutSellerId)

The uid of the seller as identified on your platform.

punchoutNetworkId
string (PunchoutNetworkId)

The user network id. Usually a support email.

punchoutApplication
string (PunchoutApplication)

The short name of your application.

logoUrl
required
string
companyName
required
string
shortName
required
string
domainNames
Array of strings
addresses
required
Array of objects (Address)

Responses

200

Success

post/api/v1.1/enterprises
https://api.eezee.sg/api/v1.1/enterprises
https://api.eezee.dev/api/v1.1/enterprises

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "punchoutBuyerId": "507f191e810c19729de860ea",
  • "punchoutSellerId": "507f1f77bcf86cd799439011",
  • "punchoutNetworkId": "sysadmin@ariba.com",
  • "punchoutApplication": "SAP Ariba",
  • "companyName": "Merlion Bay Sands Pte Ltd",
  • "shortName": "MBS",
  • "domainNames":
    [
    ],
  • "addresses":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "enterprise":
    {
    }
}

List all enterprise

Get all enterprise your account has access rights to.

Authorizations:

Responses

200

Success

get/api/v1.1/enterprises
https://api.eezee.sg/api/v1.1/enterprises
https://api.eezee.dev/api/v1.1/enterprises

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "enterprises":
    [
    ]
}

Retrieve an enterprise

NOTE: You can't retrieve the enterprise' details if this enterprise wasn't created by your organisation.

Authorizations:
path Parameters
id
required
string
Example: 5e9927bb4bf9e33495bc2c6a

The enterprise's id (enterprise._id)

Responses

200

Success

get/api/v1.1/enterprises/{id}
https://api.eezee.sg/api/v1.1/enterprises/{id}
https://api.eezee.dev/api/v1.1/enterprises/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "enterprises":
    [
    ]
}

Delete an enterprise

Authorizations:
path Parameters
id
required
string
Example: 5e9927bb4bf9e33495bc2c6a

The enterprise's id (enterprise._id)

Responses

200

Success

delete/api/v1.1/enterprises/{id}
https://api.eezee.sg/api/v1.1/enterprises/{id}
https://api.eezee.dev/api/v1.1/enterprises/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true
}

Update list of addresses

Authorizations:
path Parameters
id
required
string
Example: 5e9927bb4bf9e33495bc2c6a

The enterprise's id (enterprise._id)

Request Body schema: application/json
Array
addressId
required
string (Should be unique)

The customer-defined id of an address

groupName
string
fullAddress
required
string
city
required
string
isoCountryCode
required
string 2 characters
postalCode
required
string 6 characters
billingOnly
boolean

Responses

200

Description

put/api/v1.1/enterprises/{id}/addresses
https://api.eezee.sg/api/v1.1/enterprises/{id}/addresses
https://api.eezee.dev/api/v1.1/enterprises/{id}/addresses

Request samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "addresses":
    [
    ]
}

User

List all users

Returns a list of users you have access to.

Authorizations:

Responses

200

The list of users

get/api/v1.1/users
https://api.eezee.sg/api/v1.1/users
https://api.eezee.dev/api/v1.1/users

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "users":
    [