Documentation

Supplier status

Retrieve Quotation remarks from PostNL

GET/supplier/v1/quotation/notes Retrieve quotation information

Through this API remarks from PostNL on a quotation can be received.

Call guidelines

By stating your apikey and supplierID you receive all notes of quotations from PostNL available for you. Each note can be received only once.

The fields apikey and SupplierID should be provided, QuotationNRPostNL can be specified to receive notes of a specific quotation.

QuotationNrPostNL: Is not necessary, but preferred for performance reasons.

Response fields

{
  "data": [
    {
      "Id": "string",
      "SupplierID": "string",
      "QuotationNrPostNL": "string",
      "Author": "string",
      "TimeStamp": "2021-01-29T11:04:22.502Z",
      "Note": "string",
      "response": "string",
      "warningMessage": "string",
      "errorMessage": "string",
      "id": "string",
      "objectNameId": "string"
    }
  ]
}

Author is the name of the user from PostNL that provided the remark. The Timestamp is in UTC, to make sure all systems can stay consistent. The Note field is the actual value of the remark.

Possible error messages

Unknown SupplierID specified
SupplierID cannot be empty
QuotationNrPostNL does not occur in SupplierID
SupplierID is does not have a valid supplier-Category

Post Quotation remarks to PostNL

POST/supplier/v1/quotation/notes Provide quotation information

Through this API remarks on a quotation can be posted for PostNL

Call guidelines

{

"SupplierID": "string",
"QuotationNrPostNL": "string",
"Note": "string"

}

All fields are required.

Response fields

{
  "data": [
    {
      "response": "string",
      "warningMessage": "string",
      "errorMessage": "string",
      "id": "string",
      "objectNameId": "string"
    }
  ]
}

Possible error messages

Unknown SupplierID specified
SupplierID cannot be empty
QuotationNrPostNL cannot be empty
QuotationNrPostNL does not occur in SupplierID
Same note allready exist at QuotationNrPostNL
SupplierID is does not have a valid supplier-Category

Retrieve workorder remarks from PostNL

GET/supplier/v1/workorder/notes Retrieve workorder information

Through this API remarks from PostNL on a workorder can be received.

Call guidelines

PostNLWorkOrderNr: this is the WRK reference that was obtained from the previous call
SupplierWorkOrderNr: This is the value the supplier has for the WorkOrder on their end

All fields are required

Response fields

{
  "data": [
    {
      "Id": "string",
      "SupplierID": "string",
      "PostNLWorkOrderNr": "string",
      "Author": "string",
      "TimeStamp": "2021-02-01T12:46:11.754Z",
      "Note": "string",
      "response": "string",
      "warningMessage": "string",
      "errorMessage": "string",
      "id": "string",
      "objectNameId": "string"
    }
  ]
}

Possible error messages

SupplierID cannot be empty
Unknown SupplierID specified
PostNLWorkOrderNr cannot be empty
PostNLWorkOrderNr does not occur in SupplierID
SupplierWorkOrderNr is allready filled in Axxerion
WorkOrder is not in status 3.1
SupplierID is does not have a valid supplier-Category

Post workorder remarks for PostNL

POST/supplier/v1/workorder/notes Provide workorder information

Through this API remarks on a workorder can be posted for PostNL

Call guidelines

{
  "SupplierID": "string",
  "PostNLWorkOrderNr": "string",
  "Note": "string"
}

Response fields

{
  "data": [
    {
      "response": "string",
      "warningMessage": "string",
      "errorMessage": "string",
      "id": "string",
      "objectNameId": "string"
    }
  ]
}

Author is the name of the user from PostNL that provided the remark. The Timestamp is in UTC, to make sure all system can stay consistent. The Note is the actual value of the remark.

Possible error messages

Unknown SupplierID specified
SupplierID cannot be empty
PostNLWorkOrderNR does not occur in SupplierID
SupplierID is does not have a valid supplier-Category