Introduction

Welcome to the MESPAS supplier API reference. The MESPAS supplier API is a restful API (application programming interface) suitable for maritime supplier companies. You can use the MESPAS supplier API to integrate your existing ERP (enterprise resource planning) system with MESPAS Connect.

MESPAS Connect is an e-trading platform for the maritime industry that links together thousands of ships, ship management offices and suppliers. It facilitates the procurement process by the use of well-structured, global master data – which enables an easy and straight-forward integration with ERP systems.

The MESPAS Supplier API provides you with the following:

  • Receive ship manager quote requests electronically

  • Receive ship manager orders electronically

  • Send your quotes related to the received quote requests

  • Integrate the message flow into your existing ERP system

Getting started

Are you a maritime supplier receiving quote requests and orders via MESPAS Connect? Would you like 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/ms/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/ms

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

Attention The sandbox environment is not always up and running. Please contact us at info@mespas.com if 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). If the dates include a time of day as well, they are displayed in the format 'yyyy-MM-dd HH:mm' (e.g. 2017-09-14 13:53 for the 14th September 2017 13:53)

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 at 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

BGN

Bulgarian lew

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

OMR

Omani rial

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

LUMP_SUM

Lump sum

PER_DAY

Per day

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.

IT OPS Mode

Mode Description

CUBE

Installation uses CUBE

CUBE_LESS

Installation uses mobile app

Buyer Offer States

State Description

ordered

Offer has been ordered

closed

Offer has been closed

replaced

Offer has been replaced

to be approved

Offer waiting for approval

undefined

Cannot determine offer state

Purchase Request Urgency

Urgency Description

0

Urgent

1

Next Convenient Port

2

Next Quarterly Supply

3

Emergency Supply

Task State

State Description

0

Pending

1

Postponed

2

Need approval

3

Closed

4

Postponement need approval

999

Not closed

Requests

Get quote request (single)

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
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Host: api.mespas.com

Http Request Body

Http Response

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

{
  "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" : "2019-06-19",
    "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" : {
        "coName" : "",
        "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" : "9212759"
  },
  "buyer" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
      "name" : "ULTIMATE FREEDOM Co & KG",
      "web" : null,
      "vatNumber" : "CHE 123.456.789",
      "vatText" : "VAT text",
      "eoriNumber" : "CH987654312000",
      "address" : {
        "coName" : "Naizen Shipping",
        "street1" : "Ballindamm 25",
        "street2" : "",
        "postbox" : "",
        "state" : "HH",
        "zip" : "20095",
        "city" : "Hamburg",
        "country" : "DE"
      },
      "telco" : {
        "phone" : "+49 40 3333-0",
        "mobile" : null,
        "fax" : ""
      }
    },
    "contact" : {
      "firstName" : "Walter",
      "lastName" : "Schmid",
      "email" : "walter.schmid@mail.mail",
      "telco" : {
        "phone" : "",
        "mobile" : "+41177953624",
        "fax" : ""
      }
    }
  },
  "supplier" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "b5ecda1cfada11e4a3221697f925ec7b",
      "name" : "MESPAS Holding Inc",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "coName" : null,
        "street1" : "35th floor, Prime Tower",
        "street2" : "Hardstrasse 201",
        "postbox" : "112233",
        "state" : "ZH",
        "zip" : "8005",
        "city" : "Zurich",
        "country" : "CH"
      },
      "telco" : {
        "phone" : null,
        "mobile" : null,
        "fax" : null
      }
    },
    "contact" : {
      "firstName" : "Daniel",
      "lastName" : "Gsponer",
      "email" : "admin@mespas.com",
      "telco" : {
        "phone" : "+41 44 520 10 44",
        "mobile" : "+41 79 209 11 22",
        "fax" : null
      }
    }
  },
  "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"
      } ],
      "primaryIdentificationValue" : "7505/A131",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "For Hydrauilic Jack Type W27.002",
      "secondaryIdentificationValue" : null
    }
  } ]
}

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

String

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.coName

String

c/o (care of) recipient (optional)

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

String

The VAT number of the company (optional)

buyer.company.vatText

String

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

buyer.company.eoriNumber

String

EORI number of the company (optional)

buyer.company.address

Object

Company’s address details

buyer.company.address.coName

String

c/o (care of) recipient (optional)

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)

supplier.company

Object

The company

supplier.company.id

String

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

supplier.company.type

String

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

supplier.company.name

String

The name of the company

supplier.company.web

Null

The website of the company (optional)

supplier.company.vatNumber

Null

The VAT number of the company (optional)

supplier.company.vatText

Null

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

supplier.company.eoriNumber

Null

EORI number of the company (optional)

supplier.company.address

Object

Company’s address details

supplier.company.address.coName

Null

c/o (care of) recipient (optional)

supplier.company.address.street1

String

Street (optional)

supplier.company.address.street2

String

Street addition (optional)

supplier.company.address.postbox

String

P.O. Box (optional)

supplier.company.address.state

String

State (optional)

supplier.company.address.zip

String

ZIP code (optional)

supplier.company.address.city

String

City (optional)

supplier.company.address.country

String

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

supplier.company.telco

Object

Company’s telecommunication details

supplier.company.telco.phone

Null

Company’s phone number (optional)

supplier.company.telco.mobile

Null

Company’s mobile number (optional)

supplier.company.telco.fax

Null

Company’s fax number (optional)

supplier.contact

Object

The associated contact - may be null

supplier.contact.firstName

String

The first name of the contact person

supplier.contact.lastName

String

The last name of the contact person

supplier.contact.email

String

Email address - may be empty

supplier.contact.telco.phone

String

Phone number (optional)

supplier.contact.telco.mobile

String

Mobile number (optional)

supplier.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

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.primaryIdentificationValue

String

The primary identification value

items[].component.secondaryIdentificationValue

Null

The secondary identification value

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
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 882

{
  "data" : [ {
    "id" : "11c78e43f82b4da0ba7cd37d13ea3242",
    "referenceNumber" : "V-12-TESTREF-56-D/03",
    "status" : "NEW",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "ULTIMATE FREEDOM Co & KG",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "coName" : null,
          "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/ff80818187b7df1f0187b80cd3ff0e6f/reject HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Content-Length: 35
Host: api.mespas.com

{ "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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 84
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "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/ff80818187b7df1f0187b80ce4680eae HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Host: api.mespas.com

Http Request Body

Http Response

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

{
  "offerTerms" : {
    "referenceNumber" : "9270ca51-bfe4-4ae3-8382-5329c21ba9c3",
    "currency" : "USD",
    "validUntil" : "2023-05-09",
    "paymentTerms" : "only cash",
    "remark" : "remark to offer terms"
  },
  "deliveryTerms" : {
    "deliveryDate" : null,
    "deliveryDateRemark" : "one week",
    "incoterm" : "CFR",
    "deliveryCountry" : "NO",
    "deliveryCity" : "Kirkeness"
  },
  "id" : "ff80818187b7df1f0187b80ce4680eae",
  "priority" : null,
  "offerStatus" : "SENT",
  "offerDate" : "2023-04-25",
  "buyer" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
      "name" : "TBSC GmbH & Co KG",
      "web" : null,
      "vatNumber" : "vatNumber",
      "vatText" : "vatText",
      "eoriNumber" : "eoriNumber",
      "address" : {
        "coName" : null,
        "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" : "Operating System",
      "value" : "Cargo hold #1"
    }, {
      "name" : "Operating System",
      "value" : "Cargo hold #1"
    }, {
      "name" : "Location",
      "value" : "Power supply"
    }, {
      "name" : "Location",
      "value" : "Aft Engine Room"
    }, {
      "name" : "Warranty Alarm [days]",
      "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" : "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
    }, {
      "name" : "Speed CMCR [rpm]",
      "value" : "1000"
    } ]
  },
  "vessel" : {
    "name" : "Celebrity Eclipse (MS A2)",
    "imo" : "1458785"
  },
  "request" : {
    "id" : "ff80818187b7df1f0187b80ce27a0ea7",
    "reference" : "REQ-2023-216606"
  },
  "pricings" : {
    "discount" : "10.00",
    "transportCost" : "2000.0000",
    "insuranceCost" : "1000.0000",
    "packagingCost" : "3000.0000",
    "otherCost" : null,
    "vat" : "8.0000",
    "total" : "6625.8000"
  },
  "attachments" : [ {
    "fileId" : "ff80818187b7dd6d0187b80ce42e001e",
    "fileName" : "company-policy.txt",
    "size" : "0.0510",
    "mimeType" : "plain/text"
  }, {
    "fileId" : "ff80818187b7dd6d0187b80ce447001f",
    "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" : "Subtype PT-001-1 Component 1 Spez."
      }, {
        "name" : "Drawing No.",
        "value" : "Spec 2"
      }, {
        "name" : "Section Name",
        "value" : "Hydraulic Jack Type 23.00 - 5"
      } ],
      "primaryIdentificationValue" : null,
      "secondaryIdentificationValue" : null
    }
  } ]
}

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.primaryIdentificationValue

Null

The primary identification value

items[].component.secondaryIdentificationValue

Null

The secondary identification value

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

String

The VAT number of the company (optional)

buyer.company.vatText

String

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

buyer.company.eoriNumber

String

EORI number of the company (optional)

buyer.company.address

Object

Company’s address details

buyer.company.address.coName

Null

c/o (care of) recipient (optional)

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
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Host: api.mespas.com

Http Request Body

Http Response

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

{
  "data" : [ {
    "id" : "aaaaaa11111",
    "reference" : "OFFER-3",
    "status" : null,
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "ULTIMATE FREEDOM Co & KG",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "coName" : null,
          "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" : "ULTIMATE FREEDOM Co & KG",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "coName" : null,
          "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-28"
  }, {
    "id" : "1f5b1fd39e994cd2931a196af22c1db9",
    "reference" : "OFFER-1",
    "status" : "REPLACED",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "ULTIMATE FREEDOM Co & KG",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "coName" : null,
          "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" : "1f5b1fd39e994cd2931a196af2212345",
    "reference" : "OFFER-1-2",
    "status" : "SENT",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "ULTIMATE FREEDOM Co & KG",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "coName" : null,
          "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-28"
  } ],
  "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
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Content-Length: 1612
Host: api.mespas.com

{
  "offerTerms" : {
    "referenceNumber" : "1a3e54fc-bc2b-4e97-a121-930256c63888",
    "currency" : "USD",
    "validUntil" : "2023-05-09",
    "paymentTerms" : "only cash",
    "remark" : "remark to offer terms"
  },
  "deliveryTerms" : {
    "deliveryDate" : null,
    "deliveryDateRemark" : "one week",
    "incoterm" : "CFR",
    "deliveryCountry" : "NO",
    "deliveryCity" : "Kirkeness"
  },
  "contact" : {
    "firstName" : "John",
    "lastName" : "Doe",
    "phone" : "+41 44 520 1030",
    "email" : "john@mail.mail"
  },
  "request" : {
    "id" : "ff80818187b7df1f0187b80ce7a10eb3"
  },
  "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",
    "component" : {
      "id" : null,
      "name" : "TYPE: S 967 SERIAL NO.:4226402/2013 440V 60HZ RECOMMENDED MOTOR POWER 21KW MAKER: ALFA LAVAL (JIANG ",
      "execution" : "2234121 40/DWG.NO.2052N",
      "identifications" : [ "P90806-0089 22" ]
    }
  } ],
  "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

contact.firstName

String

First name of the person responsible for this offer.

contact.lastName

String

Last name of the person responsible for this offer.

contact.phone

String

Phone number of the person responsible for this offer.

contact.email

String

Email of the person responsible for this offer.

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.

items[].component

Object

The component description - only required for additional offer items whithout corresponding request item. The 'Add Item' functionality is not available per default. Please contact our support team in case you are interested in that feature.

items[].component.id

Null

Internal use only (empty)

items[].component.name

String

The component’s name

items[].component.execution

String

The component’s execution

items[].component.identifications

Array

Your identification values (such as part-no, item-no,..)

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
Content-Length: 162
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

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

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 (single)

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

Http Request

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

Http Request Body

Http Response

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

{
  "id" : "fc1a5efce82d11e4b02c1681e6b88ec1",
  "offer" : {
    "id" : "1f5b1fd39e994cd2931a196af22c1db9",
    "reference" : "OFFER-1"
  },
  "status" : "CONFIRMED",
  "buyer" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
      "name" : "Buyer Inc",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "coName" : "",
        "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"
      }
    }
  },
  "supplier" : {
    "company" : {
      "type" : "MESPAS",
      "id" : "49517a98021b4353b08daddcc19a394a",
      "name" : "MESPAS Poland",
      "web" : null,
      "vatNumber" : null,
      "vatText" : null,
      "eoriNumber" : null,
      "address" : {
        "coName" : null,
        "street1" : "Rynek Glowny 6",
        "street2" : "Old City",
        "postbox" : "112233",
        "state" : "malopolskie",
        "zip" : "33-100",
        "city" : "Krakow",
        "country" : "PL"
      },
      "telco" : {
        "phone" : null,
        "mobile" : null,
        "fax" : null
      }
    },
    "contact" : {
      "firstName" : "Daniel",
      "lastName" : "Gsponer",
      "email" : "admin@mespas.com",
      "telco" : {
        "phone" : "+41 44 520 10 44",
        "mobile" : "+41 79 209 11 22",
        "fax" : null
      }
    }
  },
  "invoiceDetails" : {
    "company" : {
      "type" : "OTHER",
      "id" : null,
      "name" : "ULTIMATE FREEDOM Co & KG",
      "web" : null,
      "vatNumber" : "CHE 123.456.789",
      "vatText" : "VAT text",
      "eoriNumber" : "CH987654312000",
      "address" : {
        "coName" : "Naizen Shipping",
        "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" : {
        "coName" : "",
        "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" : "+41 44 271 0320",
    "remark" : "Warehouse at pier 7"
  },
  "orderTerms" : {
    "referenceNumber" : "O-2007-GER-00013/01/01",
    "currency" : "CHF",
    "paymentTerms" : "On delivery",
    "remark" : "Please handle with care",
    "orderDate" : "2015-02-11"
  },
  "deliveryTerms" : {
    "deliveryDate" : "2018-06-28",
    "deliveryDateRemark" : "2 weeks after order",
    "incoterm" : "FAS"
  },
  "vessel" : {
    "name" : "ULTIMATE FREEDOM",
    "imo" : "9212759"
  },
  "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" : "Operating System",
      "value" : "Cargo hold #1"
    }, {
      "name" : "Operating System",
      "value" : "Cargo hold #1"
    }, {
      "name" : "Location",
      "value" : "Power supply"
    }, {
      "name" : "Location",
      "value" : "Aft Engine Room"
    }, {
      "name" : "Warranty Alarm [days]",
      "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" : "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
    }, {
      "name" : "Speed CMCR [rpm]",
      "value" : "1000"
    } ]
  },
  "portStay" : {
    "portName" : "Hong Kong",
    "portCode" : "HK HKG",
    "portCountry" : "CN",
    "arrivalDate" : "2018-06-28 20:00",
    "departureDate" : "2018-07-01 04:00",
    "ownerAgentInfo" : "HELVETIC MARINE SERVICES",
    "chartererAgentInfo" : null
  },
  "deliveryOnBoard" : {
    "country" : "CN",
    "portName" : "Hong Kong",
    "portCode" : "HK HKG",
    "city" : null,
    "arrivalDate" : "2018-06-28",
    "timeZone" : "Asia/Hong_Kong",
    "remark" : "Delivery on board is 3 hours after arrival"
  },
  "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"
      } ],
      "primaryIdentificationValue" : "2722/A104",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "3301/A105",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "3401/A108",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "3425/A002",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "2701/A098",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "2724/A004",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "2722/A107",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "1001/A231",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "6701/A104",
      "secondaryIdentificationValue" : null
    }
  }, {
    "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"
      } ],
      "primaryIdentificationValue" : "9323/A202",
      "secondaryIdentificationValue" : null
    }
  } ]
}

Http Response Fields

Path Type Description

vessel

Object

The vessel associated with the order

portStay

Object

The port stay information of the vessel at the point in time the order has been created. Maybe null.

deliveryOnBoard

Object

The planned delivery on bord information at the point in time the order has been created. Maybe null.

buyer

Object

Information about the buyer that ordered

supplier

Object

Information about the supplier company that received the order

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.coName

String

c/o (care of) recipient (optional)

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)

portStay.portName

String

The name of the port (mandatory).

portStay.portCode

String

The UN/LOCODE port code (mandatory).

portStay.portCountry

String

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

portStay.arrivalDate

String

The expected date/time of arrival in the local time of the port (optional).

portStay.departureDate

String

The expected date/time of departure in the local time of the port (optional).

portStay.ownerAgentInfo

String

Owner agent info (optional).

portStay.chartererAgentInfo

Null

Charterer agent info (optional).

deliveryOnBoard.country

String

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

deliveryOnBoard.portName

String

The name of the port (optional).

deliveryOnBoard.portCode

String

The UN/LOCODE port code (optional).

deliveryOnBoard.city

Null

The name of the city (either port or city are defined) (optional).

deliveryOnBoard.arrivalDate

String

The planned arrival date (optional).

deliveryOnBoard.timeZone

String

The time zone related to the arrival date (optional)

deliveryOnBoard.remark

String

Remark related with the planned delivery on board of the goods (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.primaryIdentificationValue

String

The primary identification value

items[].component.secondaryIdentificationValue

Null

The secondary identification value

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
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 873

{
  "data" : [ {
    "id" : "fc1a5efce82d11e4b02c1681e6b88ec1",
    "referenceNumber" : "O-2007-GER-00013/01/01",
    "status" : "CONFIRMED",
    "buyer" : {
      "company" : {
        "type" : "MESPAS",
        "id" : "76fd6e311cbb4c3b9500bfe8ed41ef1e",
        "name" : "Buyer Inc",
        "web" : null,
        "vatNumber" : null,
        "vatText" : null,
        "eoriNumber" : null,
        "address" : {
          "coName" : null,
          "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-10"
  } ],
  "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/ff80818187b7df1f0187b80cd8330e80/reject HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Content-Length: 35
Host: api.mespas.com

{ "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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 84
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "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/ff80818187b7df1f0187b80cd7180e76/confirm HTTP/1.1
Accept: application/json
Content-Length: 43
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Host: api.mespas.com

{ "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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 84
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "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)

Order modification

Send order modification

Allows you to send a modification (modified order) as response to a received order.

Pricing and Price Calculation Rules

See Total Price (Calculation Rules)

Http Request

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

{
  "orderTerms" : {
    "referenceNumber" : "c34fbf93-903d-40fe-8ea3-d73d9b1e777c",
    "currency" : "USD",
    "paymentTerms" : "only cash",
    "remark" : "remark to offer terms"
  },
  "deliveryTerms" : {
    "deliveryDate" : null,
    "deliveryDateRemark" : "one week",
    "incoterm" : "CFR"
  },
  "pricings" : {
    "discount" : "10.00",
    "transportCost" : "2000.00",
    "insuranceCost" : "1000.00",
    "packagingCost" : "3000.00",
    "otherCost" : null,
    "vat" : "8.00"
  },
  "order" : {
    "id" : "ff80818187b7df1f0187b80cd94e0e8a"
  },
  "items" : [ {
    "quality" : null,
    "position" : "1",
    "remark" : "Best quality requested",
    "quantity" : "30.000",
    "unit" : "PIECE",
    "discount" : "50.00",
    "pricePerUnit" : "150.0000",
    "unitConversionRate" : "1.00",
    "component" : {
      "id" : null,
      "name" : "TYPE: S 967 SERIAL NO.:4226402/2013 440V 60HZ RECOMMENDED MOTOR POWER 21KW MAKER: ALFA LAVAL (JIANG YIN) MANUFACTURING CO; LTD O-RING O-RING",
      "execution" : "2234121 40/DWG.NO.2052N",
      "identifications" : [ "P90806-0089 22" ]
    }
  } ]
}

Http Request Parameter

None

Http Request Body

See Http Request

Http Request Fields

Path Type Description

order.id

String

The order id that the order modification relates to (mandatory). 32 characters uuid.

orderTerms.referenceNumber

String

Order modification reference number (optional)

orderTerms.currency

String

Currency (optional). See Enum Values (Currencies)

orderTerms.paymentTerms

String

Your payment terms (optional)

orderTerms.remark

String

General order modification remark (optional)

deliveryTerms.deliveryDate

Null

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

deliveryTerms.deliveryDateRemark

String

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

deliveryTerms.incoterm

String

Your Incoterm. See Enum Values (Incoterms)

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

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

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 component description - only required for additional offer items whithout corresponding request item. The 'Add Item' functionality is not available per default. Please contact our support team in case you are interested in that feature.

items[].component.id

Null

Internal use only (empty)

items[].component.name

String

The component’s name

items[].component.execution

String

The component’s execution

items[].component.identifications

Array

Your identification values (such as part-no, item-no,..)

Http Response

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

{
  "status" : "SUCCESS",
  "code" : "SUCCESS",
  "message" : null,
  "data" : [ {
    "key" : "orderModificationId",
    "value" : "ff80818187b7df1f0187b80cdb3d0e99"
  } ]
}

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

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
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Host: api.mespas.com

Http Request Parameter

Parameter Description

last_received

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

Http Response

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

[ {
  "eventId" : 1,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "11c78e43f82b4da0ba7cd37d13ea3242"
}, {
  "eventId" : 2,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "fc1a5efce82d11e4b02c1681e6b88ec1"
}, {
  "eventId" : 3,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "11c78e43f82b4da0ba7cd37d13ea3242"
}, {
  "eventId" : 4,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809da760002"
}, {
  "eventId" : 5,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809ed890009"
}, {
  "eventId" : 6,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f0c203f6"
}, {
  "eventId" : 7,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f1e003fd"
}, {
  "eventId" : 8,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f2c90404"
}, {
  "eventId" : 9,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f3ac040b"
}, {
  "eventId" : 10,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f47b0412"
}, {
  "eventId" : 11,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f54e0419"
}, {
  "eventId" : 12,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f61b0420"
}, {
  "eventId" : 13,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f6e70427"
}, {
  "eventId" : 14,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f7d0042e"
}, {
  "eventId" : 15,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f8960435"
}, {
  "eventId" : 16,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809f96f043c"
}, {
  "eventId" : 17,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809fa370443"
}, {
  "eventId" : 18,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809fb15044a"
}, {
  "eventId" : 19,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809fc190451"
}, {
  "eventId" : 20,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809fd06045c"
}, {
  "eventId" : 21,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b809fdd00463"
}, {
  "eventId" : 22,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b809fef4046d"
}, {
  "eventId" : 23,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80a00170477"
}, {
  "eventId" : 24,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80a01930481"
}, {
  "eventId" : 25,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80a02ff048b"
}, {
  "eventId" : 26,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a03db0495"
}, {
  "eventId" : 27,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a03db0495"
}, {
  "eventId" : 28,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a055c049d"
}, {
  "eventId" : 29,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a069204a4"
}, {
  "eventId" : 30,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80a07b004ab"
}, {
  "eventId" : 31,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a089404b5"
}, {
  "eventId" : 32,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a0b9104bc"
}, {
  "eventId" : 33,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80a0ee604c3"
}, {
  "eventId" : 34,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80a105d04cd"
}, {
  "eventId" : 35,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80a11a404d7"
}, {
  "eventId" : 36,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a125c04e1"
}, {
  "eventId" : 37,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a136804e8"
}, {
  "eventId" : 38,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80a145004ef"
}, {
  "eventId" : 39,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80bad1c04f6"
}, {
  "eventId" : 40,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80bdf5e0516"
}, {
  "eventId" : 41,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c62000cee"
}, {
  "eventId" : 42,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c6df00d0b"
}, {
  "eventId" : 43,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c72d20d17"
}, {
  "eventId" : 44,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c74ad0d1e"
}, {
  "eventId" : 45,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c76360d25"
}, {
  "eventId" : 46,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c77b20d2c"
}, {
  "eventId" : 47,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c79300d33"
}, {
  "eventId" : 48,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c82a20d44"
}, {
  "eventId" : 49,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c840e0d4b"
}, {
  "eventId" : 50,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c88ea0d57"
}, {
  "eventId" : 51,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c8e950d64"
}, {
  "eventId" : 52,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c8ff60d6b"
}, {
  "eventId" : 53,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c91660d72"
}, {
  "eventId" : 54,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80c92f50d79"
}, {
  "eventId" : 55,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80ca1a70da7"
}, {
  "eventId" : 56,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80ca1a70da7"
}, {
  "eventId" : 57,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80ca35b0daf"
}, {
  "eventId" : 58,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80ca5a40dbd"
}, {
  "eventId" : 59,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80ca6b60dc4"
}, {
  "eventId" : 60,
  "eventType" : "ORDER_CANCELLED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80ca6b60dc4"
}, {
  "eventId" : 61,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80ca8860dcf"
}, {
  "eventId" : 62,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80cafb60dec"
}, {
  "eventId" : 63,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80cb8120e14"
}, {
  "eventId" : 64,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80cbcb70e26"
}, {
  "eventId" : 65,
  "eventType" : "REQUEST_CANCELLED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80cbcb70e26"
}, {
  "eventId" : 66,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80cc1080e36"
}, {
  "eventId" : 67,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80cc7a50e4b"
}, {
  "eventId" : 68,
  "eventType" : "ORDER_CREATED",
  "entityType" : "ORDER",
  "entityId" : "ff80818187b7df1f0187b80cc8e40e52"
}, {
  "eventId" : 69,
  "eventType" : "REQUEST_CREATED",
  "entityType" : "QUOTE_REQUEST",
  "entityId" : "ff80818187b7df1f0187b80ccd030e63"
} ]

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/ff80818187b7dd6d0187b80cdeb9001c HTTP/1.1
Accept: application/octet-stream
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6ImZmODA4MDgxNWQwOGRhODUwMTVkMDhkZGNjZTMwMDAwIiwiZXhwIjozNjQ2NTc1OTg2LCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiI2ZWM2NTMwYS0yMzk4LTQ1YTktOTU0MS0yZTUzYThiOGI5MTMiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.UXqY1ZHJRNsM5tPKv7fZOZk2-PCAXOxaI5ffsvys0Ws
Host: api.mespas.com

Http Request Body

Http Response

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

Delivery dates are estimates only and are not granted

Http Response Body

Delivery dates are estimates only and are not granted

Forms

Get Form data

Returns multiple form data.

Http Request

GET /api/rest/r5/v1/form-data?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 4153

{
  "data" : [ {
    "lastModifiedDate" : "2023-01-20 13:17",
    "description" : "MRV Departure report",
    "installationName" : "Kine (MS A1)",
    "recordedBy" : "Jack Thomson",
    "lastChangedBy" : "Paul Philips",
    "lastChangedTime" : "2023-01-20",
    "recordingDate" : "2023-01-19",
    "formDataNumber" : "23-XX-OFFICE-001",
    "documentNumber" : "1/01/2023",
    "eventDate" : "2023-01-12",
    "isFinal" : true,
    "data" : [ {
      "fieldName" : "LNG",
      "value" : "130"
    }, {
      "fieldName" : "UNIT_PORT_TIME",
      "value" : "hh:mm"
    }, {
      "fieldName" : "UNIT_LNG",
      "value" : "mt"
    }, {
      "fieldName" : "HFO",
      "value" : "90"
    }, {
      "fieldName" : "UNIT_HFO",
      "value" : "mt"
    }, {
      "fieldName" : "LABEL_PORT_DATE",
      "value" : "Date of Departure"
    }, {
      "fieldName" : "MDO",
      "value" : "150"
    }, {
      "fieldName" : "UNIT_MDO",
      "value" : "mt"
    }, {
      "fieldName" : "PORT_TIME",
      "value" : "11:30"
    }, {
      "fieldName" : "TIMEZONE",
      "value" : "0"
    }, {
      "fieldName" : "INSTRUCTION",
      "value" : "Below Data to be filled as from LAST NOON REPORT Record. \\nIn case you have not filled in any Noon Reprot for last 24 hrs, please do now."
    }, {
      "fieldName" : "PS_SUPPLIES",
      "value" : "Off"
    }, {
      "fieldName" : "COMPANY_NAME",
      "value" : "Buyer Company A"
    }, {
      "fieldName" : "LABEL_MASTER",
      "value" : "Master"
    }, {
      "fieldName" : "LABEL_PORT_STAY",
      "value" : "Port Stay Reason"
    }, {
      "fieldName" : "LABEL_PORT_TIME",
      "value" : "Time of Departure"
    }, {
      "fieldName" : "LABEL_INSTALLATION_NAME",
      "value" : "Vessel Name"
    }, {
      "fieldName" : "MASTER",
      "value" : "Jack Masterson"
    }, {
      "fieldName" : "SUBMIT_TYPE",
      "value" : "BUTTON_FINAL"
    }, {
      "fieldName" : "LABEL_PORT_NAME",
      "value" : "Name of Port"
    }, {
      "fieldName" : "PS_DRYDOCK",
      "value" : "Off"
    }, {
      "fieldName" : "LABEL_INSTALLATION_LLOYDS_NUMBER",
      "value" : "IMO Number:"
    }, {
      "fieldName" : "LABEL_PS1",
      "value" : "Loading or Unloading"
    }, {
      "fieldName" : "LABEL_CHIEF",
      "value" : "Chief Engineer"
    }, {
      "fieldName" : "LABEL_HFO",
      "value" : "HFO Consumption"
    }, {
      "fieldName" : "LABEL_PS4",
      "value" : "Repair"
    }, {
      "fieldName" : "LABEL_PS5",
      "value" : "Crew Change"
    }, {
      "fieldName" : "LABEL_PS2",
      "value" : "Supplies"
    }, {
      "fieldName" : "FORM_UPDATE_LISTENER_ID",
      "value" : "1"
    }, {
      "fieldName" : "LABEL_PS3",
      "value" : "Bunker"
    }, {
      "fieldName" : "LABEL_PS6",
      "value" : "Dry Dock"
    }, {
      "fieldName" : "PORT_NAME",
      "value" : "Singapore"
    }, {
      "fieldName" : "LABEL_MDO",
      "value" : "MDO Consumption"
    }, {
      "fieldName" : "UNIT_PORT_DATE",
      "value" : "dd.mm.yyyy"
    }, {
      "fieldName" : "LABEL_TIME_ZONE",
      "value" : "Timezone"
    }, {
      "fieldName" : "LABEL_COMPANY",
      "value" : "Company"
    }, {
      "fieldName" : "LABEL_LNG",
      "value" : "LNG Consumption"
    }, {
      "fieldName" : "PS_CREWCHANGE",
      "value" : "Off"
    }, {
      "fieldName" : "LABEL_INSTRUCTION",
      "value" : "Instruction"
    }, {
      "fieldName" : "PS_LOADING",
      "value" : "On"
    }, {
      "fieldName" : "UNIT_TIME_ZONE",
      "value" : "-12 .. +12"
    }, {
      "fieldName" : "CHIEF",
      "value" : "Chandler Engineerson"
    }, {
      "fieldName" : "MGO",
      "value" : "140"
    }, {
      "fieldName" : "LABEL_MGO",
      "value" : "MGO Consumption"
    }, {
      "fieldName" : "TITLE",
      "value" : "MRV - Port Departure Measurement Form"
    }, {
      "fieldName" : "PS_REPAIR",
      "value" : "Off"
    }, {
      "fieldName" : "PORT_DATE",
      "value" : "01/01/2023"
    }, {
      "fieldName" : "UNIT_MGO",
      "value" : "mt"
    }, {
      "fieldName" : "PS_BUNKER",
      "value" : "Off"
    } ]
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of forms

data.[].lastModifiedDate

String

Last modification date (mandatory)

data.[].description

String

Form description (optional)

data.[].installationName

String

Vessel name. Not present if form was created by the office (optional)

data.[].recordedBy

String

User name who recorded the form (mandatory)

data.[].lastChangedBy

String

User name who changed the form (mandatory)

data.[].lastChangedTime

String

Date when the form was last modified (mandatory)

data.[].recordingDate

String

Date when the form was created (mandatory)

data.[].formDataNumber

String

Form number (mandatory)

data.[].documentNumber

String

Document number (optional)

data.[].eventDate

String

Date of an event related to this form (mandatory)

data.[].isFinal

Boolean

Status of the form (mandatory)

data.[].data.[].

Array

Form data (optional)

data.[].data.[].fieldName

String

Field name (mandatory)

data.[].data.[].value

String

Field value (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Inspections

Get Inspections

Returns inspections.

Http Request

GET /api/rest/r5/v1/inspections?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 800
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "inspectionId" : "ff808181879f3bd70187a346aa4c0000",
    "imoNumber" : "9113367",
    "installationName" : "Kine (MS A1)",
    "inspectionReferenceNumber" : "1000",
    "creationDate" : "2013-05-24",
    "inspectionCountry" : "Hong Kong",
    "inspectionName" : "Inspection on MSA1",
    "inspectionType" : "Vetting Inspection",
    "inspectionRemark" : "Yearly ship inspection",
    "inspectionFromDate" : "2022-12-31",
    "inspectionToDate" : "2023-01-05",
    "nextInspection" : "2023-12-31",
    "inspectionPlace" : "Harbour in Hong Kong",
    "inspectingPerson" : "John Doe",
    "inspectingOrganization" : "Inspection Experts Inc.",
    "inspectedDepartment" : "Master",
    "inspectionAuthor" : "Jack Thomson"
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of inspections

data.[].inspectionId

String

Inspection identification (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (mandatory)

data.[].installationName

String

Vessel name (mandatory)

data.[].inspectionReferenceNumber

String

Inspection reference number (mandatory)

data.[].creationDate

String

Inspection creation date (mandatory)

data.[].inspectionCountry

String

Inspection country (mandatory)

data.[].inspectionName

String

Inspection name (mandatory)

data.[].inspectionType

String

Inspection type (mandatory)

data.[].inspectionRemark

String

InspectionRemark type (optional)

data.[].inspectionFromDate

String

Inspection start date (mandatory)

data.[].inspectionToDate

String

Inspection start end date (mandatory)

data.[].nextInspection

String

Next inspection date (optional)

data.[].inspectionPlace

String

Inspection place (mandatory)

data.[].inspectingPerson

String

Inspection person (mandatory)

data.[].inspectingOrganization

String

Inspection organisation (mandatory)

data.[].inspectedDepartment

String

Inspection department (optional)

data.[].inspectionAuthor

String

Inspection author (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Installations

Get Installations

Returns installations.

Http Request

GET /api/rest/r5/v1/installations?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1248

{
  "data" : [ {
    "lastModifiedDate" : "2023-04-21 12:44",
    "installationId" : "c4ca4238a0b923820dcc509a6f75849b",
    "installationName" : "Kine (MS A1)",
    "imoNumber" : "9113367",
    "installationOwner" : "OwnerBuyer Company C",
    "installationManager" : "Buyer Company A",
    "deadWeightTons" : 5000,
    "buildingNumber" : "100",
    "buildingYear" : 2008,
    "installationClass" : "LRS",
    "installationType" : "Tanker",
    "isStandard" : true,
    "commissioningDate" : "2022-04-20",
    "accountingNo" : "0002",
    "accountingId" : "123-A1",
    "portOfRegistry" : "Singapore",
    "callLetter" : "XXXXX",
    "grossTon" : 20000,
    "netTon" : 10000,
    "lengthOa" : "100.00",
    "lengthPp" : "100.00",
    "breathMld" : "15.00",
    "depthMld" : "8.00",
    "refTxt" : "MS-A1",
    "budgetStartMonth" : 4,
    "budgetStartDay" : 1,
    "vatNo" : "111111",
    "invoiceAddressId" : 6,
    "usesOwnerAddress" : false,
    "status" : "Active",
    "rootAccountNoId" : 999,
    "specHandlingFlag" : 0,
    "isInvisible" : false,
    "iceClassId" : "IA SUPER",
    "eedi" : "2.35",
    "flagState" : "Hong Kong",
    "itOpsMode" : "CUBE",
    "group" : "Group A"
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of installations

data.[].lastModifiedDate

String

Last modification date (mandatory)

data.[].installationId

String

Installation identification number (mandatory)

data.[].installationName

String

Installation name (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (mandatory)

data.[].installationOwner

String

Owner company name (mandatory)

data.[].installationManager

String

Manager user name (mandatory)

data.[].deadWeightTons

Number

Dead weight tons (optional)

data.[].buildingNumber

String

Building number (optional)

data.[].buildingYear

Number

Building year (mandatory)

data.[].installationClass

String

Installation class (mandatory)

data.[].installationType

String

Installation type (mandatory)

data.[].isStandard

Boolean

True or false (mandatory)

data.[].commissioningDate

String

The date of installation delivery (mandatory)

data.[].accountingNo

String

Accounting number (optional)

data.[].accountingId

String

Accounting identification (optional)

data.[].portOfRegistry

String

Port of registry (optional)

data.[].callLetter

String

Call letter (optional)

data.[].grossTon

Number

Gross tons (optional)

data.[].netTon

Number

Net tons (optional)

data.[].lengthOa

String

Length OA (optional)

data.[].lengthPp

String

Length PP (optional)

data.[].breathMld

String

Breath MLD (optional)

data.[].depthMld

String

Depth MLD (optional)

data.[].refTxt

String

Identifier used in the procurement module (optional)

data.[].budgetStartMonth

Number

Budget start month (optional)

data.[].budgetStartDay

Number

Budget start day (optional)

data.[].vatNo

String

VAT number (optional)

data.[].invoiceAddressId

Number

Invoice address identifier (optional)

data.[].usesOwnerAddress

Boolean

True or false (mandatory)

data.[].status

String

Installation status (mandatory)

data.[].rootAccountNoId

Number

Root account identification number (optional)

data.[].specHandlingFlag

Number

Special handling flag (mandatory)

data.[].isInvisible

Boolean

True or false (mandatory)

data.[].iceClassId

String

ICE class identification (optional)

data.[].eedi

String

EEDI (optional)

data.[].flagState

String

Flag state (optional)

data.[].itOpsMode

String

IT related operation model of the installation. See Enum Values (IT OPS Mode) (mandatory)

data.[].group

String

Installation group (optional)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Noon Reports

Get Noon Reports

Returns noon reports.

Http Request

GET /api/rest/r5/v1/noon-reports?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 2202
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "id" : "43",
    "vesselName" : "Kine (MS A1)",
    "imoNumber" : "9113367",
    "reportDate" : "2023-04-20 02:00",
    "lastModifiedDate" : "2023-04-21 14:53",
    "reportTime" : "1681948800",
    "reportTimeZone" : "00:00",
    "mandatorNumber" : "123-A1",
    "isDraft" : false,
    "dataList" : [ {
      "fieldId" : 1,
      "data" : "Rapperswil",
      "fieldName" : "Next Harbour"
    }, {
      "fieldId" : 4,
      "data" : "15",
      "fieldName" : "Wind speed"
    }, {
      "fieldId" : 5,
      "data" : "true",
      "fieldName" : "Clouds"
    }, {
      "fieldId" : 6,
      "data" : "21.04.2023",
      "fieldName" : "EDA next Port"
    }, {
      "fieldId" : 7,
      "data" : "11:00 pm",
      "fieldName" : "ETA (Local Time)"
    }, {
      "fieldId" : 8,
      "data" : "Blue",
      "fieldName" : "Favorite Color"
    }, {
      "fieldId" : 11,
      "data" : "0.90",
      "fieldName" : "Minimum Speed (SOG) [kt]"
    }, {
      "fieldId" : 12,
      "data" : "1.1",
      "fieldName" : "Average Speed (SOG) [kt]"
    }, {
      "fieldId" : 13,
      "data" : "1.80",
      "fieldName" : "Maximum Speed (SOG) [kt]"
    }, {
      "fieldId" : 14,
      "data" : "2.00",
      "fieldName" : "Virtual Speed"
    }, {
      "fieldId" : 16,
      "data" : "2.1",
      "fieldName" : "ROB LSFO [mt]"
    }, {
      "fieldId" : 17,
      "data" : "3.1",
      "fieldName" : "ROB HSFO [mt]"
    }, {
      "fieldId" : 18,
      "data" : "4.1",
      "fieldName" : "ROB MDO [mt]"
    }, {
      "fieldId" : 19,
      "data" : "01.01.2015",
      "fieldName" : "Report date (read-only)"
    }, {
      "fieldId" : 254,
      "data" : "5.1",
      "fieldName" : "Main Engine HFO Consumption [mt] at sea"
    }, {
      "fieldId" : 255,
      "data" : "6.1",
      "fieldName" : "Main Engine MDO Consumption [mt] at sea"
    }, {
      "fieldId" : 274,
      "data" : "-5.00000000",
      "fieldName" : "Longitude"
    }, {
      "fieldId" : 275,
      "data" : "45.00000000",
      "fieldName" : "Latitude"
    }, {
      "fieldId" : 276,
      "data" : "Sailing",
      "fieldName" : "Vessel Status"
    } ]
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of noon reports

data.[].id

String

Noon report identification number (mandatory)

data.[].vesselName

String

Vessel name (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (mandatory)

data.[].reportDate

String

Noon report creation date (mandatory)

data.[].lastModifiedDate

String

Last modification date (mandatory)

data.[].reportTime

String

Noon report creation date as UNIX timestamp (mandatory)

data.[].reportTimeZone

String

Time zone (mandatory)

data.[].mandatorNumber

String

Mandator number (mandatory)

data.[].isDraft

Boolean

True or false (mandatory)

data.[].dataList.[].

Array

Noon report data (optional)

data.[].dataList.[].fieldId

Number

Field identification number (mandatory)

data.[].dataList.[].fieldName

String

Field name (mandatory)

data.[].dataList.[].data

String

Field value (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Buyer Offers

Get Buyer Offers

Returns buyer offers.

Http Request

GET /api/rest/r5/v1/offers?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
Content-Length: 2052
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "lastModifiedDate" : "2023-04-21 14:53",
    "mespasOfferId" : 2,
    "requestReferenceNumber" : "O-2023-MS-A1-00201-D/01",
    "vesselName" : "Kine (MS A1)",
    "offerDate" : "2023-04-19",
    "offerReferenceNumber" : "Offer 0001",
    "supplierName" : "Supplier Company A",
    "productLabel" : "Washer A1",
    "productId" : 20,
    "productBrand" : "Electrolux",
    "productType" : "A-S160",
    "offerCurrency" : "CHF",
    "amount" : "4481.25",
    "amountPacking" : "15.00",
    "rebate" : "10.00",
    "amountTransport" : "15.00",
    "otherCost" : "59.00",
    "area" : "Engine Repaires",
    "description" : "Procurement case subject",
    "offerState" : "ordered",
    "offerNote" : "Offer note",
    "items" : [ {
      "positionNumber" : 1,
      "componentDescription" : "Front Panel",
      "componentExecution" : "Complete, Yellow",
      "componentRemark" : "Offer item important remark",
      "quantityOffered" : "1.00",
      "quantityApproved" : "1.00",
      "quantityOfferedUnit" : "pcs.",
      "quantityRequested" : "1.00",
      "quantityRequestedUnit" : "pcs.",
      "unitConversionRate" : "0.10",
      "rob" : "200.00",
      "robUnit" : "pcs.",
      "pricePerUnit" : "125.00",
      "rebate" : "15.00",
      "sumPrice" : "106.25",
      "componentSpecification1" : "4729904-69",
      "componentSpecificationHeader1" : "Part No.",
      "componentSpecification2" : "01",
      "componentSpecificationHeader2" : "Item No.",
      "componentSpecification3" : "Spec 1",
      "componentSpecificationHeader3" : "Spec header 3",
      "componentSpecification4" : "Spec 4",
      "componentSpecificationHeader4" : "Spec header 4",
      "componentSpecification5" : "Spec 5",
      "componentSpecificationHeader5" : "Spec header 5",
      "componentSpecification6" : "Spec 6",
      "componentSpecificationHeader6" : "Spec header 6",
      "componentSpecification7" : "Spec 7",
      "componentSpecificationHeader7" : "Spec header 7"
    } ]
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of offers

data.[].lastModifiedDate

String

Last modification date (mandatory)

data.[].mespasOfferId

Number

Offer identification number (mandatory)

data.[].requestReferenceNumber

String

Request reference number (mandatory)

data.[].vesselName

String

Vessel name (mandatory)

data.[].offerDate

String

Offer creation date (optional)

data.[].offerReferenceNumber

String

Supplier reference number (optional)

data.[].supplierName

String

Supplier company name (mandatory)

data.[].productLabel

String

Product label (mandatory)

data.[].productId

Number

Product identification number (mandatory)

data.[].productId

Number

Product identification number (mandatory)

data.[].productBrand

String

Product brand name (mandatory)

data.[].productType

String

Product type name (mandatory)

data.[].offerCurrency

String

Currency (mandatory). See Enum Values (Currencies)

data.[].amount

String

Total amount (mandatory)

data.[].amountPacking

String

Amount of packaging cost (optional)

data.[].rebate

String

Total discount in percent (optional)

data.[].amountTransport

String

Amount of transport cost (optional)

data.[].otherCost

String

Amount of other costs (optional)

data.[].area

String

Area (optional)

data.[].description

String

Offer description (optional)

data.[].offerState

String

Offer state (mandatory). See Enum Values (Buyer Offer States)

data.[].offerNote

String

Offer note (optional)

data.[].items.[].

Array

Offer items (optional)

data.[].items.[].positionNumber

Number

Offer item position (optional)

data.[].items.[].componentDescription

String

Component description (optional)

data.[].items.[].componentExecution

String

Component execution (optional)

data.[].items.[].componentRemark

String

Component remark (optional)

data.[].items.[].quantityOffered

String

Offered quantity (mandatory)

data.[].items.[].quantityOfferedUnit

String

Offered quantity unit (mandatory). See Enum Values (Units)

data.[].items.[].quantityApproved

String

Quantity approved

data.[].items.[].quantityRequested

String

Requested quantity unit (optional)

data.[].items.[].quantityRequestedUnit

String

Requested quantity unit (optional). See Enum Values (Units)

data.[].items.[].unitConversionRate

String

Unit conversion rate (optional)

data.[].items.[].rob

String

Items remaining on board (optional)

data.[].items.[].robUnit

String

Unit of items remaining on board (optional). See Enum Values (Units)

data.[].items.[].pricePerUnit

String

Price per unit (optional)

data.[].items.[].rebate

String

Item discount in percent (optional)

data.[].items.[].sumPrice

String

Total price for item (optional)

data.[].items.[].componentSpecification1

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader1

String

Component specification header (optional)

data.[].items.[].componentSpecification2

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader2

String

Component specification header (optional)

data.[].items.[].componentSpecification3

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader3

String

Component specification header (optional)

data.[].items.[].componentSpecification4

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader4

String

Component specification header (optional)

data.[].items.[].componentSpecification5

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader5

String

Component specification header (optional)

data.[].items.[].componentSpecification6

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader6

String

Component specification header (optional)

data.[].items.[].componentSpecification7

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader7

String

Component specification header (optional)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Buyer Orders

Get Buyer Orders

Returns buyer orders.

Http Request

GET /api/rest/r5/v1/orders?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 3403
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "mespasOrderId" : "4",
    "lastModifiedDate" : "2023-02-01 09:46",
    "mandatorNumber" : "123-A2",
    "imoNumber" : "9162526",
    "orderNumber" : "HKT-A2-2023-00001-01",
    "referenceNumber" : "O-2023-A2-00001-D/~/01",
    "ownersCode" : "XXX-XX",
    "creditorNumber" : "BuyA/SuppA",
    "accountingNumber" : "0002",
    "budgetPeriod" : 2023,
    "parentAccountLevel" : "9",
    "accountLevel" : "10",
    "creditNoteAccountingNumber" : "0003",
    "amountItem" : 201.96,
    "rebate" : 0.0,
    "amountAfterRebate" : 201.96,
    "amountFreight" : 2.0,
    "amountPacking" : 2.0,
    "amountInsurance" : 2.0,
    "freePos1Name" : "Custom Fee",
    "amountPos1" : 4.0,
    "freePos2Name" : "Phone Cost",
    "amountPos2" : 1.0,
    "vat" : 8.0,
    "prepayment" : 99.0,
    "amount" : 230.0,
    "orderAmountConverted" : 230.0,
    "orderAmountConvertedCurrency" : "EUR",
    "amountWithoutFreight" : 10.0,
    "amountItemDelivered" : 10.0,
    "currency" : "EUR",
    "invoicedAmountConverted" : 230,
    "invoiceAmountConvertedCurrency" : "50",
    "accrual" : 230.0,
    "accrualCurrency" : "EUR",
    "cancelled" : false,
    "approvedBy" : "John Doe",
    "allInvoiceReceived" : true,
    "area" : "Engine Repaires",
    "description" : "Procurement case remark",
    "subject" : "Procurement case subject",
    "orderDate" : "2023-01-22",
    "manualCaseStatus" : "Blue",
    "caseOwner" : "A1 Buyer",
    "orderSender" : "Jeremy Bean",
    "caseClosed" : false,
    "orderYear" : 2023,
    "commissionType" : "Base",
    "commissionTypeValue" : 10.0,
    "effectiveDeliveryDate" : "2023-02-01",
    "allReceived" : true,
    "partialDeliveryNoted" : false,
    "productCategoryName" : "Laundry",
    "productLabel" : "Washer A2",
    "productBrandName" : "Electrolux",
    "productTypeName" : "A-S160",
    "productBuilderName" : "Product Builder 6",
    "productFunction" : "Main Engine",
    "plannedDeliveryCountry" : "Kiribati",
    "plannedDeliveryPort" : "Teraina Harbour",
    "plannedDeliveryCity" : "Teraina",
    "plannedDeliveryDate" : "2023-02-01",
    "plannedDeliveryRemark" : "Important delivery remark",
    "items" : [ {
      "componentDescription" : "Front Panel",
      "componentExecution" : "Complete, Green",
      "remark" : "Order item important remark",
      "positionNumber" : 1,
      "quantityOrdered" : 1.0,
      "quantityUnit" : "pcs.",
      "quantityReceived" : 1.0,
      "dateReceived" : "2023-01-01T08:51:24.000Z",
      "pricePerUnit" : 1.0,
      "sumPriceDelivered" : 0.99,
      "rebate" : 1.0,
      "sumPrice" : 0.99,
      "receptionRemark" : "Important reception remark",
      "componentSpecification1" : "4729904-69",
      "componentSpecification2" : "01",
      "componentSpecification3" : "4729904-69",
      "componentSpecification4" : "01",
      "componentSpecification5" : "Spec 5",
      "componentSpecification6" : "Spec 6",
      "componentSpecification7" : "Spec 7",
      "componentSpecificationHeader1" : "Spec 1",
      "componentSpecificationHeader2" : "Spec 2",
      "componentSpecificationHeader3" : "Part No.",
      "componentSpecificationHeader4" : "Item No.",
      "componentSpecificationHeader5" : "Spec header 5",
      "componentSpecificationHeader6" : "Spec header 6",
      "componentSpecificationHeader7" : "Spec header 7"
    } ]
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of orders

data.[].mespasOrderId

String

Order identification number (mandatory)

data.[].lastModifiedDate

String

Last modification date (mandatory)

data.[].mandatorNumber

String

Mandator number (mandatory)

data.[].orderNumber

String

Order number (optional)

data.[].referenceNumber

String

Reference number (mandatory)

data.[].ownersCode

String

Owners code (optional)

data.[].creditorNumber

String

Creditor number (mandatory)

data.[].accountingNumber

String

Accounting number (mandatory)

data.[].budgetPeriod

Number

Accounting budget period (optional)

data.[].parentAccountLevel

String

Parent account level (optional)

data.[].accountLevel

String

Account level (optional)

data.[].creditNoteAccountingNumber

String

Credit note accounting number (optional)

data.[].amountItem

Number

Amount item (mandatory)

data.[].rebate

Number

Discount (optional)

data.[].amountAfterRebate

Number

Amount after rebate (mandatory)

data.[].amountFreight

Number

Amount freight (optional)

data.[].amountPacking

Number

Amount packing (optional)

data.[].amountInsurance

Number

Amount insurance (optional)

data.[].freePos1Name

String

Free pos 1 name (optional)

data.[].amountPos1

Number

Amount pos 1 (optional)

data.[].freePos2Name

String

Free pos 2 name (optional)

data.[].amountPos2

Number

Amount pos 2 (optional)

data.[].vat

Number

Vat (optional)

data.[].prepayment

Number

Prepayment (optional)

data.[].amount

Number

Amount (mandatory)

data.[].orderAmountConverted

Number

Order amount converted (mandatory)

data.[].orderAmountConvertedCurrency

String

Order amount converted currency (mandatory). See Enum Values (Currencies)

data.[].amountWithoutFreight

Number

Amount without freight (optional)

data.[].amountItemDelivered

Number

Amount item delivered (optional)

data.[].currency

String

Currency (mandatory). See Enum Values (Currencies)

data.[].invoicedAmountConverted

Number

Invoiced amount converted (optional)

data.[].invoiceAmountConvertedCurrency

String

Invoice amount converted currency (optional). See Enum Values (Currencies)

data.[].accrual

Number

Accrual (mandatory)

data.[].accrualCurrency

String

Accrual currency (mandatory). See Enum Values (Currencies)

data.[].cancelled

Boolean

Cancelled (mandatory)

data.[].approvedBy

String

Approved by (optional)

data.[].allInvoiceReceived

Boolean

All invoice received (mandatory)

data.[].area

String

Area (optional)

data.[].description

String

Description (optional)

data.[].subject

String

Subject (optional)

data.[].orderDate

String

Order date (optional)

data.[].manualCaseStatus

String

Manual case status (optional)

data.[].caseOwner

String

Case owner (optional)

data.[].orderSender

String

Order sender (mandatory)

data.[].caseClosed

Boolean

Case closed (mandatory)

data.[].orderYear

Number

Order year (optional)

data.[].commissionType

String

Commission type (optional)

data.[].commissionTypeValue

Number

Commission type value (optional)

data.[].effectiveDeliveryDate

String

Effective delivery date (optional)

data.[].allReceived

Boolean

All received (mandatory)

data.[].partialDeliveryNoted

Boolean

Partial delivery noted (mandatory)

data.[].productCategoryName

String

Product category name (mandatory)

data.[].productLabel

String

Product label (mandatory)

data.[].productBrandName

String

Product brand name (mandatory)

data.[].productTypeName

String

Product type name (mandatory)

data.[].productBuilderName

String

Product builder name (mandatory)

data.[].productFunction

String

Product function (mandatory)

data.[].plannedDeliveryCountry

String

Planned delivery country (optional)

data.[].plannedDeliveryPort

String

Planned delivery port (optional)

data.[].plannedDeliveryCity

String

Planned delivery city (optional)

data.[].plannedDeliveryDate

String

Planned delivery date (optional)

data.[].plannedDeliveryRemark

String

Planned delivery remark (optional)

data.[].items.[].

Array

Order items (optional)

data.[].items.[].componentDescription

String

Component description (optional)

data.[].items.[].componentExecution

String

Component execution (optional)

data.[].items.[].remark

String

Remark (optional)

data.[].items.[].positionNumber

Number

Position number (optional)

data.[].items.[].quantityOrdered

Number

Quantity ordered (mandatory)

data.[].items.[].quantityUnit

String

Quantity unit (mandatory). See Enum Values (Units)

data.[].items.[].quantityReceived

Number

Quantity received (optional)

data.[].items.[].dateReceived

String

Date received (optional)

data.[].items.[].pricePerUnit

Number

Price per unit (optional)

data.[].items.[].sumPriceDelivered

Number

Sum price delivered (optional)

data.[].items.[].rebate

Number

Rebate (optional)

data.[].items.[].sumPrice

Number

Sum price (optional)

data.[].items.[].componentSpecification1

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader1

String

Component specification header (optional)

data.[].items.[].componentSpecification2

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader2

String

Component specification header (optional)

data.[].items.[].componentSpecification3

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader3

String

Component specification header (optional)

data.[].items.[].componentSpecification4

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader4

String

Component specification header (optional)

data.[].items.[].componentSpecification5

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader5

String

Component specification header (optional)

data.[].items.[].componentSpecification6

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader6

String

Component specification header (optional)

data.[].items.[].componentSpecification7

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader7

String

Component specification header (optional)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Overhauls

Get Overhauls

Returns overhauls.

Http Request

GET /api/rest/r5/v1/overhauls?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Content-Length: 4405
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "lastModifiedDate" : "2023-04-24 12:37",
    "mespasOverhaulId" : "ff80818187b2a2020187b2d77f8d0000",
    "mespasPmsSettingId" : "9",
    "companyName" : "Buyer Company A",
    "updateDate" : "2022-12-31",
    "dateDone" : "2023-01-01",
    "runningHours" : "450.00",
    "dateDue" : "2023-01-14",
    "overdueTime" : 5,
    "reportedBy" : "A1 Chief",
    "jobCarriedOutBy" : "Thomas Jackson/Capitan",
    "isFinal" : true,
    "datePlanned" : "2023-01-01 11:40",
    "planningRemark" : "Important planning remark",
    "plannedBy" : "Thomas Jackson",
    "reasonForPlanning" : "Important reason",
    "planningAssessmentStatus" : "accepted",
    "planningAssessmentDate" : "2023-01-01 11:40",
    "planningAssessedBy" : "Thomas Jackson",
    "planningAssessmentRemark" : "Important assesment remark",
    "timeUsed" : "55.00",
    "numberOfPerson" : 15,
    "jobRemark" : "Important comment.",
    "partsUsed" : [ {
      "componentDescription" : "Company Spec. (A) Comp 4 Desc",
      "componentExecution" : "Execution 7",
      "brandName" : "Sulzer",
      "typeName" : "PT-001-1",
      "quantityUsed" : 1.0,
      "quantityUnit" : "pcs.",
      "componentSpecification1" : "Company Spec. (A) Comp 1 Spez.",
      "componentSpecificationHeader1" : "Spec header 1",
      "componentSpecification2" : "Spec 2",
      "componentSpecificationHeader2" : "Spec header 2",
      "componentSpecification3" : "Spec 3",
      "componentSpecificationHeader3" : "Spec header 3",
      "componentSpecification4" : "Spec 4",
      "componentSpecificationHeader4" : "Spec header 4",
      "componentSpecification5" : "Spec 5",
      "componentSpecificationHeader5" : "Spec header 5",
      "componentSpecification6" : "Spec 6",
      "componentSpecificationHeader6" : "Spec header 6",
      "componentSpecification7" : "Spec 7",
      "componentSpecificationHeader7" : "Spec header 7"
    } ],
    "vesselName" : "Kine (MS A1)",
    "mandatorNumber" : "123-A1",
    "imoNumber" : "9113367",
    "productOperationSystem" : "Power Supply",
    "productCategoryName" : "Engine",
    "productLabel" : "Main Engine A1",
    "isCriticalProduct" : false,
    "productBrandName" : "Sulzer",
    "productTypeName" : "PT-001-1",
    "productTagNumber" : "213703",
    "productSerialNumber" : "42-XXX",
    "productBuilderName" : "Product Builder 1",
    "productFunction" : "Main Engine",
    "productLocation" : "Cargo Hold #1",
    "productPosition" : "Port side",
    "componentName" : "Buyer Company A",
    "unit" : "1",
    "activity" : "500 hrs Inspection",
    "tboValue" : 1,
    "tboUnit" : "1",
    "tboValueRh" : 500,
    "alarmValue" : 2,
    "responsible" : "Capitan",
    "isClassRequired" : true,
    "isCritical" : true,
    "instruction" : "Important instruction",
    "department" : "Department",
    "activityKind" : "Inspection",
    "requiredTime" : "15.00",
    "requiredPerson" : 15,
    "isShoreRequired" : true,
    "shoreTime" : "10.00",
    "shorePerson" : 10,
    "classId" : " 00024",
    "regulation" : "Regulation",
    "ismNumber" : "XXX-XX",
    "data" : [ {
      "fieldName" : "carried_out_by",
      "value" : "John Doe"
    }, {
      "fieldName" : "date_of_execution",
      "value" : "2022-12-31"
    }, {
      "fieldName" : "form_publication_date",
      "value" : "2020-10-21 11:51:00"
    }, {
      "fieldName" : "form_revision",
      "value" : "1"
    }, {
      "fieldName" : "gate_check",
      "value" : "OK"
    }, {
      "fieldName" : "housing_tension_check",
      "value" : "OK"
    }, {
      "fieldName" : "installation_name",
      "value" : "Celebrity Eclipse (MS A2)"
    }, {
      "fieldName" : "is_critical",
      "value" : "Yes"
    }, {
      "fieldName" : "is_follow_up_required",
      "value" : "No"
    }, {
      "fieldName" : "job_carried_out_confirmation",
      "value" : "NOT_AVAILABLE"
    }, {
      "fieldName" : "location",
      "value" : "Aft Engine Room"
    }, {
      "fieldName" : "number_of_hours",
      "value" : "15,00"
    }, {
      "fieldName" : "organization_name",
      "value" : "Web Sourcing System Company"
    }, {
      "fieldName" : "power_supply_check",
      "value" : "NOK"
    }, {
      "fieldName" : "remark",
      "value" : "Important comment."
    }, {
      "fieldName" : "user_name",
      "value" : "Web-Integration User"
    } ]
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of overhauls

data.[].lastModifiedDate

String

Last modified date (mandatory)

data.[].mespasOverhaulId

String

Mespas overhaul id (mandatory)

data.[].mespasPmsSettingId

String

Mespas pms setting id (mandatory)

data.[].companyName

String

Company name (mandatory)

data.[].updateDate

String

Update date (mandatory)

data.[].dateDone

String

Date done (mandatory)

data.[].runningHours

String

Running hours (optional)

data.[].dateDue

String

Date due (mandatory)

data.[].overdueTime

Number

Overdue time (mandatory)

data.[].reportedBy

String

Reported by (mandatory)

data.[].jobCarriedOutBy

String

Job carried out by (mandatory)

data.[].isFinal

Boolean

Is final (mandatory)

data.[].datePlanned

String

Date planned (optional)

data.[].planningRemark

String

Planning remark (optional)

data.[].plannedBy

String

Planned by (optional)

data.[].reasonForPlanning

String

Reason for planning (optional)

data.[].planningAssessmentStatus

String

Planning assessment status (optional)

data.[].planningAssessmentDate

String

Planning assessment date (optional)

data.[].planningAssessedBy

String

Planning assessed by (optional)

data.[].planningAssessmentRemark

String

Planning assessment remark (optional)

data.[].timeUsed

String

Time used (optional)

data.[].numberOfPerson

Number

Number of person (optional)

data.[].jobRemark

String

Job remark (optional)

data.[].vesselName

String

Vessel name (mandatory)

data.[].mandatorNumber

String

Mandator number (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (optional)

data.[].productOperationSystem

String

Product operation system (optional)

data.[].productCategoryName

String

Product category name (optional)

data.[].productLabel

String

Product label (optional)

data.[].isCriticalProduct

Boolean

Is critical product (optional)

data.[].productBrandName

String

Product brand name (optional)

data.[].productTypeName

String

Product type name (optional)

data.[].productTagNumber

String

Product tag number (optional)

data.[].productSerialNumber

String

Product serial number (optional)

data.[].productBuilderName

String

Product builder name (optional)

data.[].productFunction

String

Product function (optional)

data.[].productLocation

String

Product location (optional)

data.[].productPosition

String

Product position (optional)

data.[].componentName

String

Component name (optional)

data.[].unit

String

Unit (optional). See Enum Values (Units)

data.[].activity

String

Activity (mandatory)

data.[].tboValue

Number

Tbo value (optional)

data.[].tboUnit

String

Tbo unit (optional). See Enum Values (Units)

data.[].tboValueRh

Number

Tbo value rh (optional)

data.[].alarmValue

Number

Alarm value (mandatory)

data.[].responsible

String

Responsible (optional)

data.[].isClassRequired

Boolean

Is class required (mandatory)

data.[].isCritical

Boolean

Is critical (mandatory)

data.[].instruction

String

Instruction (optional)

data.[].department

String

Department (optional)

data.[].activityKind

String

Activity kind (optional)

data.[].requiredTime

String

Required time (optional)

data.[].requiredPerson

Number

Required person (optional)

data.[].isShoreRequired

Boolean

Is shore required (mandatory)

data.[].shoreTime

String

Shore time (optional)

data.[].shorePerson

Number

Shore person (optional)

data.[].classId

String

Class id (optional)

data.[].regulation

String

Regulation (optional)

data.[].ismNumber

String

Ism number (optional)

data.[].partsUsed.[].

Array

Overhaul used parts (optional)

data.[].partsUsed.[].componentDescription

String

Component description (optional)

data.[].partsUsed.[].componentExecution

String

Component execution (optional)

data.[].partsUsed.[].brandName

String

Product brand name (optional)

data.[].partsUsed.[].typeName

String

Product type name (optional)

data.[].partsUsed.[].quantityUsed

Number

Quantity used (optional)

data.[].partsUsed.[].quantityUnit

String

Quantity unit (mandatory). See Enum Values (Units)

data.[].data.[].

Array

Overhaul data (optional)

data.[].data.[].fieldName

String

Field name (mandatory)

data.[].data.[].value

String

Field value (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

PMS Settings

Get PMS Settings

Returns PMS settings.

Http Request

GET /api/rest/r5/v1/pms-settings?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1129

{
  "data" : [ {
    "lastModifiedDate" : "2023-04-24 14:45",
    "pmsStatusId" : "1",
    "accountingId" : "123-A2",
    "installationId" : "2",
    "activityShortName" : "Inspect",
    "activityOther" : "Other activity name",
    "tboValue" : 2400,
    "tboUnit" : 1,
    "tboValueRh" : 100,
    "responsibleUserRoleShortName" : "Chief Engineer",
    "roleOther" : "Other role",
    "classRequired" : true,
    "classId" : "ClassID 12345",
    "installationName" : "Celebrity Eclipse (MS A2)",
    "tagNumber" : "a1",
    "erpId" : "xxx",
    "productLabel" : "Washer A2",
    "productBrand" : "1",
    "productType" : "A-S160",
    "critical" : true,
    "instruction" : "Please do it good!",
    "vesselDepartmentShortName" : "Vessel department",
    "activityKindShortName" : "Maintenance",
    "requiredTime" : 2,
    "requiredPersons" : "1",
    "shoreRequired" : true,
    "shoreTime" : 1,
    "shorePersons" : "1",
    "componentDescription" : "Front Panel",
    "componentUnit" : 1,
    "fixedDueDateMode" : true,
    "cronExpression" : "0 0 0 ? 1-12 3/7 *"
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of PMS settings

data.[].lastModifiedDate

String

Last modified date (mandatory)

data.[].pmsStatusId

String

Pms status id (mandatory)

data.[].accountingId

String

Accounting id (mandatory)

data.[].installationId

String

Installation id (mandatory)

data.[].activityShortName

String

Activity short name (conditional - mandatory if activityShortName is activityOther)

data.[].activityOther

String

Activity other (conditional - mandatory if activityShortName is empty)

data.[].tboValue

Number

Tbo value (optional)

data.[].tboUnit

Number

Tbo unit (optional). See Enum Values (Units)

data.[].tboValueRh

Number

Tbo value rh (optional)

data.[].responsibleUserRoleShortName

String

Responsible user role short name (optional)

data.[].roleOther

String

Role other (optional)

data.[].classRequired

Boolean

Class required (mandatory)

data.[].classId

String

Class id (optional)

data.[].installationName

String

Installation name (mandatory)

data.[].tagNumber

String

Tag number (optional)

data.[].erpId

String

Erp id (optional)

data.[].productLabel

String

Product label (optional)

data.[].productBrand

String

Product brand (optional)

data.[].productType

String

Product type (optional)

data.[].critical

Boolean

Critical (mandatory)

data.[].instruction

String

Instruction (optional)

data.[].vesselDepartmentShortName

String

Vessel department short name (optional)

data.[].activityKindShortName

String

Activity kind short name (optional)

data.[].requiredTime

Number

Required time (optional)

data.[].requiredPersons

String

Required persons (optional)

data.[].shoreRequired

Boolean

Shore required (mandatory)

data.[].shoreTime

Number

Shore time (optional)

data.[].shorePersons

String

Shore persons (optional)

data.[].componentDescription

String

Component description (optional)

data.[].componentUnit

Number

Component unit (optional). See Enum Values (Units)

data.[].fixedDueDateMode

Boolean

Fixed due date mode (optional)

data.[].cronExpression

String

Cron expression (optional)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

PMS Statistics

Get PMS Statistics

Returns PMS statistics.

Http Request

GET /api/rest/r5/v1/pms-stat?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 348
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "id" : "eefe4e0ce2a911edb5ea0242ac12",
    "imoNumber" : "9113367",
    "lastModifiedDate" : "2023-02-01 15:12",
    "syncDate" : "2023-01-27 15:12",
    "overdue" : 10,
    "overdueCritical" : 2,
    "overdueClass" : 4,
    "planned" : 15,
    "plannedOverdue" : 4
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of PMS statistics

data.[].id

String

Identification number (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (mandatory)

data.[].lastModifiedDate

String

Last modified date (mandatory)

data.[].syncDate

String

Sync date (mandatory)

data.[].overdue

Number

Overdue (mandatory)

data.[].overdueCritical

Number

Overdue critical (mandatory)

data.[].overdueClass

Number

Overdue class (mandatory)

data.[].planned

Number

Planned (mandatory)

data.[].plannedOverdue

Number

Planned overdue (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

PMS Statistics Monthly

Get PMS Statistics Monthly

Returns PMS statistics monthly.

Http Request

GET /api/rest/r5/v1/pms-stat-monthly?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 733
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "id" : "02e3e40ee2a511edb5ea0242ac120002",
    "imoNumber" : "9113367",
    "installationName" : "Kine (MS A1)",
    "month" : 1,
    "year" : 2023,
    "jobsDone" : 1000,
    "jobsDoneDue" : 2000,
    "jobsDoneDueCritical" : 100,
    "jobsDoneCritical" : 100,
    "jobsDue" : 1500,
    "jobsDueCritical" : 150,
    "jobsOverdue" : 5,
    "jobsOverdueCritical" : 5,
    "jobsOverdueMonthEnd" : 3,
    "jobsOverdueMonthEndCritical" : 1,
    "jobsOverdueTotal" : 6,
    "jobsOverdueTotalCritical" : 4,
    "jobsDueMonthEnd" : 1000,
    "jobsDueMonthEndCritical" : 100,
    "dateCreated" : "2023-02-02 14:46",
    "lastModifiedDate" : "2023-02-01 14:36"
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of PMS statistics monthly

data.[].id

String

Identification number (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (mandatory)

data.[].installationName

String

Installation name (mandatory)

data.[].month

Number

Month (mandatory)

data.[].year

Number

Year (mandatory)

data.[].jobsDone

Number

Jobs done (mandatory)

data.[].jobsDoneDue

Number

Jobs done due (mandatory)

data.[].jobsDoneDueCritical

Number

Jobs done due critical (mandatory)

data.[].jobsDoneCritical

Number

Jobs done critical (mandatory)

data.[].jobsDue

Number

Jobs due (mandatory)

data.[].jobsDueCritical

Number

Jobs due critical (mandatory)

data.[].jobsOverdue

Number

Jobs overdue (mandatory)

data.[].jobsOverdueCritical

Number

Jobs overdue critical (mandatory)

data.[].jobsOverdueMonthEnd

Number

Jobs overdue month end (mandatory)

data.[].jobsOverdueMonthEndCritical

Number

Jobs overdue month end critical (mandatory)

data.[].jobsOverdueTotal

Number

Jobs overdue total (mandatory)

data.[].jobsOverdueTotalCritical

Number

Jobs overdue total critical (mandatory)

data.[].jobsDueMonthEnd

Number

Jobs due month end (mandatory)

data.[].jobsDueMonthEndCritical

Number

Jobs due month end critical (mandatory)

data.[].dateCreated

String

Date created (mandatory)

data.[].lastModifiedDate

String

Last modified date (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Procurement Activities

Get Procurement Activities

Returns procurement activities.

Http Request

GET /api/rest/r5/v1/pms-stat?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 348
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "id" : "eefe4e0ce2a911edb5ea0242ac12",
    "imoNumber" : "9113367",
    "lastModifiedDate" : "2023-02-01 15:12",
    "syncDate" : "2023-01-27 15:12",
    "overdue" : 10,
    "overdueCritical" : 2,
    "overdueClass" : 4,
    "planned" : 15,
    "plannedOverdue" : 4
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of procurement activities

data.[].id

String

Identification number (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (mandatory)

data.[].lastModifiedDate

String

Last modified date (mandatory)

data.[].syncDate

String

Sync date (mandatory)

data.[].overdue

Number

Overdue (mandatory)

data.[].overdueCritical

Number

Overdue critical (mandatory)

data.[].overdueClass

Number

Overdue class (mandatory)

data.[].planned

Number

Planned (mandatory)

data.[].plannedOverdue

Number

Planned overdue (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Purchase Requests

Get Purchase Requests

Returns purchase requests.

Http Request

GET /api/rest/r5/v1/purchase-requests?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
Content-Length: 1869
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "lastModifiedDate" : "2023-04-24 16:39",
    "mespasPurchaseRequestId" : "df58f1953c9c5e0c80b57d6fe30982bf",
    "mandatorNumber" : "123-A1",
    "referenceNumber" : "I-2023-MS-A1-00101-D",
    "creationDate" : "2023-04-24",
    "creatorOccupation" : "Position not selected",
    "subject" : "Procurement case subject",
    "urgency" : 0,
    "accountNumber" : "0002",
    "productLabel" : "Main Engine A1",
    "productBrand" : "Sulzer",
    "productType" : "PT-001-1",
    "productSerialNumber" : "42-XXX",
    "remark" : "Important note for the purchase manager.",
    "items" : [ {
      "mespasPurchaseRequestItemId" : "4a5a6b7ef4c50c0c730a7c892fd8fee3",
      "positionNumber" : 1,
      "stock" : "5.000 pcs.",
      "quantity" : "1.00",
      "quantityUnit" : "kg",
      "componentId" : "8f14e45fceea167a5a36dedd4bea2543",
      "externalComponentId" : "EXTERNAL Company Spec. (A) Comp 4 Desc",
      "componentDescription" : "Company Spec. (A) Comp 4 Desc",
      "componentExecution" : "Execution 7",
      "componentSpecification1" : "Company Spec. (A) Comp 1 Spez.",
      "componentSpecification2" : "Spec 2",
      "componentSpecification3" : "Spec 3",
      "componentSpecification4" : "Spec 4",
      "componentSpecification5" : "Spec 5",
      "componentSpecification6" : "Spec 6",
      "componentSpecification7" : "Spec 7",
      "remark" : "Important remark",
      "componentSpecificationHeader1" : "Spec header 1",
      "componentSpecificationHeader2" : "Spec header 2",
      "componentSpecificationHeader3" : "Spec header 3",
      "componentSpecificationHeader4" : "Spec header 4",
      "componentSpecificationHeader5" : "Spec header 5",
      "componentSpecificationHeader6" : "Spec header 6",
      "componentSpecificationHeader7" : "Spec header 7"
    } ]
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of purchase requests

data.[].lastModifiedDate

String

Last modified date (mandatory)

data.[].mespasPurchaseRequestId

String

Mespas purchase request id (mandatory)

data.[].mandatorNumber

String

Mandator number (mandatory)

data.[].referenceNumber

String

Reference number (mandatory)

data.[].creationDate

String

Creation date (mandatory)

data.[].creatorOccupation

String

Creator occupation (optional)

data.[].subject

String

Subject (optional)

data.[].urgency

Number

Urgency (optional). See Enum Values (Purchase Request Urgency)

data.[].accountNumber

String

Account number (optional)

data.[].productLabel

String

Product label (mandatory)

data.[].productBrand

String

Product brand (mandatory)

data.[].productType

String

Product type (mandatory)

data.[].productSerialNumber

String

Product serial number (optional)

data.[].remark

String

Remark (optional)

data.[].items.[].

Array

Purchase request items (optional)

data.[].items.[].mespasPurchaseRequestItemId

String

Mespas purchase request item id (mandatory)

data.[].items.[].positionNumber

Number

Position number (mandatory)

data.[].items.[].stock

String

Stock (mandatory)

data.[].items.[].quantity

String

Quantity (mandatory)

data.[].items.[].quantityUnit

String

Quantity unit (mandatory). See Enum Values (Units)

data.[].items.[].componentId

String

Component id (mandatory)

data.[].items.[].externalComponentId

String

External component id (optional)

data.[].items.[].componentDescription

String

Component description (mandatory)

data.[].items.[].componentExecution

String

Component execution (optional)

data.[].items.[].remark

String

Remark (optional)

data.[].items.[].componentSpecification1

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader1

String

Component specification header (optional)

data.[].items.[].componentSpecification2

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader2

String

Component specification header (optional)

data.[].items.[].componentSpecification3

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader3

String

Component specification header (optional)

data.[].items.[].componentSpecification4

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader4

String

Component specification header (optional)

data.[].items.[].componentSpecification5

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader5

String

Component specification header (optional)

data.[].items.[].componentSpecification6

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader6

String

Component specification header (optional)

data.[].items.[].componentSpecification7

String

Component specification (optional)

data.[].items.[].componentSpecificationHeader7

String

Component specification header (optional)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Ship Schedules

Get Ship Schedules

Returns ship schedules.

Http Request

GET /api/rest/r5/v1/ship-schedules?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 586

{
  "data" : [ {
    "portStayId" : "ff80818187b3bed80187b3d763600000",
    "imoNumber" : "9113367",
    "installationName" : "Kine (MS A1)",
    "port" : "Hamburg",
    "country" : "Germany",
    "timezone" : "Europe/Berlin",
    "arrivalDate" : "2034-01-01",
    "arrivalTime" : "11:15",
    "departureDate" : "2034-01-31",
    "departureTime" : "13:45",
    "ownerAgent" : "Important owner agent infos.",
    "chartererAgent" : "Important charterer agent infos.",
    "remark" : "Important remarks.",
    "position" : 271
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of ship schedules

data.[].portStayId

String

Port stay id (mandatory)

data.[].imoNumber

String

IMO number (International Maritime Organization) (mandatory)

data.[].installationName

String

Installation name (mandatory)

data.[].port

String

Port (mandatory)

data.[].country

String

Country (mandatory)

data.[].timezone

String

Timezone (mandatory)

data.[].arrivalDate

String

Arrival date (optional)

data.[].arrivalTime

String

Arrival time (optional)

data.[].departureDate

String

Departure date (optional)

data.[].departureTime

String

Departure time (optional)

data.[].ownerAgent

String

Owner agent (optional)

data.[].chartererAgent

String

Charterer agent (optional)

data.[].remark

String

Remark (optional)

data.[].position

Number

Position (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Tasks

Get Tasks

Returns tasks.

Http Request

GET /api/rest/r5/v1/tasks?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 2201
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "taskId" : "ff80818187b3e2860187b3f2db000000",
    "companyName" : "Buyer Company A",
    "taskNumber" : "A2-321",
    "mandatorNumber" : "123-A2",
    "installationName" : "Celebrity Eclipse (MS A2)",
    "state" : "PENDING",
    "taskLocation" : "",
    "type" : "Recommendation",
    "title" : "Clean control room",
    "description" : "Clean the control room (before next inspection)",
    "instruction" : "Important work instructions",
    "lastModifiedDate" : "2023-04-24 17:52",
    "creationDate" : "2021-06-15 00:00",
    "orderer" : "Chief Engineer",
    "responsible" : "Chief Engineer",
    "author" : "A1 Buyer",
    "targetDate" : "2021-08-19",
    "carriedOutBy" : "Chief Engineer",
    "priority" : "Urgent",
    "operatingSystem" : "ISM",
    "product" : "Main Engine A2",
    "tagNumber" : "yt-3",
    "erpId" : "XX-XXX",
    "productSerialNumber" : "ENG-123",
    "productBuilderName" : "Product Builder 1",
    "productBrandName" : "Sulzer",
    "productTypeName" : "PT-001-1",
    "productCategoryName" : "Engine",
    "productFunction" : "Main Engine",
    "productLocation" : "Engine Room",
    "productPosition" : "1",
    "immediateCause" : "NA",
    "isDryDock" : true,
    "dateDone" : "2023-01-01 16:53",
    "isOfficeUseOnly" : false,
    "needsApproval" : false,
    "lastChange" : "2023-04-24 17:52",
    "codePattern" : "PSC (Paris MoU)",
    "mainCode" : "01",
    "subCode1" : "02",
    "subCode2" : "03",
    "shoreRequired" : "55",
    "actionCode" : "Action Code 2",
    "dateOfIncident" : "2021-06-15",
    "timeUsed" : 7,
    "hotWork" : true,
    "requiredTime" : 8.0,
    "rootCause" : "Important root cause.",
    "correctiveActions" : "Important corrective actions.",
    "preventiveMeasures" : "Important preventive measures.",
    "officeComments" : "Important office comments.",
    "taskComments" : [ {
      "author" : "A1 Buyer",
      "actionExecutedDate" : "2023-04-24 00:00",
      "topic" : "Used Parts recorded",
      "note" : "Used parts recorded in task",
      "isOfficeUseOnly" : false,
      "timeSpent" : 6,
      "recordedDate" : "2023-04-24 17:49"
    } ]
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of tasks

data.[].taskId

String

Task id (mandatory)

data.[].companyName

String

Company name (mandatory)

data.[].taskNumber

String

Task number (mandatory)

data.[].mandatorNumber

String

Mandator number (optional)

data.[].installationName

String

Installation name (optional)

data.[].state

String

State (mandatory). See Enum Values (Task State)

data.[].taskLocation

String

Task location (optional)

data.[].type

String

Type (mandatory)

data.[].title

String

Title (mandatory)

data.[].description

String

Description (optional)

data.[].instruction

String

Instruction (optional)

data.[].lastModifiedDate

String

Last modified date (mandatory)

data.[].creationDate

String

Creation date (mandatory)

data.[].creationDate

String

Orderer (optional)

data.[].responsible

String

Responsible (mandatory)

data.[].author

String

Author (mandatory)

data.[].targetDate

String

Target date (mandatory)

data.[].carriedOutBy

String

Carried out by (mandatory)

data.[].priority

String

Priority (mandatory)

data.[].operatingSystem

String

Operating system (optional)

data.[].product

String

Product (optional)

data.[].tagNumber

String

Tag number (optional)

data.[].erpId

String

Erp id (optional)

data.[].productSerialNumber

String

Product serial number (optional)

data.[].productBuilderName

String

Product builder name (optional)

data.[].productBrandName

String

Product brand name (optional)

data.[].productTypeName

String

Product type name (optional)

data.[].productCategoryName

String

Product category name (optional)

data.[].productFunction

String

Product function (optional)

data.[].productLocation

String

Product location (optional)

data.[].productPosition

String

Product position (optional)

data.[].immediateCause

String

Immediate cause (optional)

data.[].isDryDock

Boolean

Is dry dock (mandatory)

data.[].dateDone

String

Date done (optional)

data.[].isOfficeUseOnly

Boolean

Is office use only (mandatory)

data.[].needsApproval

Boolean

Needs approval (mandatory)

data.[].lastChange

String

Last change (mandatory)

data.[].codePattern

String

Code pattern (optional)

data.[].mainCode

String

Main code (optional)

data.[].subCode1

String

Sub code 1 (optional)

data.[].subCode2

String

Sub code 2 (optional)

data.[].shoreRequired

String

Shore required (optional)

data.[].actionCode

String

Action code (optional)

data.[].dateOfIncident

String

Date of incident (optional)

data.[].timeUsed

Number

Time used (optional)

data.[].hotWork

Boolean

Hot work (mandatory)

data.[].requiredTime

Number

Required time (optional)

data.[].rootCause

String

Root cause (optional)

data.[].correctiveActions

String

Corrective actions (optional)

data.[].preventiveMeasures

String

Preventive measures (optional)

data.[].officeComments

String

Office comments (optional)

data.[].taskComments.[].

Array

Task comments (optional)

data.[].taskComments.[].author

String

Author (mandatory)

data.[].taskComments.[].actionExecutedDate

String

Action executed date (mandatory)

data.[].taskComments.[].topic

String

Topic (optional)

data.[].taskComments.[].note

String

Note (optional)

data.[].taskComments.[].isOfficeUseOnly

Boolean

Is office use only (mandatory)

data.[].taskComments.[].timeSpent

Number

Time spent (optional)

data.[].taskComments.[].recordedDate

String

Recorded date (mandatory)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page

Invoices

Get Invoices

Returns invoices.

Http Request

GET /api/rest/r5/v1/invoices?page=0&pageSize=100&from=2023-01-01 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzdXBwbGllci1hcGlAbWVzcGFzLmNvbSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJ0b2tlbi1pZCI6IjQwMjg4MDBhODIxNjkxZjgwMTgyMTY5MjdlMTkwMDAwIiwiZXhwIjozODA1NzE5NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX1NVUFBMSUVSX01UTUwiLCJST0xFX1RTTV9BUEkiLCJST0xFX1NVUFBMSUVSX0FQSSJdLCJqdGkiOiIzZmJjMTdmOC00MDgyLTQ0NGQtOWJlMi1kY2JjZDE3ZTgyN2YiLCJjbGllbnRfaWQiOiJtZXNwYXMtd2ViLW1vYmlsZSIsInRva2VuLWtpbmQiOiJtb2JpbGUifQ.qrVnFlc2-FBaEf70N57LTOqq8WRmbWl0xzGKnXt2kAE
Host: api.mespas.com

Http Request Parameter

Parameter Description

page

The page to retrieve. Zero-based index

pageSize

Optional request parameter allowing to set the number of records per page.

from

Optional request parameter allowing to search for forms which were last modified 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
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Content-Length: 1541
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "data" : [ {
    "lastModifiedDate" : "2023-04-25 10:17",
    "mespasInvoiceId" : 1,
    "mandatorNumber" : "123-A1",
    "installationOwner" : "OwnerBuyer Company C",
    "invoiceNumber" : "12345",
    "externalInvoiceNumber" : "XX-XX",
    "mespasOrderId" : 1,
    "creditorNumber" : "BuyA/SuppA",
    "invoiceSender" : "Supplier Company A",
    "cancelled" : false,
    "invoiceDate" : "2023-01-31",
    "invoiceReceivedDate" : "2023-01-02",
    "invoiceDueDate" : "2023-02-14",
    "amount" : "229.00",
    "currency" : "CHF",
    "gst" : "99.00",
    "gstType" : "CGST+SGST 18%",
    "hsnCode" : "9982",
    "orderNumber" : "Order 001",
    "referenceNumber" : "I-2016-MS-A1-00201-E/01/01",
    "accountNumber" : "0003",
    "accountDescription" : "Stores and Provisions",
    "externalAccountNumber" : "99999",
    "lastInvoiceReceived" : false,
    "area" : "Engine Stores",
    "description" : "Important remark",
    "orderYear" : 2023,
    "commission" : "10%",
    "orderDate" : "2023-02-24",
    "orderAmount" : "229.9968",
    "orderCurrency" : "CHF",
    "deliveryPort" : "Nukualofa",
    "credit" : false,
    "caseSubject" : "Procurement",
    "bankIbanNumber" : "IBAN 2",
    "bankSwiftNumber" : "Swift 2",
    "bankClearingNumber" : "Clearing 2",
    "bankAccountNumber" : "Account 2",
    "bankCurrency" : "EUR",
    "bankName" : "Bank 2",
    "bankCity" : "Bank 2 City",
    "bankCountry" : "Switzerland",
    "bankId" : "c81e728d9d4c2f636f067f89cc14862c"
  } ],
  "page" : 0,
  "totalPages" : 1,
  "pageSize" : 100
}

Http Response Fields

Path Type Description

data.[].

Array

The list of invoices

data.[].lastModifiedDate

String

Last modified date (mandatory)

data.[].mespasInvoiceId

Number

Mespas invoice id (mandatory)

data.[].mandatorNumber

String

Mandator number (mandatory)

data.[].installationOwner

String

Installation owner (mandatory)

data.[].invoiceNumber

String

Invoice number (mandatory)

data.[].externalInvoiceNumber

String

External invoice number (optional)

data.[].mespasOrderId

Number

Mespas order id (mandatory)

data.[].creditorNumber

String

Creditor number (mandatory)

data.[].invoiceSender

String

Invoice sender (mandatory)

data.[].cancelled

Boolean

Cancelled (mandatory)

data.[].invoiceDate

String

Invoice date (optional)

data.[].invoiceReceivedDate

String

Invoice received date (mandatory)

data.[].invoiceDueDate

String

Invoice due date (mandatory)

data.[].amount

String

Amount (mandatory)

data.[].currency

String

Currency (mandatory). See Enum Values (Currencies)

data.[].gst

String

Gst (optional)

data.[].gstType

String

GST type (optional)

data.[].hsnCode

String

HSN code (optional)

data.[].orderNumber

String

Order number (optional)

data.[].referenceNumber

String

Reference number (mandatory)

data.[].accountNumber

String

Account number (optional)

data.[].accountDescription

String

Account description (optional)

data.[].externalAccountNumber

String

External account number (optional)

data.[].lastInvoiceReceived

Boolean

Last invoice received (mandatory)

data.[].area

String

Area (optional)

data.[].description

String

Description (optional)

data.[].orderYear

Number

Order year (mandatory)

data.[].commission

String

Commission (optional)

data.[].orderDate

String

Order date (mandatory)

data.[].orderAmount

String

Order amount (mandatory)

data.[].orderCurrency

String

Order currency (mandatory). See Enum Values (Currencies)

data.[].deliveryPort

String

Delivery port (optional)

data.[].credit

Boolean

Credit (mandatory)

data.[].caseSubject

String

Case subject (optional)

data.[].bankIbanNumber

String

Bank iban number (optional)

data.[].bankSwiftNumber

String

Bank swift number (optional)

data.[].bankClearingNumber

String

Bank clearing number (optional)

data.[].bankAccountNumber

String

Bank account number (optional)

data.[].bankCurrency

String

Bank currency (optional). See Enum Values (Currencies)

data.[].bankName

String

Bank name (optional)

data.[].bankCity

String

Bank city (optional)

data.[].bankCountry

String

Bank country (optional)

data.[].bankId

String

Bank id (optional)

page

Number

The current page (see pagination)

totalPages

Number

The total number of pages (see pagination)

pageSize

Number

The number of records per page