Introduction

Welcome to the MESPAS Supplier API Reference. The MESPAS Supplier API is a restful API (Application Programming Interface) suitable for (marine) supplier companies. You can use the MESPAS Supplier API to integrate your existing ERP (enterprise resource planning) system with the MESPAS Supply Chain platform.

The MESPAS Supply Chain Management (SCM) platform is a procurement platform for the marine industry. It facilitates the procurement process and connects the marine suppliers with the marine buyers.

The MESPAS Supplier API enables you to:

  • Receive the buyers quote requests electronically

  • Receive the buyers orders electronically

  • Send your quotes related to the received quote requests

  • Integrate the message flow into your existing ERP system

Getting Started

You are a marine supplier receiving quote requests and orders via the MESPAS SCM platform? You want to integrate the procurement message flow into your existing ERP system? In that case, you should contact us at info@mespas.com.

Authentication

The API uses OAuth 2.0 for authentication. A valid API token specific to your company is required and must be provided as HTTP header to each request (see example shown below). Please contact info@mespas.com in order to acquire an API token for your company.

$ curl 'https://api.mespas.com/api/rest/supplier/v1/requests/11c78e43f82b4da0ba7cd37d13ea3242' -i \
    -H 'Authorization: Bearer -- your authentication tokens comes here --' \
    -H 'Accept: application/json'

API Endpoint

All API calls must be made to https://api.mespas.com

We also have a sandbox environment for testing available at https://mw-uat.mespas.com/ms.

Attention The sandbox environment is not always up and running. Please contact us at info@mespas.com when you want to use the sandbox environment.

Data Format

All responses and all request bodies will be in JSON.

Date Format

Dates are represented in the format 'yyyy-MM-dd' (e.g. 2017-09-14 for the 14th September 2017)

Errors

Each API call returns an HTTP status code that reflects the nature of the response.

Any request that succeeds will return with HTTP status 200.

Any request that did not succeed will return a 4xx or 5xx error. The 4xx range means there was a problem with the request, like a missing parameter. The 5xx range means that something went wrong on our end.

The MESPAS Supplier API returns the following HTTP status codes:

  • 200 OK – Request succeeded

  • 400 Bad Request – Invalid request body (e.g. invalid unit code, too long values, …​)

  • 401 Unauthorized – Incorrect or missing API key

  • 403 Forbidden – You do not have permission to view a resource or perform an action

  • 412 Precondition Failed - The action cannot be executed as a precondition is not met (e.g. when you want to reject a request that was already rejected)

  • 500 Internal Server Error – There was a problem on our end

If the returned status code is 400 (Bad Request) or 412 (Precondition Failed), the response body contains additional information about the cause of the problem. The error structure looks as follows:

{
  "status" : "ERROR",
  "code" : "INVALID_INPUT",
  "message" : "Invalid offer currency (ABC)",
  "data" : [ ]
}

Versioning

Any future changes to the API will be versioned in order to maintain backwards compatibility with existing integrations. The most current version of the API is version v1.

Pagination

All list operations will be paginated (e.g. getting all requests, orders) in order to reduce the number of results to return. A paged result contains up to 20 elements by default.

Example

Let’s assume that you want to get all the requests for your company. How can you do that?

GET the first page

You can request the first page by simply calling

GET /api/rest/supplier/v1/requests

or

GET /api/rest/supplier/v1/requests?page=0

As a result you get

{
  "data" : [
  	{
  		// first request data (not shown here)
  	}, {
    	// second request data (not shown here)
    }

    // third, fourth,,, request data (not shown here)

   ],
  "page" : 0,
  "totalPages" : 12,
  "pageSize" : 20
}

The result represents the first page, which contains the data of the first 20 (pageSize) requests.

page

The current page [0..totalPages]

totalPages

The total number of pages available

pageSize

The number of records per page

data

The array of the data you have requested (e.g. array of request data)

GET the next page(s)

In order to retrieve the next page (the next results), you have to increase the page parameter by one.

GET /api/rest/supplier/v1/requests?page=1

If you want to retrieve all the records, you have to consecutively increase the page parameter by one up to the total number of pages (totalPages).

Buyer Events / Polling

The illustration shown below represents the main purchasing message flow - from RFQ to Offer to Order.

It is important to distinguish between the actions initiated by the buyer side (purple numbers) and the actions initiated by you as a supplier (black numbers).

purchase message flow

The buyer actions are concerned with the Events API mechanism. Each buyer action which is relevant for you as a supplier leads to a new event (e.g. a new request, a new order, a cancelled request,…​). In order to receive those events, you have to call the Events method on a regular base (e.g. every 5 minutes). Provide the id of the last consumed event to the call (Events) and you will receive only those events which you have not processed so far.

Example

Let’s assume that the last event id that you have processed successfully is 356.

GET new events

You can get all the events you have not processed so far by calling

GET /api/rest/supplier/v1/events?last_received=356

As a result you get all the events that are newer than the event provided by the last_received parameter. If the result is empty, nothing needs to be done, as there no messages/events to consume.

If the result looks like the example shown below, it indicates that you have received two requests and one order in the meantime. Call Request for each of the two requests in order to get the corresponding details respectively Order to get the details of the order.

[ {
  "eventId" : 357,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "11c78e43f82b4da0ba7cd37d13ea3242"
}, {
  "eventId" : 358,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff8080815e956f16015e95746fff000d"
}, {
  "eventId" : 359,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "4f9f5e4b0f4d47e48951c69b0660c42b"
}
]

After having processed the data successfully, you may call the event api with the parameter 359 next time.

GET /api/rest/supplier/v1/events?last_received=359

Enum Values

Incoterms

The following incoterms are supported by MESPAS

Code Description

CIP

Carriage and Insurance Paid

CFR

Cost and Freight

CIF

Cost, Insurance and Freight

CPT

Carriage Paid

DAF

Delivered at Frontier

DAP

Delivered at Place

DAT

Delivered at Terminal

DDP

Delivered Duty Paid

DDU

Delivered Duty Unpaid

DEQ

Delivered Ex Quay

DES

Delivered Ex Ship

EXW

Ex Works

FAS

Free Alongside Ship

FCA

Free Carrier

FOB

Free on Board

NA

Not available (incoterm not defined)

Country Codes

Alpha-2-code of country according to http://en.wikipedia.org/wiki/ISO_3166-1

Currencies

Currency code according to https://en.wikipedia.org/wiki/ISO_4217. MESPAS supports the following subset of currencies:

Currency Description

AED

United Arab Emirates dirham

AFN

Afghan afghani

ARS

Argentine peso

AUD

Australian dollar

AZN

Azerbaijani manat

BHD

Bahraini dinar

BRL

Brazilian real

CAD

Canadian dollar

CHF

Swiss franc

CLP

Chilean peso

CNY

Chinese yuan

CRC

Costa Rican colon

CZK

Czech koruna

DKK

Danish krone

EGP

Egyptian pound

EUR

Euro

GBP

Pound sterling

GHS

Ghanaian cedi

HKD

Hong Kong dollar

HRK

Croatian kuna

IDR

Indonesian rupiah

ILS

Israeli new shekel

INR

Indian rupee

IRR

Iranian rial

JPY

Japanese yen

KRW

South Korean won

KWD

Kuwaiti dinar

KYD

Cayman Islands dollar

MAD

Moroccan dirham

MMK

Myanma kyat

MUR

Mauritian rupee

MXN

Mexican peso

MYR

Malaysian ringgit

NAD

Namibian dollar

NGN

Nigerian naira

NOK

Norwegian krone

NPR

Nepalese rupee

NZD

New Zealand dollar

RUB

Russian rouble

PAB

Panamanian balboa

PHP

Philippine peso

PLN

Polish złoty

QAR

Qatari riyal

RSD

Serbian dinar

SAR

Saudi riyal

SEK

Swedish krona/kronor

SGD

Singapore dollar

THB

Thai baht

TMT

Turkmenistani manat

TRY

Turkish lira

TTD

Trinidad and Tobago dollar

TWD

New Taiwan dollar

UAH

Ukrainian hryvnia

USD

United States dollar

VEF

Venezuelan bolívar fuerte

ZAR

South African rand

ZMW

Zambian kwacha

XAF

Central African CFA franc

XOF

West African CFA franc

XPF

Comptoirs Français du Pacifique CFP franc

Units

Unit codes supported by MESPAS

Unit Description

AMPULE

Ampule

BAG

Bag

BOTTLE

Bottle

BOX

Box

CAN

Can

CARTON

Carton

CASE

Case

CENTIMETER

Centimeter

CUBIC_METER

Cubic meter

DAY

Day

DECILITER

Deciliter

DOZEN

Dozen

DRUM

Drum

FEET

Feet

GRAM

Gram

GROSS

Gross

HECTOLITER

Hectoliter

HOUR

Hour

IMPERIAL_GALLON

Imperial gallon

IMPERIAL_PINT

Imperial pint

IMPERIAL_QUART

Imperial quart

JAR

Jar

KEG

Keg

KILOGRAM

Kilogram

LITER

Liter

LOAVE

Loave

METER

Meter

METRIC_CUP

Metric Cup

METRIC_TON

Metric ton

MILLILITER

Milliliter

MILLIMETER

Millimeter

OUNCE

Ounce

OIL_BARREL

Oil barrel

PACK

Pack

PAIL

Pail

PAIR

Pair

PIECE

Piece

POT

Pot

POUND

Pound

REAM

Ream

ROLL

Roll

SACHET

Sachet

SET

Set

SHEET

Sheet

SQUARE_METER

Square meter

TIN

Tin

TON

Ton

US_LIQUID_GALLON

US liquid gallon

Priorities

Used to determine the priority of a quote request, offer or order.

Priority Description

LOW

Indicates a low priority.

MEDIUM

Indicates the default priority.

HIGH

Indicates a high priority.

Qualities

Used to determine the quality of a request item, offer item or order item

Quality Description

HIGH

The best quality.

MEDIUM

The medium quality.

LOW

The lowest quality.

Event Types

The following event types are used in conjunction with the Events API.

Event Type Description

REQUEST_CREATED

Indicates that a new request was created.

REQUEST_CANCELLED

Indicates that an existing request has been cancelled.

ORDER_CREATED

Indicates that a new order was created.

ORDER_UPDATED

Indicates that an existing order has been updated.

ORDER_CANCELLED

Indicates that an existing order has been cancelled.

Entity Types

The following entity types are used in conjunction with the Events API.

Entity Type Description

QUOTE_REQUEST

The corresponding event relates to a quote request. Use the Request API in order to get the according quote request.

OFFER

The corresponding event relates to an offer. Use the Offer API in order to get the according offer.

ORDER

The corresponding event relates to an order Use the Order API in order to get the according order.

Request Status

Determines the state of a quote request

State Description

NEW

A new request. No quote has been sent so far.

QUOTED

A quote has been sent for the request.

REJECTED

The request has been rejected by the supplier

CANCELLED

The request has been cancelled by the buyer

Offer Status

Determines the state of an offer

Status Description

SENT

Offer has been sent.

REPLACED

Offer has been replaced by another offer.

CLOSED

Order closed for this offer.

Order Status

Determines the state of an order

State Description

NEW

A new order. No consecutive action (reject / confirm) has taken place so far.

REJECTED

The order has been rejected by the supplier.

CONFIRMED

The order has been confirmed by the supplier

CANCELLED

The order has been cancelled by the buyer

Reference Types

A qualifier that determines whether an entity (e.g. component, product, company,..) is a reference or not. If an entity is a reference, the type will be MESPAS. In such a case, the same entity (e.g. the same buyer company) will always have the same unique identifier (id attribute). This may be especially useful if you want to create mappings or statistics on your side.

Reference Type Description

MESPAS

The entity (component, product, company,..) is a reference. The same entity (e.g. same product) will always have the same unique identifier.

OTHER

The entity (component, product, company,..) is not a reference.

Action Status

Indicates whether an action (e.g. send offer) was processed successfully or not

State Description

SUCCESS

The corresponding action was processed successfully.

ERROR

The processing of the corresponding action failed.

Action Code

Code Description

SUCCESS

The action code in case of success (corresponding action status is SUCCESS)

PRECONDITION_FAILED

Indicates that the corresponding action failed due to a violated precondition (e.g. offering for a request that is in status CANCELLED).

INVALID_INPUT

The input data provided is not valid (e.g. invalid unit)

INTERNAL_ERROR

An internal server error occurred. You may try at a later point in time.

Requests

Get Quote Request

A GET request will return the quote request identified by the given id.

Http Request

GET /api/rest/supplier/v1/requests/11c78e43f82b4da0ba7cd37d13ea3242 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com

Http Request Body

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 4734

{
  "id" : "11c78e43f82b4da0ba7cd37d13ea3242",
  "status" : "NEW",
  "priority" : null,
  "requestTerms" : {
    "referenceNumber" : "V-12-TESTREF-56-D/03",
    "currency" : "USD",
    "requestDate" : "2017-07-10",
    "replyUntil" : "2017-07-10",
    "paymentTerms" : "30 days net",
    "remark" : "VESSEL IS IN FOREIGN TRADE WITHOUT V.A.T",
    "restrictedUnits" : [ ]
  },
  "deliveryTerms" : {
    "deliveryDate" : null,
    "deliveryDateRemark" : "30 DAYS",
    "incoterm" : "CIP",
    "deliveryCountry" : "SG",
    "deliveryCity" : "Singapore"
  },
  "deliveryDetails" : {
    "company" : {
      "type" : "OTHER",
      "id" : null,
      "name" : "Kuehne + Nagel",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "street1" : "Feldeggstrasse 5",
        "street2" : "",
        "postbox" : "",
        "state" : "zh",
        "zip" : "8152",
        "city" : "Glattbrugg",
        "country" : "CH"
      },
      "telco" : {
        "phone" : "+41-44-8668100",
        "mobile" : null,
        "fax" : "+41-44-8668109"
      }
    },
    "contact" : null,
    "recipient" : "John Meyer",
    "recipientPhone" : "+41 44 271 0320",
    "remark" : "Warehouse at pier 7"
  },
  "vessel" : {
    "name" : "ULTIMATE FREEDOM",
    "imo" : "93740274"
  },
  "buyer" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "8b33b4f2042c4aac901e1e866d64b0b5",
      "name" : "Buyer Inc",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "street1" : "Heinrichstrasse 213",
        "street2" : "",
        "postbox" : "",
        "state" : "ZH",
        "zip" : "8005",
        "city" : "Zurich",
        "country" : "CH"
      },
      "telco" : {
        "phone" : "+41 44 444 55 55",
        "mobile" : null,
        "fax" : "+41 44 444 55 56"
      }
    },
    "contact" : {
      "firstName" : "Walter",
      "lastName" : "Schmid",
      "email" : "walter.schmid@mail.mail",
      "telco" : {
        "phone" : "",
        "mobile" : "+41177953624",
        "fax" : ""
      }
    }
  },
  "product" : {
    "type" : "MESPAS",
    "id" : "f9ab4eadaf0452592169c265cb831d9",
    "name" : "RT-flex96C",
    "execution" : "",
    "specification" : null,
    "productInstance" : {
      "type" : "MESPAS",
      "id" : "1133b4f2042c4aac901e1e866d64b0b1",
      "serialNumber" : "1235",
      "buildingYear" : "2014",
      "label" : "Auxiliary Engine #2",
      "builder" : {
        "name" : "H. Cegielski-Poznan S.A."
      }
    },
    "brand" : {
      "name" : "Wärtsilä"
    },
    "specificationDetails" : [ {
      "name" : "Part No.",
      "value" : "2722/A104"
    }, {
      "name" : "Sector No.",
      "value" : "23.32242.323"
    }, {
      "name" : "Section Name",
      "value" : "Compressor"
    }, {
      "name" : "Material",
      "value" : "Carbon"
    }, {
      "name" : "Sheet No.",
      "value" : "2701-32sd"
    } ]
  },
  "attachments" : [ {
    "fileId" : "201d718eaaa542808c7d84fe3a240ef0",
    "fileName" : "conditions.txt",
    "size" : "0.0240",
    "mimeType" : "text/plain"
  } ],
  "items" : [ {
    "position" : "1",
    "quality" : null,
    "remark" : "Please offer only best quality",
    "quantity" : "8.000",
    "unit" : "PIECE",
    "component" : {
      "type" : "MESPAS",
      "id" : "2305e133764111e4988e002219ba5b31",
      "name" : "gasket",
      "execution" : "35mm",
      "brand" : {
        "name" : "Sulzer"
      },
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Sector No.",
        "value" : "23.32242.323"
      }, {
        "name" : "Section Name",
        "value" : "Compressor"
      }, {
        "name" : "Material",
        "value" : "Carbon"
      }, {
        "name" : "Sheet No.",
        "value" : "2701-32sd"
      } ]
    }
  }, {
    "position" : "2",
    "quality" : null,
    "remark" : "Same as last time requested",
    "quantity" : "5.000",
    "unit" : "PIECE",
    "component" : {
      "type" : "MESPAS",
      "id" : "23067a8f764111e4988e002219ba5b31",
      "name" : "Seal repair kit for Cylinder Head Hydraulic Jack Type W27.002",
      "execution" : "round",
      "brand" : {
        "name" : "Sulzer"
      },
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Sector No.",
        "value" : "23.32242.323"
      }, {
        "name" : "Section Name",
        "value" : "Compressor"
      }, {
        "name" : "Material",
        "value" : "Carbon"
      }, {
        "name" : "Sheet No.",
        "value" : "2701-32sd"
      } ]
    }
  } ]
}

Http Response Fields

Path Type Description

vessel

Object

The vessel associated with the request

id

String

Unique identifier of the request

status

String

The request status. See Enum Values (Request Status)

priority

Null

The priority of the request. See Enum Values (Priorities)

requestTerms.referenceNumber

String

The request’s reference number (mandatory)

requestTerms.currency

String

Currency (mandatory). See Enum Values (Currencies)

requestTerms.requestDate

String

The date when the request was sent by the buyer (mandatory)

requestTerms.replyUntil

String

The date when the supplier’s reply is expected (optional)

requestTerms.paymentTerms

String

The buyer’s payment terms (optional)

requestTerms.remark

String

The remark associated with the request (optional)

requestTerms.restrictedUnits

Array

Restricts the units that may be used for quoting. If the list is empty, all units (according to Enum Values (Units)) may be assigned to the offer items of your quote.

deliveryTerms.deliveryDate

Null

The delivery date (optional). Format: YYYY-MM-DD

deliveryTerms.deliveryDateRemark

String

The delivery date remark (optional). Max. 100 characters.

deliveryTerms.incoterm

String

Incoterm (optional). NA is applied if no value is specified. See Enum Values (Incoterms)

deliveryTerms.deliveryCountry

String

Delivery country code (optional). See Enum Values (Countries)

deliveryTerms.deliveryCity

String

Delivery city (optional). Max. 100 characters.

deliveryDetails.recipient

String

The name of the recipient (person in charge). (optional)

deliveryDetails.recipientPhone

String

The phone number of hte recipient (person in charge). (optional)

deliveryDetails.remark

String

Delivery address remark (optional)

deliveryDetails.company

Object

The company

deliveryDetails.company.id

Null

Unique identifier for the company. Only present if type is MESPAS

deliveryDetails.company.type

String

The type of entity. See Enum Values (Reference Types)

deliveryDetails.company.name

String

The name of the company

deliveryDetails.company.web

Null

The website of the company (optional)

deliveryDetails.company.vatNumber

Null

The VAT number of the company (optional)

deliveryDetails.company.vatText

Null

Additional information to the VAT number of the company (optional)

deliveryDetails.company.eoriNumber

Null

EORI number of the company (optional)

deliveryDetails.company.address

Object

Company’s address details

deliveryDetails.company.address.street1

String

Street (optional)

deliveryDetails.company.address.street2

String

Street addition (optional)

deliveryDetails.company.address.postbox

String

P.O. Box (optional)

deliveryDetails.company.address.state

String

State (optional)

deliveryDetails.company.address.zip

String

ZIP code (optional)

deliveryDetails.company.address.city

String

City (optional)

deliveryDetails.company.address.country

String

Country code (optional). See Enum Values (Countries)

deliveryDetails.company.telco

Object

Company’s telecommunication details

deliveryDetails.company.telco.phone

String

Company’s phone number (optional)

deliveryDetails.company.telco.mobile

Null

Company’s mobile number (optional)

deliveryDetails.company.telco.fax

String

Company’s fax number (optional)

deliveryDetails.contact

Null

Not present (null) - Contact (person in charge) details are available in the fields recipient, recipientPhone and remark

vessel.imo

String

IMO number (International Maritime Organization)

vessel.name

String

The name of the vessel

buyer.company

Object

The company

buyer.company.id

String

Unique identifier for the company. Only present if type is MESPAS

buyer.company.type

String

The type of entity. See Enum Values (Reference Types)

buyer.company.name

String

The name of the company

buyer.company.web

Null

The website of the company (optional)

buyer.company.vatNumber

Null

The VAT number of the company (optional)

buyer.company.vatText

Null

Additional information to the VAT number of the company (optional)

buyer.company.eoriNumber

Null

EORI number of the company (optional)

buyer.company.address

Object

Company’s address details

buyer.company.address.street1

String

Street (optional)

buyer.company.address.street2

String

Street addition (optional)

buyer.company.address.postbox

String

P.O. Box (optional)

buyer.company.address.state

String

State (optional)

buyer.company.address.zip

String

ZIP code (optional)

buyer.company.address.city

String

City (optional)

buyer.company.address.country

String

Country code (optional). See Enum Values (Countries)

buyer.company.telco

Object

Company’s telecommunication details

buyer.company.telco.phone

String

Company’s phone number (optional)

buyer.company.telco.mobile

Null

Company’s mobile number (optional)

buyer.company.telco.fax

String

Company’s fax number (optional)

buyer.contact

Object

The associated contact - may be null

buyer.contact.firstName

String

The first name of the contact person

buyer.contact.lastName

String

The last name of the contact person

buyer.contact.email

String

Email address - may be empty

buyer.contact.telco.phone

String

Phone number (optional)

buyer.contact.telco.mobile

String

Mobile number (optional)

buyer.contact.telco.fax

String

Fax number (optional)

product.id

String

Unique identifier for the product. Only present if type is MESPAS

product.type

String

The type of entity. See Enum Values (Reference Types)

product.name

String

The name of the product

product.execution

String

Execution of the product (optional)

product.specification

Null

Addional specification (optional)

product.productInstance

Object

The product instance details (optional)

product.productInstance.type

String

The type of entity. See Enum Values (Reference Types)

product.productInstance.id

String

Unique identifier of the product instance. Only present if type is MESPAS

product.productInstance.serialNumber

String

The serial number

product.productInstance.label

String

An additional label (optional)

product.productInstance.buildingYear

String

The year the product instance was built (optional)

product.productInstance.builder

Object

Details about the builder (optional)

product.productInstance.builder.name

String

Company’s phone number (mandatory)

product.brand

Object

The product’s brand details

product.brand.name

String

The product’s brand name

product.specificationDetails[]

Array

Additional specification details (optional)

product.specificationDetails[].name

String

Name (mandatory)

product.specificationDetails[].value

String

Value (optional)

items[].position

String

The line item number. The same line item number must be used for quoting. (mandatory)

items[].quality

Null

The requested quality (optional). See Enum Values (Qualities)

items[].remark

String

The line item remark (optional)

items[].quantity

String

The requested quantity (max 3 digites) (mandatory)

items[].unit

String

The requested unit (mandatory). See Enum Values (Units)

items[].component

Object

The requested component (mandatory)

items[].component.type

String

The type of entity. See Enum Values (Reference Types)

items[].component.id

String

Unique identifier of the component. Only present if type is MESPAS

items[].component.name

String

The component’s name

items[].component.execution

String

The component’s execution

items[].component.brand

Object

Brand details

items[].component.brand.name

String

Brand name

items[].component.specificationDetails

Array

Additional specification details (optional)

items[].component.specificationDetails[].name

String

Name (mandatory)

items[].component.specificationDetails[].value

String

Value (optional)

attachments[].fileId

String

The unique id of the attachment. This id is used in order to download the according file (see Get Attachment)

attachments[].fileName

String

The file name of the attachment

attachments[].mimeType

String

The file’s MIME type (application/octet-stream in case of files attached to requests and orders)

attachments[].size

String

The attachment’s size in [kb]

Get Quote Requests (Multiple)

Returns multiple quote requests. The quote request information hereby comprehends the id, reference number, status, request date and the buyer details. If you want to retrieve more details for a specific request, you have to call Request.

Http Request

GET /api/rest/supplier/v1/requests?page=0&after=2017-07-09&before=2017-07-11 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

before

Optional request parameter allowing to search for requests which were received before the specified date. The date format to use is yyyy-MM-dd (e.g. 2017-07-28)

after

Optional request parameter allowing to search for requests which were received after the specified date. The date format to use is yyyy-MM-dd (e.g. 2017-07-28).

Http Request Body

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 840

{
  "data" : [ {
    "id" : "11c78e43f82b4da0ba7cd37d13ea3242",
    "referenceNumber" : "V-12-TESTREF-56-D/03",
    "status" : "NEW",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "8b33b4f2042c4aac901e1e866d64b0b5",
        "name" : "Buyer Inc",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "street1" : null,
          "street2" : null,
          "postbox" : null,
          "state" : null,
          "zip" : null,
          "city" : null,
          "country" : null
        },
        "telco" : {
          "phone" : null,
          "mobile" : null,
          "fax" : null
        }
      },
      "contact" : null
    },
    "requestDate" : "2017-07-10"
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 20
}

Http Response Fields

Path Type Description

data.[].

Array

The list of requests

data.[].id

String

Unique identifier of the request

data.[].referenceNumber

String

The request’s reference number (mandatory)

data.[].requestDate

String

The date when the request was sent by the buyer (mandatory)

data.[].status

String

The request status. See Enum Values (Request Status)

data.[].buyer.company

Object

The buyer company

data.[].buyer.company.id

String

Unique identifier for the buyer company. Only present if type is MESPAS

data.[].buyer.company.type

String

The type of entity. See Enum Values (Reference Types)

data.[].buyer.company.name

String

The name of the buyer company

data.[].buyer.contact

Null

Not present (null)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Reject Request

Allows you to reject a request, in case you are not interested in quoting.

Http Request

POST /api/rest/supplier/v1/requests/ff808081645a3ce201645ad5da85027d/reject HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com
Content-Length: 35

{ "remark": "Not willing to quote"}

Http Request Parameter

None

Http Request Body

{ "remark": "Not willing to quote"}

Http Request Fields

Path Type Description

remark

String

The reason for rejecting the request (optional). Max size 2048.

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 84

{
  "status" : "SUCCESS",
  "code" : "SUCCESS",
  "message" : null,
  "data" : [ ]
}

Http Response Fields

Path Type Description

status

String

Status of the action. See Enum Values (Action Status)

code

String

Additional status code (error code in case of failure). See Enum Values (Action Code)

message

Null

A description of the error that occured (optional). Only present in case of an error

data

Array

Empty array (not used)

Offers

Get Offer (Single)

A GET offer will return an offer identified by the given id.

Http Request

GET /api/rest/supplier/v1/offers/ff808081645a3ce201645ad5bd2b025c HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com

Http Request Body

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 4234

{
  "offerTerms" : {
    "referenceNumber" : "c3d4a8f6-a44b-4bfb-96be-12f9e2b780f4",
    "currency" : "USD",
    "validUntil" : "2018-07-16",
    "paymentTerms" : "only cash",
    "remark" : "remark to offer terms"
  },
  "deliveryTerms" : {
    "deliveryDate" : null,
    "deliveryDateRemark" : "one week",
    "incoterm" : "CFR",
    "deliveryCountry" : "NO",
    "deliveryCity" : "Kirkeness"
  },
  "id" : "ff808081645a3ce201645ad5bd2b025c",
  "priority" : null,
  "offerStatus" : "SENT",
  "offerDate" : "2018-07-02",
  "buyer" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
      "name" : "TBSC GmbH & Co KG",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "street1" : "Brumby House, 1st Floor, OF1-03",
        "street2" : "Jalan Bahasa",
        "postbox" : "80148",
        "state" : null,
        "zip" : "87011",
        "city" : "Labuan",
        "country" : "MY"
      },
      "telco" : {
        "phone" : null,
        "mobile" : null,
        "fax" : null
      }
    },
    "contact" : {
      "firstName" : "Thomas",
      "lastName" : "Muster",
      "email" : "info@mespas.com",
      "telco" : {
        "phone" : "+41 44 271 0320",
        "mobile" : null,
        "fax" : null
      }
    }
  },
  "product" : {
    "type" : "MESPAS",
    "id" : "fd58bbe5f86041099660167b87dfe1c6",
    "name" : "S20H",
    "execution" : "",
    "specification" : null,
    "productInstance" : {
      "type" : "MESPAS",
      "id" : "1133b4f2042c4aac901e1e866d64b0b0",
      "serialNumber" : "5150",
      "buildingYear" : "2014",
      "label" : "Auxiliary Engine#1",
      "builder" : {
        "name" : "H. Cegielski-Poznan S.A."
      }
    },
    "brand" : {
      "name" : "Sulzer"
    },
    "specificationDetails" : [ {
      "name" : "Warranty Alarm [days]",
      "value" : null
    }, {
      "name" : "Location",
      "value" : null
    }, {
      "name" : "MCR [kW]",
      "value" : null
    }, {
      "name" : "Remark 1",
      "value" : null
    }, {
      "name" : "Rotation Direction",
      "value" : "755"
    }, {
      "name" : "Engine Execution",
      "value" : "1 CWF"
    }, {
      "name" : "Yard Tag Number",
      "value" : null
    }, {
      "name" : "Operating System",
      "value" : null
    }, {
      "name" : "No. of Cylinders",
      "value" : "8"
    }, {
      "name" : "Warranty Exp. Date",
      "value" : null
    }, {
      "name" : "Speed CMCR [rpm]",
      "value" : "1000"
    }, {
      "name" : "CMCR [kW]",
      "value" : "1080"
    }, {
      "name" : "Fuel Oil Type",
      "value" : null
    } ]
  },
  "vessel" : {
    "name" : "Celebrity Eclipse (MS A2)",
    "imo" : "75354355"
  },
  "request" : {
    "id" : "ff808081645a3ce201645ad5ba730255",
    "reference" : "REQ-2018-963239"
  },
  "pricings" : {
    "discount" : "10.00",
    "transportCost" : "2000.0000",
    "insuranceCost" : "1000.0000",
    "packagingCost" : "3000.0000",
    "otherCost" : null,
    "vat" : "8.0000",
    "total" : "6625.8000"
  },
  "attachments" : [ {
    "fileId" : "ff808081644b2a6b01645ad5bbf80045",
    "fileName" : "company-policy.txt",
    "size" : "0.0510",
    "mimeType" : "plain/text"
  }, {
    "fileId" : "ff808081644b2a6b01645ad5bc290046",
    "fileName" : "appendix.txt",
    "size" : "0.0160",
    "mimeType" : "plain/text"
  } ],
  "items" : [ {
    "quality" : "HIGH",
    "position" : "1",
    "remark" : "Best quality requested",
    "quantity" : "2.000",
    "unit" : "PIECE",
    "discount" : "50.00",
    "pricePerUnit" : "150.0000",
    "unitConversionRate" : "1.00",
    "component" : {
      "type" : "MESPAS",
      "id" : "dda2d0f42036444a9494d680c50e9329",
      "name" : "TYPE: S 967 SERIAL NO.:4226402/2013 440V 60HZ RECOMMENDED MOTOR POWER 21KW MAKER: ALFA LAVAL (JIANG ",
      "execution" : "2234121 40/DWG.NO.2052N",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "C23-2325"
      }, {
        "name" : "Section No.",
        "value" : "19-628-3823"
      }, {
        "name" : "Section Name",
        "value" : "Hydraulic Jack Type 23.00 - 5"
      } ]
    }
  } ]
}

Http Response Fields

Path Type Description

request.reference

String

The buyer’s reference number (as provided in the corresponding request)

request.id

String

The request id that the offer relates to (mandatory). 32 characters uuid.

offerTerms.referenceNumber

String

Reference number (optional). Max. 50 characters.

offerTerms.currency

String

Currency (mandatory). See Enum Values (Currencies)

offerTerms.validUntil

String

Offer’s valid until date (optional). Date format 'yyyy-mm-dd' (e.g. 2017-10-28)

offerTerms.paymentTerms

String

Your payment terms (optional). Max. 50 characters.

offerTerms.remark

String

General offer remark (optional). Unlimited number of characters.

deliveryTerms.deliveryDate

Null

The delivery date (optional). Format: YYYY-MM-DD

deliveryTerms.deliveryDateRemark

String

The delivery date remark (optional). Max. 100 characters.

deliveryTerms.incoterm

String

Incoterm (optional). NA is applied if no value is specified. See Enum Values (Incoterms)

deliveryTerms.deliveryCountry

String

Delivery country code (optional). See Enum Values (Countries)

deliveryTerms.deliveryCity

String

Delivery city (optional). Max. 100 characters.

pricings.total

String

Total amount

pricings.discount

String

Discount expressed as a percentage (optional). Decimal value. Value range [0..100]

pricings.transportCost

String

The amount of transport costs (optional). Decimal value.

pricings.insuranceCost

String

The amount of insurance costs (optional). Decimal value.

pricings.packagingCost

String

The amount of packaging costs (optional). Decimal value.

pricings.otherCost

Null

The amount of other costs (optional). Decimal value.

pricings.vat

String

VAT (tax) expressed as a percentage (optional). Decimal value.

items[].position

String

Line item number (mandatory). Incremental number, starting with 1 (the first offer item has line item number 1, the second offer item has line item number 2, aso). The offer must include the same number of offer items than the according request has request items.

items[].quality

String

The quality of the item (optional). See Enum Values (Qualities)

items[].remark

String

The line item remark (optional). Unlimited number of characters.

items[].quantity

String

Item quantity (max 3 digits after the decimal place) (mandatory)

items[].unit

String

Unit (mandatory). See Enum Values (Units)

items[].discount

String

Discount in percent (optional). Decimal value. Value range [0..100]

items[].pricePerUnit

String

The item price on unit level (max 4 digits after the decimal place) (mandatory).

items[].unitConversionRate

String

The unit conversion must be present when the offer item unit differs from the unit of the according request item. Example: request item unit is 'piece', according offer item unit is 'set'. The unit conversion rate determines the conversion factor. E.g. 100 in order to express that a set contains 100 pieces.

items[].component

Object

The requested component (mandatory)

items[].component.type

String

The type of entity. See Enum Values (Reference Types)

items[].component.id

String

Unique identifier of the component. Only present if type is MESPAS

items[].component.name

String

The component’s name

items[].component.execution

String

The component’s execution

items[].component.brand

Null

Brand details

items[].component.brand.name

String

Brand name

items[].component.specificationDetails

Array

Additional specification details (optional)

items[].component.specificationDetails[].name

String

Name (mandatory)

items[].component.specificationDetails[].value

String

Value (optional)

attachments[].fileId

String

The unique id of the attachment. This id is used in order to download the according file (see Get Attachment)

attachments[].fileName

String

The file name of the attachment

attachments[].mimeType

String

The file’s MIME type (application/octet-stream in case of files attached to requests and orders)

attachments[].size

String

The attachment’s size in [kb]

id

String

Unique identifier of the offer

priority

Null

The priority of the offer. See Enum Values (Priorities).

offerStatus

String

The offer status. See Enum Values (Offer Status).

offerDate

String

The date when the offer was sent

buyer.company

Object

The company

buyer.company.id

String

Unique identifier for the company. Only present if type is MESPAS

buyer.company.type

String

The type of entity. See Enum Values (Reference Types)

buyer.company.name

String

The name of the company

buyer.company.web

Null

The website of the company (optional)

buyer.company.vatNumber

Null

The VAT number of the company (optional)

buyer.company.vatText

Null

Additional information to the VAT number of the company (optional)

buyer.company.eoriNumber

Null

EORI number of the company (optional)

buyer.company.address

Object

Company’s address details

buyer.company.address.street1

String

Street (optional)

buyer.company.address.street2

String

Street addition (optional)

buyer.company.address.postbox

String

P.O. Box (optional)

buyer.company.address.state

Null

State (optional)

buyer.company.address.zip

String

ZIP code (optional)

buyer.company.address.city

String

City (optional)

buyer.company.address.country

String

Country code (optional). See Enum Values (Countries)

buyer.company.telco

Object

Company’s telecommunication details

buyer.company.telco.phone

Null

Company’s phone number (optional)

buyer.company.telco.mobile

Null

Company’s mobile number (optional)

buyer.company.telco.fax

Null

Company’s fax number (optional)

buyer.contact

Object

The associated contact - may be null

buyer.contact.firstName

String

The first name of the contact person

buyer.contact.lastName

String

The last name of the contact person

buyer.contact.email

String

Email address - may be empty

buyer.contact.telco.phone

String

Phone number (optional)

buyer.contact.telco.mobile

Null

Mobile number (optional)

buyer.contact.telco.fax

Null

Fax number (optional)

product.id

String

Unique identifier for the product. Only present if type is MESPAS

product.type

String

The type of entity. See Enum Values (Reference Types)

product.name

String

The name of the product

product.execution

String

Execution of the product (optional)

product.specification

Null

Addional specification (optional)

product.productInstance

Object

The product instance details (optional)

product.productInstance.type

String

The type of entity. See Enum Values (Reference Types)

product.productInstance.id

String

Unique identifier of the product instance. Only present if type is MESPAS

product.productInstance.serialNumber

String

The serial number

product.productInstance.label

String

An additional label (optional)

product.productInstance.buildingYear

String

The year the product instance was built (optional)

product.productInstance.builder

Object

Details about the builder (optional)

product.productInstance.builder.name

String

Company’s phone number (mandatory)

product.brand

Object

The product’s brand details

product.brand.name

String

The product’s brand name

product.specificationDetails[]

Array

Additional specification details (optional)

product.specificationDetails[].name

String

Name (mandatory)

product.specificationDetails[].value

Varies

Value (optional)

vessel.imo

String

IMO number (International Maritime Organization)

vessel.name

String

The name of the vessel

Get Offers (Multiple)

Returns multiple offers.

Http Request

GET /api/rest/supplier/v1/offers?page=0&from=2015-01-01&to=2017-08-30 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com

Http Request Body

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 3037

{
  "data" : [ {
    "id" : "1f5b1fd39e994cd2931a196af2212345",
    "reference" : "OFFER-1-2",
    "status" : "SENT",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "Buyer Inc",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "street1" : null,
          "street2" : null,
          "postbox" : null,
          "state" : null,
          "zip" : null,
          "city" : null,
          "country" : null
        },
        "telco" : {
          "phone" : null,
          "mobile" : null,
          "fax" : null
        }
      },
      "contact" : null
    },
    "offerDate" : "2014-11-29"
  }, {
    "id" : "1f5b1fd39e994cd2931a196af22c1db9",
    "reference" : "OFFER-1",
    "status" : "REPLACED",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "Buyer Inc",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "street1" : null,
          "street2" : null,
          "postbox" : null,
          "state" : null,
          "zip" : null,
          "city" : null,
          "country" : null
        },
        "telco" : {
          "phone" : null,
          "mobile" : null,
          "fax" : null
        }
      },
      "contact" : null
    },
    "offerDate" : null
  }, {
    "id" : "2f574e2b83754af9abf4e69c6da95b9d",
    "reference" : "OFFER-2",
    "status" : "SENT",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "Buyer Inc",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "street1" : null,
          "street2" : null,
          "postbox" : null,
          "state" : null,
          "zip" : null,
          "city" : null,
          "country" : null
        },
        "telco" : {
          "phone" : null,
          "mobile" : null,
          "fax" : null
        }
      },
      "contact" : null
    },
    "offerDate" : "2014-11-29"
  }, {
    "id" : "aaaaaa11111",
    "reference" : "OFFER-3",
    "status" : null,
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "Buyer Inc",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "street1" : null,
          "street2" : null,
          "postbox" : null,
          "state" : null,
          "zip" : null,
          "city" : null,
          "country" : null
        },
        "telco" : {
          "phone" : null,
          "mobile" : null,
          "fax" : null
        }
      },
      "contact" : null
    },
    "offerDate" : null
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 20
}

Http Response Fields

Path Type Description

data.[].

Array

The list of offers

data.[].status

Varies

The offer status. See Enum Values (Offer Status).

data.[].offerDate

Varies

The date when the offer was sent

data.[].id

String

The unique id of the offer referenced by this order

data.[].reference

String

The supplier’s reference number provided for that offer

data.[].buyer.company

Object

The buyer company

data.[].buyer.company.id

String

Unique identifier for the buyer company. Only present if type is MESPAS

data.[].buyer.company.type

String

The type of entity. See Enum Values (Reference Types)

data.[].buyer.company.name

String

The name of the buyer company

data.[].buyer.contact

Null

Not present (null)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Send Offer

Allows you to quote on a request.

Total Price (Calculation Rules)

The total offer price is calculated based on the offer item prices and the various other costs (packaging costs, transport costs, ..) that may be applied to an offer. In order to prevent any inconsistencies, the total offer price cannot be set directly. The example shown next explains the calculation rules for the total (final) offer price.

Table 1. Offer Price Caluclation (Example)
Pos Quantity Price Per Unit Discount Total

1

20

15

10

270

2

5

20

20

80

Total Item Price

350

Discount

10

35

Total Item Price (incl. discount)

315

Packing Costs

25

Transportation Costs

100

Insurance Costs

5

Other Costs

55

VAT

10

Total Price

550

Http Request

POST /api/rest/supplier/v1/offers/send HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com
Content-Length: 1218

{
  "offerTerms" : {
    "referenceNumber" : "c4565642-ea66-4136-8085-fe8553592c61",
    "currency" : "USD",
    "validUntil" : "2018-07-16",
    "paymentTerms" : "only cash",
    "remark" : "remark to offer terms"
  },
  "deliveryTerms" : {
    "deliveryDate" : null,
    "deliveryDateRemark" : "one week",
    "incoterm" : "CFR",
    "deliveryCountry" : "NO",
    "deliveryCity" : "Kirkeness"
  },
  "request" : {
    "id" : "ff808081645a3ce201645ad5c6920261"
  },
  "pricings" : {
    "discount" : "10.00",
    "transportCost" : "2000.00",
    "insuranceCost" : "1000.00",
    "packagingCost" : "3000.00",
    "otherCost" : null,
    "vat" : "8.00"
  },
  "items" : [ {
    "quality" : "HIGH",
    "position" : "1",
    "remark" : "Best quality requested",
    "quantity" : "2.000",
    "unit" : "PIECE",
    "discount" : "50.00",
    "pricePerUnit" : "150.0000",
    "unitConversionRate" : "1.00"
  } ],
  "attachments" : [ {
    "fileName" : "company-policy.txt",
    "mimeType" : "plain/text",
    "base64Data" : "RGVsaXZlcnkgZGF0ZXMgYXJlIGVzdGltYXRlcyBvbmx5IGFuZCBhcmUgbm90IGdyYW50ZWQ="
  }, {
    "fileName" : "appendix.txt",
    "mimeType" : "plain/text",
    "base64Data" : "R2VuZXJhbCBub3RlcyAuLi4="
  } ]
}

Http Request Parameter

None

Http Request Body

See Http Request

Http Request Fields

Path Type Description

request.id

String

The request id that the offer relates to (mandatory). 32 characters uuid.

offerTerms.referenceNumber

String

Reference number (optional). Max. 50 characters.

offerTerms.currency

String

Currency (mandatory). See Enum Values (Currencies)

offerTerms.validUntil

String

Offer’s valid until date (optional). Date format 'yyyy-mm-dd' (e.g. 2017-10-28)

offerTerms.paymentTerms

String

Your payment terms (optional). Max. 50 characters.

offerTerms.remark

String

General offer remark (optional). Unlimited number of characters.

deliveryTerms.deliveryDate

Null

The delivery date (optional). Format: YYYY-MM-DD

deliveryTerms.deliveryDateRemark

String

The delivery date remark (optional). Max. 100 characters.

deliveryTerms.incoterm

String

Incoterm (optional). NA is applied if no value is specified. See Enum Values (Incoterms)

deliveryTerms.deliveryCountry

String

Delivery country code (optional). See Enum Values (Countries)

deliveryTerms.deliveryCity

String

Delivery city (optional). Max. 100 characters.

pricings.discount

String

Discount expressed as a percentage (optional). Decimal value. Value range [0..100]

pricings.transportCost

String

The amount of transport costs (optional). Decimal value.

pricings.insuranceCost

String

The amount of insurance costs (optional). Decimal value.

pricings.packagingCost

String

The amount of packaging costs (optional). Decimal value.

pricings.otherCost

Null

The amount of other costs (optional). Decimal value.

pricings.vat

String

VAT (tax) expressed as a percentage (optional). Decimal value.

items[].position

String

Line item number (mandatory). Incremental number, starting with 1 (the first offer item has line item number 1, the second offer item has line item number 2, aso). The offer must include the same number of offer items than the according request has request items.

items[].quality

String

The quality of the item (optional). See Enum Values (Qualities)

items[].remark

String

The line item remark (optional). Unlimited number of characters.

items[].quantity

String

Item quantity (max 3 digits after the decimal place) (mandatory)

items[].unit

String

Unit (mandatory). See Enum Values (Units)

items[].discount

String

Discount in percent (optional). Decimal value. Value range [0..100]

items[].pricePerUnit

String

The item price on unit level (max 4 digits after the decimal place) (mandatory).

items[].unitConversionRate

String

The unit conversion must be present when the offer item unit differs from the unit of the according request item. Example: request item unit is 'piece', according offer item unit is 'set'. The unit conversion rate determines the conversion factor. E.g. 100 in order to express that a set contains 100 pieces.

attachments[].fileName

String

The file name of the attachment

attachments[].mimeType

String

The file’s MIME type

attachments[].base64Data

String

The file content - base64 encoded

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 162

{
  "status" : "SUCCESS",
  "code" : "SUCCESS",
  "message" : null,
  "data" : [ {
    "key" : "offerId",
    "value" : "ff808081645a3ce201645ad5c9690268"
  } ]
}

Http Response Fields

Path Type Description

status

String

Status of the action. See Enum Values (Action Status)

code

String

Additional status code (error code in case of failure). See Enum Values (Action Code)

message

Null

A description of the error that occured (optional). Only present in case of an error

data

Array

Empty array (not used)

data.[]

Array

An array of key value pairs associated to the results of the executed action (e.g. the id of a created offer)

data.[].key

String

The association’s key (e.g. offerId)

data.[].value

String

The corresponding value

Orders

Get Order

A GET order will return the order identified by the given id.

Http Request

GET /api/rest/supplier/v1/orders/fc1a5efce82d11e4b02c1681e6b88ec1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com

Http Request Body

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 15095

{
  "id" : "fc1a5efce82d11e4b02c1681e6b88ec1",
  "offer" : {
    "id" : "1f5b1fd39e994cd2931a196af22c1db9",
    "reference" : "OFFER-1"
  },
  "status" : "NEW",
  "buyer" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
      "name" : "Buyer Inc.",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "street1" : "Heinrichstrasse 213",
        "street2" : "",
        "postbox" : "",
        "state" : "ZH",
        "zip" : "8005",
        "city" : "Zurich",
        "country" : "CH"
      },
      "telco" : {
        "phone" : null,
        "mobile" : null,
        "fax" : null
      }
    },
    "contact" : {
      "firstName" : "John",
      "lastName" : "Doe",
      "email" : "john@mail.mail",
      "telco" : {
        "phone" : "+41 44 520 1030",
        "mobile" : "+41 76 79 85369",
        "fax" : "+41 44 520 1031"
      }
    }
  },
  "invoiceDetails" : {
    "company" : {
      "type" : "OTHER",
      "id" : null,
      "name" : "mv ULTIMATE FREEDOM Co & KG",
      "web" : null,
      "vatNumber" : "CHE 123.456.789",
      "vatText" : "VAT text",
      "eoriNumber" : "CH987654312000",
      "address" : {
        "street1" : "Ballindamm 25",
        "street2" : "",
        "postbox" : "",
        "state" : "HH",
        "zip" : "20095",
        "city" : "Hamburg",
        "country" : "DE"
      },
      "telco" : {
        "phone" : null,
        "mobile" : null,
        "fax" : null
      }
    },
    "contact" : {
      "firstName" : "Chan",
      "lastName" : "Heng Chee",
      "email" : "chan.heng.chee@xxx.xx",
      "telco" : {
        "phone" : "",
        "mobile" : "+65 6538 6930",
        "fax" : ""
      }
    }
  },
  "deliveryDetails" : {
    "company" : {
      "type" : "OTHER",
      "id" : null,
      "name" : "Port of Hong Kong",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "street1" : "Harbour Building",
        "street2" : "38 Pier Road",
        "postbox" : "",
        "state" : "",
        "zip" : "",
        "city" : "Hong Kong",
        "country" : "HK"
      },
      "telco" : {
        "phone" : null,
        "mobile" : null,
        "fax" : null
      }
    },
    "contact" : null,
    "recipient" : "John Meyer",
    "recipientPhone" : "John Meyer",
    "remark" : "Warehouse at pier 7"
  },
  "orderTerms" : {
    "referenceNumber" : "O-2007-GER-00013/01/01",
    "currency" : "CHF",
    "orderDate" : "2015-02-11",
    "paymentTerms" : "On delivery",
    "remark" : "Please handle with care"
  },
  "deliveryTerms" : {
    "deliveryDate" : "2018-06-28",
    "deliveryDateRemark" : "2 weeks after order",
    "incoterm" : "FAS"
  },
  "vessel" : {
    "name" : "ULTIMATE FREEDOM",
    "imo" : null
  },
  "product" : {
    "type" : "MESPAS",
    "id" : "fd58bbe5f86041099660167b87dfe1c6",
    "name" : "S20H",
    "execution" : "",
    "specification" : null,
    "productInstance" : {
      "type" : "MESPAS",
      "id" : "1133b4f2042c4aac901e1e866d64b0b0",
      "serialNumber" : "5150",
      "buildingYear" : "2014",
      "label" : "Auxiliary Engine#1",
      "builder" : {
        "name" : "H. Cegielski-Poznan S.A."
      }
    },
    "brand" : {
      "name" : "Sulzer"
    },
    "specificationDetails" : [ {
      "name" : "Warranty Alarm [days]",
      "value" : null
    }, {
      "name" : "Location",
      "value" : null
    }, {
      "name" : "MCR [kW]",
      "value" : null
    }, {
      "name" : "Remark 1",
      "value" : null
    }, {
      "name" : "Rotation Direction",
      "value" : "755"
    }, {
      "name" : "Engine Execution",
      "value" : "1 CWF"
    }, {
      "name" : "Yard Tag Number",
      "value" : null
    }, {
      "name" : "Operating System",
      "value" : null
    }, {
      "name" : "No. of Cylinders",
      "value" : "8"
    }, {
      "name" : "Warranty Exp. Date",
      "value" : null
    }, {
      "name" : "Speed CMCR [rpm]",
      "value" : "1000"
    }, {
      "name" : "CMCR [kW]",
      "value" : "1080"
    }, {
      "name" : "Fuel Oil Type",
      "value" : null
    } ]
  },
  "attachments" : [ {
    "fileId" : "d052ac08d1814af2a74a766e2ee65d88",
    "fileName" : "invoicing-details.txt",
    "size" : "0.0240",
    "mimeType" : "text/plain"
  } ],
  "pricings" : {
    "discount" : "10.00",
    "transportCost" : "150.0000",
    "insuranceCost" : "15.0000",
    "packagingCost" : "100.0000",
    "otherCost" : null,
    "vat" : null,
    "total" : "671.9800"
  },
  "items" : [ {
    "quality" : null,
    "position" : "1",
    "remark" : "remark to this item",
    "quantity" : "5.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "10.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305c6cd764111e4988e002219ba5b31",
      "name" : "bush (nozzle holder)",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "2",
    "remark" : "Best quality",
    "quantity" : "1.000",
    "unit" : "PIECE",
    "discount" : "5.25",
    "pricePerUnit" : "11.3285",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305c345764111e4988e002219ba5b31",
      "name" : "gudgeon stud",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "3",
    "remark" : "remark to this item",
    "quantity" : "2.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "12.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305c3c7764111e4988e002219ba5b31",
      "name" : "gudgeon pin",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "4",
    "remark" : "remark to this item",
    "quantity" : "1.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "13.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305c3e7764111e4988e002219ba5b31",
      "name" : "piston ring",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "5",
    "remark" : "remark to this item",
    "quantity" : "1.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "14.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305c625764111e4988e002219ba5b31",
      "name" : "cylinder cover",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "6",
    "remark" : "remark to this item",
    "quantity" : "9.236",
    "unit" : "KILOGRAM",
    "discount" : "5.00",
    "pricePerUnit" : "15.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305c6ed764111e4988e002219ba5b31",
      "name" : "fuel injector nozzle",
      "execution" : "160x12x0,255",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "7",
    "remark" : "remark to this item",
    "quantity" : "3.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "16.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305c89c764111e4988e002219ba5b31",
      "name" : "pushrod for nozzle holder",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "8",
    "remark" : "remark to this item",
    "quantity" : "2.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "17.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305d52e764111e4988e002219ba5b31",
      "name" : "copper joint ring",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "9",
    "remark" : "remark to this item",
    "quantity" : "5.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "18.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "2305dd8b764111e4988e002219ba5b31",
      "name" : "gasket",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  }, {
    "quality" : null,
    "position" : "10",
    "remark" : "remark to this item",
    "quantity" : "3.000",
    "unit" : "PIECE",
    "discount" : "5.00",
    "pricePerUnit" : "19.0000",
    "unitConversionRate" : null,
    "component" : {
      "type" : "MESPAS",
      "id" : "230677a8764111e4988e002219ba5b31",
      "name" : "Pressure Transmitter (0 ~ 10bar), Type: 8244.78.2318, IP65, S/N 028726.0.00.01-001, maker: trafag",
      "execution" : "",
      "brand" : null,
      "specificationDetails" : [ {
        "name" : "Part No.",
        "value" : "2722/A104"
      }, {
        "name" : "Part No.",
        "value" : "3301/A105"
      }, {
        "name" : "Part No.",
        "value" : "3401/A108"
      }, {
        "name" : "Part No.",
        "value" : "3425/A002"
      }, {
        "name" : "Part No.",
        "value" : "2701/A098"
      }, {
        "name" : "Part No.",
        "value" : "2724/A004"
      }, {
        "name" : "Part No.",
        "value" : "2722/A107"
      }, {
        "name" : "should not be visible value",
        "value" : "should not be visible value"
      } ]
    }
  } ]
}

Http Response Fields

Path Type Description

vessel

Object

The vessel associated with the order

buyer

Object

Information about the buyer that ordered

offer

Object

The offer that this order relates to. In case of a direct order, the offer reference is not existing

invoiceDetails

Object

Invoicing address and contact details. Similar structure to the buyer address and contact.

deliveryDetails

Object

Delivery address (similar structure to the buyer address). Contact (person in charge) details are available in the fields recipient, recipientPhone and remark

product

Object

Details about the product the ordered items belong to

items

Array

The list of the ordered items

attachments

Array

The list of files attached to the order

id

String

Unique identifier of the order.

status

String

The order status. See Enum Values (Order Status)

offer.id

String

The unique id of the offer referenced by this order

offer.reference

String

The supplier’s reference number provided for that offer

buyer.company

Object

The company

buyer.company.id

String

Unique identifier for the company. Only present if type is MESPAS

buyer.company.type

String

The type of entity. See Enum Values (Reference Types)

buyer.company.name

String

The name of the company

buyer.company.web

Null

The website of the company (optional)

buyer.company.vatNumber

Null

The VAT number of the company (optional)

buyer.company.vatText

Null

Additional information to the VAT number of the company (optional)

buyer.company.eoriNumber

Null

EORI number of the company (optional)

buyer.company.address

Object

Company’s address details

buyer.company.address.street1

String

Street (optional)

buyer.company.address.street2

String

Street addition (optional)

buyer.company.address.postbox

String

P.O. Box (optional)

buyer.company.address.state

String

State (optional)

buyer.company.address.zip

String

ZIP code (optional)

buyer.company.address.city

String

City (optional)

buyer.company.address.country

String

Country code (optional). See Enum Values (Countries)

buyer.company.telco

Object

Company’s telecommunication details

buyer.company.telco.phone

Null

Company’s phone number (optional)

buyer.company.telco.mobile

Null

Company’s mobile number (optional)

buyer.company.telco.fax

Null

Company’s fax number (optional)

buyer.contact

Object

The associated contact - may be null

buyer.contact.firstName

String

The first name of the contact person

buyer.contact.lastName

String

The last name of the contact person

buyer.contact.email

String

Email address - may be empty

buyer.contact.telco.phone

String

Phone number (optional)

buyer.contact.telco.mobile

String

Mobile number (optional)

buyer.contact.telco.fax

String

Fax number (optional)

orderTerms.referenceNumber

String

Order reference number (mandatory)

orderTerms.currency

String

Currency (mandatory). See Enum Values (Currencies)

orderTerms.orderDate

String

The date the order was received

orderTerms.paymentTerms

String

The buyer’s payment terms (optional)

orderTerms.remark

String

General order remark (optional)

deliveryTerms.deliveryDate

String

The ordered delivery date (optional) - Date format 'yyyy-mm-dd' (e.g. 2018-12-19)

deliveryTerms.deliveryDateRemark

String

The delivery date remark (optional). Max. 100 characters.

deliveryTerms.incoterm

String

Incoterm. See Enum Values (Incoterms)

product.id

String

Unique identifier for the product. Only present if type is MESPAS

product.type

String

The type of entity. See Enum Values (Reference Types)

product.name

String

The name of the product

product.execution

String

Execution of the product (optional)

product.specification

Null

Addional specification (optional)

product.productInstance

Object

The product instance details (optional)

product.productInstance.type

String

The type of entity. See Enum Values (Reference Types)

product.productInstance.id

String

Unique identifier of the product instance. Only present if type is MESPAS

product.productInstance.serialNumber

String

The serial number

product.productInstance.label

String

An additional label (optional)

product.productInstance.buildingYear

String

The year the product instance was built (optional)

product.productInstance.builder

Object

Details about the builder (optional)

product.productInstance.builder.name

String

Company’s phone number (mandatory)

product.brand

Object

The product’s brand details

product.brand.name

String

The product’s brand name

product.specificationDetails[]

Array

Additional specification details (optional)

product.specificationDetails[].name

String

Name (mandatory)

product.specificationDetails[].value

Varies

Value (optional)

pricings.total

String

Total amount

pricings.discount

String

Discount expressed as a percentage (optional). Decimal value. Value range [0..100]

pricings.transportCost

String

The amount of transport costs (optional). Decimal value.

pricings.insuranceCost

String

The amount of insurance costs (optional). Decimal value.

pricings.packagingCost

String

The amount of packaging costs (optional). Decimal value.

pricings.otherCost

Null

The amount of other costs (optional). Decimal value.

pricings.vat

Null

VAT (tax) expressed as a percentage (optional). Decimal value.

items[].position

String

Line item number (mandatory). Incremental number, starting with 1 (the first offer item has line item number 1, the second offer item has line item number 2, aso). The offer must include the same number of offer items than the according request has request items.

items[].quality

Null

The quality of the item (optional). See Enum Values (Qualities)

items[].remark

String

The line item remark (optional). Unlimited number of characters.

items[].quantity

String

Item quantity (max 3 digits after the decimal place) (mandatory)

items[].unit

String

Unit (mandatory). See Enum Values (Units)

items[].discount

String

Discount in percent (optional). Decimal value. Value range [0..100]

items[].pricePerUnit

String

The item price on unit level (max 4 digits after the decimal place) (mandatory).

items[].unitConversionRate

Null

The unit conversion must be present when the offer item unit differs from the unit of the according request item. Example: request item unit is 'piece', according offer item unit is 'set'. The unit conversion rate determines the conversion factor. E.g. 100 in order to express that a set contains 100 pieces.

items[].component

Object

The requested component (mandatory)

items[].component.type

String

The type of entity. See Enum Values (Reference Types)

items[].component.id

String

Unique identifier of the component. Only present if type is MESPAS

items[].component.name

String

The component’s name

items[].component.execution

String

The component’s execution

items[].component.brand

Null

Brand details

items[].component.brand.name

String

Brand name

items[].component.specificationDetails

Array

Additional specification details (optional)

items[].component.specificationDetails[].name

String

Name (mandatory)

items[].component.specificationDetails[].value

String

Value (optional)

attachments[].fileId

String

The unique id of the attachment. This id is used in order to download the according file (see Get Attachment)

attachments[].fileName

String

The file name of the attachment

attachments[].mimeType

String

The file’s MIME type (application/octet-stream in case of files attached to requests and orders)

attachments[].size

String

The attachment’s size in [kb]

Get Orders (Multiple)

Returns multiple orders.

Http Request

GET /api/rest/supplier/v1/orders?page=0&after=2015-01-01&before=2015-02-28 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

before

Optional request parameter allowing to search for requests which were received before the specified date. The date format to use is yyyy-MM-dd (e.g. 2017-07-28)

after

Optional request parameter allowing to search for requests which were received after the specified date. The date format to use is yyyy-MM-dd (e.g. 2017-07-28).

Http Request Body

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 840

{
  "data" : [ {
    "id" : "fc1a5efce82d11e4b02c1681e6b88ec1",
    "referenceNumber" : "O-2007-GER-00013/01/01",
    "status" : "NEW",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "Buyer Inc",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "street1" : null,
          "street2" : null,
          "postbox" : null,
          "state" : null,
          "zip" : null,
          "city" : null,
          "country" : null
        },
        "telco" : {
          "phone" : null,
          "mobile" : null,
          "fax" : null
        }
      },
      "contact" : null
    },
    "orderDate" : "2015-02-11"
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 20
}

Http Response Fields

Path Type Description

data.[].

Array

The list of orders

data.[].referenceNumber

String

Order reference number (mandatory)

data.[].orderDate

String

The date the order was received

data.[].id

String

Unique identifier of the order.

data.[].status

String

The order status. See Enum Values (Order Status)

data.[].buyer.company

Object

The buyer company

data.[].buyer.company.id

String

Unique identifier for the buyer company. Only present if type is MESPAS

data.[].buyer.company.type

String

The type of entity. See Enum Values (Reference Types)

data.[].buyer.company.name

String

The name of the buyer company

data.[].buyer.contact

Null

Not present (null)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Reject Order

Allows you to reject an order, in case that you are not willing to accept the order.

Http Request

POST /api/rest/supplier/v1/orders/ff808081645a3ce201645ad5d75f0275/reject HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com
Content-Length: 35

{ "remark": "Not willing to quote"}

Http Request Parameter

None

Http Request Body

{ "remark": "Not willing to quote"}

Http Request Fields

Path Type Description

remark

String

The reason for rejecting the order (optional). Max size 2048.

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 84

{
  "status" : "SUCCESS",
  "code" : "SUCCESS",
  "message" : null,
  "data" : [ ]
}

Http Response Fields

Path Type Description

status

String

Status of the action. See Enum Values (Action Status)

code

String

Additional status code (error code in case of failure). See Enum Values (Action Code)

message

Null

A description of the error that occured (optional). Only present in case of an error

data

Array

Empty array (not used)

Confirm Order

Allows you to confirm an order and providing a confirmation remark for the buyer.

Http Request

POST /api/rest/supplier/v1/orders/ff808081645a3ce201645ad5d46f026d/confirm HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com
Content-Length: 43

{ "remark": "Thanks a lot for this order!"}

Http Request Parameter

None

Http Request Body

{ "remark": "Thanks a lot for this order!"}

Http Request Fields

Path Type Description

remark

String

The reason for rejecting the request (optional). Max size 2048.

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 84

{
  "status" : "SUCCESS",
  "code" : "SUCCESS",
  "message" : null,
  "data" : [ ]
}

Http Response Fields

Path Type Description

status

String

Status of the action. See Enum Values (Action Status)

code

String

Additional status code (error code in case of failure). See Enum Values (Action Code)

message

Null

A description of the error that occured (optional). Only present in case of an error

data

Array

Empty array (not used)

Events

Get Events

Returns multiple events. See Buyer Events / Polling for a detailed description.

Http Request

GET /api/rest/supplier/v1/events?last_received=0 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/json
Host: api.mespas.com

Http Request Parameter

Parameter Description

last_received

The event id of the last received event. Only subsequent events are returned. If the parameter is not present, all events will be returned (including events which you may already have received)

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 19949

[ {
  "eventId" : 1,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "11c78e43f82b4da0ba7cd37d13ea3242"
}, {
  "eventId" : 1,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bbff9670004"
}, {
  "eventId" : 2,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "4f9f5e4b0f4d47e48951c69b0660c42b"
}, {
  "eventId" : 2,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc00789000f"
}, {
  "eventId" : 3,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "11c78e43f82b4da0ba7cd37d13ea3242"
}, {
  "eventId" : 3,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc00af8001a"
}, {
  "eventId" : 4,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc010d50038"
}, {
  "eventId" : 5,
  "eventType" : "ORDER_UPDATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc010d50038"
}, {
  "eventId" : 6,
  "eventType" : "ORDER_CANCELLED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc010d50038"
}, {
  "eventId" : 7,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc01a580042"
}, {
  "eventId" : 8,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc025e7004a"
}, {
  "eventId" : 9,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc02ea80065"
}, {
  "eventId" : 10,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc030a7006d"
}, {
  "eventId" : 11,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc0353b0088"
}, {
  "eventId" : 12,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc040ec00a3"
}, {
  "eventId" : 13,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0474600ab"
}, {
  "eventId" : 14,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc04b3800b4"
}, {
  "eventId" : 15,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc04b3800b4"
}, {
  "eventId" : 16,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc04ddb00bc"
}, {
  "eventId" : 17,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc052e200c5"
}, {
  "eventId" : 18,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0558f00cc"
}, {
  "eventId" : 19,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0558f00cc"
}, {
  "eventId" : 20,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc05ac500d6"
}, {
  "eventId" : 21,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc05dc800dd"
}, {
  "eventId" : 22,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0602e00e4"
}, {
  "eventId" : 23,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0634a00eb"
}, {
  "eventId" : 24,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0749a00ff"
}, {
  "eventId" : 25,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc080a0010b"
}, {
  "eventId" : 26,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc08b18011d"
}, {
  "eventId" : 27,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc094520129"
}, {
  "eventId" : 28,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc097890130"
}, {
  "eventId" : 29,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc099b20137"
}, {
  "eventId" : 30,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc09c21013e"
}, {
  "eventId" : 31,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc09e710145"
}, {
  "eventId" : 32,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0b1c70156"
}, {
  "eventId" : 33,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0b43c015d"
}, {
  "eventId" : 34,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0bd4c0169"
}, {
  "eventId" : 35,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0c2570172"
}, {
  "eventId" : 36,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0c4a40179"
}, {
  "eventId" : 37,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0c7150180"
}, {
  "eventId" : 38,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0c95e0187"
}, {
  "eventId" : 39,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0cf0d0196"
}, {
  "eventId" : 40,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc0e4c601b1"
}, {
  "eventId" : 41,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc10b8901bd"
}, {
  "eventId" : 42,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc1168201c9"
}, {
  "eventId" : 43,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc123e001d5"
}, {
  "eventId" : 44,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401644bc1265801dd"
}, {
  "eventId" : 45,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc1297f01e5"
}, {
  "eventId" : 46,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc12bdc01ec"
}, {
  "eventId" : 47,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401644bc66dd601f9"
}, {
  "eventId" : 48,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d04016459df82f10200"
}, {
  "eventId" : 49,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d04016459e13b910208"
}, {
  "eventId" : 50,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d04016459e13ea00210"
}, {
  "eventId" : 51,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d04016459e472a00218"
}, {
  "eventId" : 52,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d04016459e4759b0220"
}, {
  "eventId" : 53,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d04016459e5c32c0228"
}, {
  "eventId" : 54,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d04016459e5ced80234"
}, {
  "eventId" : 55,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a01e6480240"
}, {
  "eventId" : 56,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a03df0e024c"
}, {
  "eventId" : 57,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a04ca4a0258"
}, {
  "eventId" : 58,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a04ca4a0258"
}, {
  "eventId" : 59,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a04e5290278"
}, {
  "eventId" : 60,
  "eventType" : "ORDER_UPDATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a04e5290278"
}, {
  "eventId" : 61,
  "eventType" : "ORDER_CANCELLED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a04e5290278"
}, {
  "eventId" : 62,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a065f690282"
}, {
  "eventId" : 63,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a065f690282"
}, {
  "eventId" : 64,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a066452028a"
}, {
  "eventId" : 65,
  "eventType" : "ORDER_UPDATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a066452028a"
}, {
  "eventId" : 66,
  "eventType" : "ORDER_CANCELLED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a066452028a"
}, {
  "eventId" : 67,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a0924d40294"
}, {
  "eventId" : 68,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a0a6e7202a6"
}, {
  "eventId" : 69,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a0aed1f02af"
}, {
  "eventId" : 70,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a0aed1f02af"
}, {
  "eventId" : 71,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a0af45d02b7"
}, {
  "eventId" : 72,
  "eventType" : "ORDER_UPDATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a0af45d02b7"
}, {
  "eventId" : 73,
  "eventType" : "ORDER_CANCELLED",
  "entityType" : "ORDER",
  "entityId" : "ff808081644b2d0401645a0af45d02b7"
}, {
  "eventId" : 74,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a2edc4c02c1"
}, {
  "eventId" : 75,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a2f85a402d3"
}, {
  "eventId" : 76,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a300d8a02dc"
}, {
  "eventId" : 77,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a30176b02ee"
}, {
  "eventId" : 78,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a33288902f7"
}, {
  "eventId" : 79,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a33a9fd0309"
}, {
  "eventId" : 80,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a340cec0312"
}, {
  "eventId" : 81,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081644b2d0401645a3425cc0324"
}, {
  "eventId" : 82,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a4083320000"
}, {
  "eventId" : 83,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a40b4db0012"
}, {
  "eventId" : 84,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a451134001b"
}, {
  "eventId" : 85,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a4a7a78002d"
}, {
  "eventId" : 86,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a4afa98003f"
}, {
  "eventId" : 87,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a4cef330048"
}, {
  "eventId" : 88,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a4daee9005a"
}, {
  "eventId" : 89,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a4e19940063"
}, {
  "eventId" : 90,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a4e239c0075"
}, {
  "eventId" : 91,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a7290f4007e"
}, {
  "eventId" : 92,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a72b5290086"
}, {
  "eventId" : 93,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a72bcbc00a1"
}, {
  "eventId" : 94,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a72be2c00a9"
}, {
  "eventId" : 95,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a72c1bd00c4"
}, {
  "eventId" : 96,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a72c99b00df"
}, {
  "eventId" : 97,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a7337db00e7"
}, {
  "eventId" : 98,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a73408f00f9"
}, {
  "eventId" : 99,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a7343be0102"
}, {
  "eventId" : 100,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645a7343be0102"
}, {
  "eventId" : 101,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a73479e010a"
}, {
  "eventId" : 102,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a734c600125"
}, {
  "eventId" : 103,
  "eventType" : "ORDER_UPDATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a734c600125"
}, {
  "eventId" : 104,
  "eventType" : "ORDER_CANCELLED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645a734c600125"
}, {
  "eventId" : 105,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad4bb2e012f"
}, {
  "eventId" : 106,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad4bb2e012f"
}, {
  "eventId" : 107,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645ad4c07b0137"
}, {
  "eventId" : 108,
  "eventType" : "ORDER_UPDATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645ad4c07b0137"
}, {
  "eventId" : 109,
  "eventType" : "ORDER_CANCELLED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645ad4c07b0137"
}, {
  "eventId" : 110,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645ad4c8330141"
}, {
  "eventId" : 111,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645ad4cd4e0149"
}, {
  "eventId" : 112,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff808081645a3ce201645ad4d1630151"
}, {
  "eventId" : 113,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad4eb1b0159"
}, {
  "eventId" : 114,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad4eb1b0159"
}, {
  "eventId" : 115,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad518b00161"
}, {
  "eventId" : 116,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad51b060168"
}, {
  "eventId" : 117,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad51b060168"
}, {
  "eventId" : 118,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad520210172"
}, {
  "eventId" : 119,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad522920179"
}, {
  "eventId" : 120,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad524ba0180"
}, {
  "eventId" : 121,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5273f0187"
}, {
  "eventId" : 122,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad535820199"
}, {
  "eventId" : 123,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5405501a5"
}, {
  "eventId" : 124,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5495f01b7"
}, {
  "eventId" : 125,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad553a401c3"
}, {
  "eventId" : 126,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5564501ca"
}, {
  "eventId" : 127,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5582f01d1"
}, {
  "eventId" : 128,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad559cb01d8"
}, {
  "eventId" : 129,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad55c8201df"
}, {
  "eventId" : 130,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5707f01f0"
}, {
  "eventId" : 131,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad572e501f7"
}, {
  "eventId" : 132,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad57a920203"
}, {
  "eventId" : 133,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad57f3a020c"
}, {
  "eventId" : 134,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5813d0213"
}, {
  "eventId" : 135,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad58338021a"
}, {
  "eventId" : 136,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad585950221"
}, {
  "eventId" : 137,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad58b130230"
}, {
  "eventId" : 138,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad597440249"
}, {
  "eventId" : 139,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5ba730255"
}, {
  "eventId" : 140,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff808081645a3ce201645ad5c6920261"
} ]

Http Response Fields

Path Type Description

[].eventId

Number

The unique id of this event. Incrementing number. You should store the id of the last consumed event in order to query only new events the next time (URL param 'last_received')

[].eventType

String

The event type that caused the entry. See Enum Values (Event Types)

[].entityType

String

The entity type. See Enum Values (Entity Types)

[].entityId

String

The unique id of the entity

Attachments

Get Attachment

A GET request that returns the file content of an attachment. The identifier used to GET the file data corresponds to the fileId attribute of the attachment structure (see Get Quote Request, Get Offer, Get Order).

Http Request

GET /api/rest/supplier/v1/files/ff808081644b2a6b01645ad5ddf70049 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Accept: application/octet-stream
Host: api.mespas.com

Http Request Body

Http Response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: plain/text
Content-Length: 53
Content-Disposition: form-data; name="attachment"; filename="company-policy.txt"

Delivery dates are estimates only and are not granted

Http Response Body

Delivery dates are estimates only and are not granted