Eezee Logo
Documentation Powered by ReDoc

Eezee API Documentation BETA (latest) (1.1)

Download OpenAPI specification:Download

E-mail: developers@eezee.com.sg Terms of Service

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:
apiKey
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",
  • "logoUrl": "https://storage.googleapis.com/eezee-storage/icons/enterprise.svg",
  • "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:
apiKey

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:
apiKey
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:
apiKey
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:
apiKey
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:
apiKey

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":
    [
    ]
}

Retrieve a user

Returns a user by it's id. Only returns if you have access to it.

Authorizations:
apiKey
path Parameters
id
required
string

Filter by user._id

Responses

200

The requested user

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

Response samples

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

Invoice

Create a quotation

Create a quotation with products. After a quote is created, you may confirm the quote to turn it into an invoice.

Authorizations:
apiKey
Request Body schema: application/json
enterpriseId
required
string

The enterprise's id (enterprise._id)

billingAddressId
required
string (Should be unique)

The customer-defined id of an address

shippingAddressId
required
string (Should be unique)

The customer-defined id of an address

userEmail
required
string
userName
required
string
cxmlPunchoutProductOrders
Array of objects (CxmlPunchoutProductOrder)

Either cxmlPunchoutProductOrders or productOrders are required.

productOrders
Array of objects (ProductOrder)

Either cxmlPunchoutProductOrders or productOrders are required.

Responses

200

Success

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enterpriseId": "5e9927bb4bf9e33495bc2c6a",
  • "billingAddressId": "AMK01",
  • "shippingAddressId": "AMK01",
  • "userEmail": "jasper@merlionbaysands.com",
  • "userName": "Jasper Yap",
  • "cxmlPunchoutProductOrders":
    [
    ],
  • "productOrders":
    [
    ]
}

Response samples

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

List all quotations

Retrieve details of all quotations, in page sizes of 50, in either "pdf" or "json" formats

Authorizations:
apiKey
query Parameters
page
number <= 100
Default: 1

The page number

enterpriseId
string

(optional) Input value to filter by enterprise._id

format
string
Default: "pdf"
Enum: "pdf" "json"

Desired format for quotation

Responses

200

Success (PDF or JSON)

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

Response samples

Content type
application/pdf
No sample

Retrieve a quotation

Retrieve details of a quotation in either "pdf" or "json" format

Authorizations:
apiKey
path Parameters
id
required
string
Example: 5a03bbf5b80b7b0a1af45ecc

The id of the quotation

query Parameters
format
string
Default: "pdf"
Enum: "pdf" "json"

Desired format for quotation

Responses

200

Success (PDF or JSON)

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

Response samples

Content type
application/pdf
No sample

Confirm a quotation

Converts a quotation into an invoice.

This event TRIGGERS the confirm order process.

Emails will be sent out and suppliers will despatch the items.
Eezee staff will also begin tracking the order.

Authorizations:
apiKey
path Parameters
id
required
string
Example: 5a03bbf5b80b7b0a1af45ecc

The id of the quotation

query Parameters
poRefNumber
string

(optional) PO number to be reflected in the invoice

Responses

200

Success (JSON)

put/api/v1.1/quotations/{id}/confirm
https://api.eezee.sg/api/v1.1/quotations/{id}/confirm
https://api.eezee.dev/api/v1.1/quotations/{id}/confirm

Response samples

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

List all invoices

Retrieve details of all invoices(confirmed quote), in page sizes of 50, in either "pdf" or "json" formats

Authorizations:
apiKey
query Parameters
enterpriseId
string

(optional) Input value to filter by enterprise._id

page
number <= 100
Default: 1

The page number

format
string
Default: "pdf"
Enum: "pdf" "json"

Desired format for invoice

Responses

200

Success (PDF or JSON)

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

Response samples

Content type
application/pdf
No sample

Retrieve an invoice

Retrieve details of an invoice(confirmed quote) by it's id in either "pdf" or "json" formats

Authorizations:
apiKey
path Parameters
id
required
string
Example: 5a03bbf5b80b7b0a1af45ecc

The id of the invoice

query Parameters
format
string
Default: "pdf"
Enum: "pdf" "json"

Desired format for invoice

Responses

200

Success (PDF or JSON)

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

Response samples

Content type
application/pdf
No sample

Brands

Get all brands

List all brands

Authorizations:
apiKey

Responses

200

An array of brands

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

Response samples

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

Get brand by id

Returns a single brand

Authorizations:
apiKey
path Parameters
id
required
string

The Brand's id

Responses

200

A single brand

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

Response samples

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

Categories

Get all categories

List all main categories.

For more info you may visit https://eezee.sg/categories

Authorizations:
apiKey

Responses

200

List of main categories and it's sub categories (Click to view)

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

Response samples

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

Get main category

Get a main category and it's sub categories

Authorizations:
apiKey
path Parameters
id
required
string

Main category id

Responses

200

A main category and it's sub categories

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

Response samples

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

Get sub category

Get a sub category

Authorizations:
apiKey
path Parameters
id
required
string

Main category id

subTitleUrl
required
string

Sub category titleUrl

Responses

200

A main category and it's sub categories

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Products

List all products

Returns a list of all products that you have access to

Authorizations:
apiKey
query Parameters
brandKebabCase
string

Filter by product.brand.kebabName

mainCategoryTitleUrl
string

Filter by product.categories.mainKebabCase

subCategoryTitleUrl
string

Filter by product.categories.subKebabCase

Responses

200

The list of products

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

Response samples

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

Retrieve a product

Returns a product by it's id. Only returns if you have access to it.

Authorizations:
apiKey
path Parameters
id
required
string

Filter by product._id

Responses

200

The requested product

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

Response samples

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

Chat

Chat with eezee's dedicated customer success team without the need to leave your app by starting and replying chat sessions with Eezee Chat Api.

Start a Chat

Authorizations:
apiKey
Request Body schema: application/json
subject
required
string

The subject of the thread

message
required
string

The message to be sent

responseUrl
required
string

The webhook that eezee should make the POST request when the replying party replies.

productId
string

(optional) The product._id for context purposes.

sellerId
string

(optional) The seller's user._id for context purposes.

orderId
string

(optional) The invoice's invoice._id for context purposes.

metadata
any

(optional) User generated Meta Data for context purposes.

Responses

200

Success

Callbacks

post{responseUrl} - Reply Chat Event
post/api/v1.1/chat
https://api.eezee.sg/api/v1.1/chat
https://api.eezee.dev/api/v1.1/chat

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "subject": "Loctite 243 Threadlocker 50ml",
  • "message": "Can we get a cheaper price?",
  • "responseUrl": "https://webhook.site/e1d8a451-9a4f-4d2b-8080-dfdb8ffa511c",
  • "productId": "5efa05f7f7e39b488237b51b",
  • "sellerId": "5efa0605aa6314c986fa5e07",
  • "orderId": "5efa06114119cc2e6adba659",
  • "metadata": { }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "chatId": "8e59d4cc-34ef-4ad4-a922-01bc2d347d24"
}

Callback payload samples

Callback
POST: {responseUrl} - Reply Chat Event
Content type
application/json
Copy
 Expand all Collapse all
{
  • "chatId": "8e59d4cc-34ef-4ad4-a922-01bc2d347d24",
  • "message": "This order will arrive on monday",
  • "subject": "Order Id INV-2002-200",
  • "productId": "5efa05f7f7e39b488237b51b",
  • "sellerId": "5efa0605aa6314c986fa5e07",
  • "orderId": "5efa06114119cc2e6adba659",
  • "metadata": { }
}

Reply a Chat

Authorizations:
apiKey
path Parameters
id
required
string
Example: 8e59d4cc-34ef-4ad4-a922-01bc2d347d24

The chatId you want to reply to.

Request Body schema: application/json
message
required
string

The message you wish to use to reply to eezee

Responses

200

Success

Callbacks

post{responseUrl} - Reply Chat Event
post/api/v1.1/chat/{id}
https://api.eezee.sg/api/v1.1/chat/{id}
https://api.eezee.dev/api/v1.1/chat/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "message": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "chatId": "8e59d4cc-34ef-4ad4-a922-01bc2d347d24"
}

Callback payload samples

Callback
POST: {responseUrl} - Reply Chat Event
Content type
application/json
Copy
 Expand all Collapse all
{
  • "chatId": "8e59d4cc-34ef-4ad4-a922-01bc2d347d24",
  • "message": "This order will arrive on monday",
  • "subject": "Order Id INV-2002-200",
  • "productId": "5efa05f7f7e39b488237b51b",
  • "sellerId": "5efa0605aa6314c986fa5e07",
  • "orderId": "5efa06114119cc2e6adba659",
  • "metadata": { }
}

The Enterprise Model

punchoutSharedSecret
string
punchoutLeadTime
string
punchoutApplication
string
punchoutNetworkId
string
punchoutSellerId
string
punchoutBuyerId
string
punchoutModule
boolean
enterpriseKey
string
companyName
required
string
shortName
required
string
logoUrl
required
string
creditTermDays
required
number
creditLimit
required
number
creditBalance
required
number
movFreeDelivery
required
number
_id
required
string

The enterprise's id (enterprise._id)

addresses
required
Array of objects (Address)
domainNames
Array of strings
dateCreated
required
string <date-time>
Copy
 Expand all Collapse all
{
  • "punchoutSharedSecret": "fe0d92b9-3ff8-489a-9f97-efcefbfd7c12",
  • "punchoutLeadTime": "7",
  • "punchoutApplication": "SAP Ariba",
  • "punchoutNetworkId": "sysadmin@ariba.com",
  • "punchoutSellerId": "507f1f77bcf86cd799439011",
  • "punchoutBuyerId": "507f191e810c19729de860ea",
  • "punchoutModule": true,
  • "enterpriseKey": "3qUlPQkLti1O7BBxKJS5",
  • "companyName": "Merlion Bay Sands Pte Ltd",
  • "shortName": "MBS",
  • "logoUrl": "https://storage.googleapis.com/eezee-storage/icons/enterprise.svg",
  • "creditTermDays": 30,
  • "creditLimit": 3000,
  • "creditBalance": 3000,
  • "movFreeDelivery": 200,
  • "_id": "5e9927bb4bf9e33495bc2c6a",
  • "domainNames":
    [
    ],
  • "dateCreated": "2020-04-17T03:51:23.636Z"
}

The User Model

_id
string
local
object
categoryNiche
Array of objects
brandNiche
Array of objects
details
object
shop
object
addresses
Array of objects
Copy
 Expand all Collapse all
{
  • "local":
    {
    },
  • "categoryNiche":
    [
    ],
  • "brandNiche":
    [
    ],
  • "details":
    {
    },
  • "shop":
    {},
  • "addresses":
    [
    ],
  • "_id": "5d79fd1d35c0ff50b662a0fd"
}

The Invoice Model

_id
string
documentConfig
object
documentHeader
object
documentLineItems
Array of objects
documentPriceDetails
object
Copy
 Expand all Collapse all
{
  • "_id": "5ec201e87ccafe7f403408a1",
  • "documentConfig":
    {
    },
  • "documentHeader":
    {
    },
  • "documentLineItems":
    [
    ],
  • "documentPriceDetails":
    {
    }
}

The Brand Model

_id
string

The Brand's id

name
string

The Brand's name

lowerCaseName
string

The Brand's name in lowercase

kebabName
string

The Brand's name in kebab-case

featured
boolean

Boolean flag to indicate if brand is featured on the Eezee Platform

image
object

The Image

nameTranslations
object

Holds information on the brand's name in other languages

Copy
 Expand all Collapse all
{
  • "_id": "59b24e3eb38a0b0ad30a3a00",
  • "name": "LOCTITE",
  • "lowerCaseName": "loctite",
  • "kebabName": "loctite",
  • "featured": true,
  • "image":
    {},
  • "nameTranslations":
    {
    }
}

The Main Category Model

_id
string

Main Category Unique Id

title
string

The title of this main category

titleUrl
string

The title of this main category in kebab-case format for urls

children
Array of objects (SubCategory)

The sub categories within the main category

Copy
 Expand all Collapse all
{}

The Sub Category Model

image
string

The url of the image that represents this sub category

title
string

The title of this sub category

titleUrl
string

The title of this sub category in kebab-case format for urls

googleTaxonomy
string

The googleTaxonomy that represents this sub category

unspsc
string

The unspsc that represents this sub category (For ERP systems like SAP Ariba)

Copy
 Expand all Collapse all
{}

The Product Model

_id
string
title
string
titleTranslations
object
link
string
images
Array of strings
sku
string
price
object (Price)

Price

descriptionHtml
string
descriptionHtmlTranslations
object
supplierId
string
specSheets
Array of objects
categories
object
brand
object
variants
Array of objects
bulkDiscount
Array of objects
dateUpdated
string <datetime>
Copy
 Expand all Collapse all
{
  • "_id": "5dbb92137cb19f68ffbfd4c0",
  • "title": "Molykote / Dow Corning Dc-732 Multi-purpose Sealant 305ml",
  • "titleTranslations":
    {
    },
  • "link": "https://eezee.sg/product/molykote-dow-corning-dc-732-multi-purpose-sealant-305ml-2001e541bd",
  • "images":
    [],
  • "sku": "2001e541bd",
  • "price":
    {
    },
  • "descriptionHtml": "<h3 class=\"md-block-header-three\">Molykote / Dow Corning DC-732 Multi-Purpose Sealant 305 mL</h3><p class=\"md-block-unstyled\">Dowsil 732 is a ready-to-use, one component, non-slumping silicone adhesive which can be used as a bonding and sealing agent for industrial applications. This MIL-A-46160 compliant RTV offers a cure system acetoxy, easy application, flexibility, and good dielectric properties. Dow 732 changes from a paste to a flexible, tough, form-in-place gasket and space-filling rubber adhesive. This product is available in clear. Dowsil 732 is flexible and stable from -76°F to +356°F (-60°C to +180°C), with short peaks up to 401°F (+205°C). This product has an established track record of optimum performance in assembly and maintenance applications. The black version of this product is stable and flexible from -60°C to + 205°C, with short peaks up to +230°C.</p><p class=\"md-block-unstyled\"><strong class=\"md-inline-bold\">Other calling names (also known as): Dow Corning DC-732, Dowsil DC-732</strong> </p><h3 class=\"md-block-header-three\">Features:</h3><ul class=\"md-block-unordered-list-item\"><li>RTV silicone sealant</li><li>General purpose Industrial silicone adhesive/sealant</li><li>Complies with MIL-A-46106 and FDA 177.2600</li><li>Acetic cure and hence can corrode substrates</li><li>540% Elongation &amp; hardness 25 Shore A after full curing</li></ul><h3 class=\"md-block-header-three\">Specification:</h3><ul class=\"md-block-unordered-list-item\"><li>Brand: Molykote</li><li>Product Type: Sealant</li><li>Characteristics: Paste</li><li>Cure Type: Acetoxy, RTV</li><li>Cure Time: 24 hours (At room temperature and 50% relative humidity) </li><li>Dielectric Strength: 21.6 Kilovolt/mm</li><li>Elongation: 540% </li><li>Hardness: 25 A </li><li>Service Temperature: -60 to +180°C </li><li>Specific Gravity: 1.04 @ 25°C </li><li>Tack Free Time: 20 minutes </li><li>Tensile Strength: 2.3 MPa (334 psi)</li><li>Length: 4.8 cm</li><li>Width: 4.8 cm</li><li>Height: 4 cm</li></ul><h3 class=\"md-block-header-three\">It comes in 3 different colour available</h3><ul class=\"md-block-unordered-list-item\"><li>SKU : DC-732305BK ( Black )</li><li>SKU : DC-732305CL (Clear )</li><li>SKU : DC-732305WH ( White )</li></ul>",
  • "descriptionHtmlTranslations":
    {
    },
  • "supplierId": "5d79fd1d35c0ff50b662a0fd",
  • "specSheets":
    [],
  • "categories":
    {
    },
  • "brand":
    {
    },
  • "variants":
    [
    ],
  • "bulkDiscount":
    [
    ],
  • "dateUpdated": "2020-03-17T09:47:50.637Z"
}

The Chat Model

chatId
required
string

A UUID to identify a session. Required when replying to a Chat.

message
required
string

The chat's message / content

subject
required
string

The subject of the chat

productId
string

(optional) The product._id for context purposes.

sellerId
string

(optional) The seller's user._id for context purposes.

orderId
string

(optional) The invoice's invoice._id for context purposes.

metadata
any

(optional) User generated Meta Data for context purposes.

Copy
 Expand all Collapse all
{
  • "chatId": "8e59d4cc-34ef-4ad4-a922-01bc2d347d24",
  • "message": "This order will arrive on monday",
  • "subject": "Order Id INV-2002-200",
  • "productId": "5efa05f7f7e39b488237b51b",
  • "sellerId": "5efa0605aa6314c986fa5e07",
  • "orderId": "5efa06114119cc2e6adba659",
  • "metadata": { }
}