Jobs

The portal endpoints allow you to manage the portal settings programmatically for an outsourced job.

The portal object

Properties

  • checklistarray

    The checklist to be displayed on the portal.

  • confirmobject

    The portal confirmation info.

  • doneDatedate

    The date the job was done.

  • enabledboolean

    True if the portal is enabled.

  • instructionsstring

    The instructions for the supplier.

  • referencestring

    The reference of the job to be used to create the portal link (https://https://suppliers.lsp.expert/:reference).

  • sentDatedate

    The date the job was sent.

  • sentDateStatusobject

    The status of the sent date.

  • supplierCommentsstring

    The comments of the supplier.

  • uploadFileOnGroupboolean

    True if the file should be uploaded on the group and not on the job.

Outsourcing object

  {
    "sentDateStatus": {
      "status": "processed",
      "updatedAt": "2024-10-14T08:58:16.749Z"
    },
    "confirm": {
      "enabled": true,
      "generatePurchaseOrderOnAcceptation": false,
      "status": 2,
      "acceptedDate": "2024-10-14T11:24:19.066Z",
      "comment": "Ok !"
    },
    "enabled": true,
    "uploadFileOnGroup": false,
    "checklist": [
      {
        "name": "I have used the ref material",
        "id": "670cffbe077d755ddaa9b122"
      }
    ],
    "reference": "bac767b351c6453bb9e05fc62563fc79",
    "doneDate": "2024-09-30T12:31:47.400Z",
    "sentDate": "2024-10-14T08:58:16.749Z",
    "instructions": "<p>Please use the ref material.</p>"
  }
PUT/v2/jobs/:jobId/outsourcing/:id/portal

Update portal settings

This endpoint allows you to perform an update on the portal of an outsourced job. Any parameters not provided will be left unchanged.

Parameters

  • confirmboolean

    True if the confirmation is enabled.

  • enabledboolean

    True if the portal is enabled.

  • generatePurchaseOrderOnAcceptationboolean

    True if a purchase order should be generated when the job is accepted.

  • instructionsstring,null

    The instructions for the supplier.

  • uploadFileOnGroupboolean

    True if the file should be uploaded on the group and not on the job.

Request

PUT
/v2/jobs/:id
curl -X PUT https://api.lsp.expert/v2/jobs/6703c3db1efed1712305bc4e/outsourcing/66825e48edde360f163d4e68/portal \
  -u {key}: \
  -d confirm=true

Response

{
  "id": "6669627c35076b408a557837",
  // ...
  "outsourcing": [
  {
    "id": "66825e48edde360f163d4e68",
    "portal": {
      "checklist": [],
      "confirm": {
        "enabled": true,
        "generatePurchaseOrderOnAcceptation": false,
        "status": 1
      },
      "enabled": true,
      "reference": "bac767b351c6453bb9e05fc62563fc79",
      "uploadFileOnGroup": false
    },
    //...
  }]
}
PUT/v2/jobs/:jobId/outsourcing/:id/portal/reset

Reset the portal reference

This endpoint allows you to reset the reference for the portal.

Parameters

Request

PUT
/v2/jobs/:jobId/outsourcing/:id/portal/reset
curl -X PUT https://api.lsp.expert/v2/jobs/6703c3db1efed1712305bc4e/outsourcing/66825e48edde360f163d4e68/portal/reset \
  -u {key}:

Response

{
  "id": "6669627c35076b408a557837",
  // ...
  "outsourcing": [
  {
    "id": "66825e48edde360f163d4e68",
    "portal": {
      "checklist": [],
      "confirm": {
        "enabled": true,
        "generatePurchaseOrderOnAcceptation": false,
        "status": 1
      },
      "enabled": true,
      "reference": "3c68347d664244358976a8af6bd68c77",
      "uploadFileOnGroup": false
    },
    //...
  }]
}
POST/v2/jobs/:jobId/outsourcing/:id/portal/email

Send an email

This endpoint allows you to send an email to the supplier of an outsourced job.

Parameters

  • ccContactsarray

    The list of contact ids to cc.

  • contactsarray

    The list of contact ids.

  • contentstring

    The content of the email (if not provided, the default content from the document settings will be used).

  • documentSettingsstring

    The document settings id (if not provided, the default document settings of the supplier will be used).

  • subjectstring

    The subject of the email (if not provided, the default subject from the document settings will be used).

Request

POST
/v2/jobs/:jobId/outsourcing/:id/portal/email
curl https://api.lsp.expert/v2/jobs/6703c3db1efed1712305bc4e/outsourcing/6669627c35076b408a557837/email \
  -u {key}: \

Response

   {
    "id": "6669627c35076b408a557837",
    // ...
    "outsourcing": [
    {
      "id": "66825e48edde360f163d4e68",
      "portal": {
        "sentDateStatus": {
          "status": "processed",
          "updatedAt": "2024-10-14T08:58:16.749Z"
        },
        "checklist": [],
        "confirm": {
          "enabled": true,
          "generatePurchaseOrderOnAcceptation": false,
          "status": 1
        },
        "enabled": true,
        "reference": "3c68347d664244358976a8af6bd68c77",
        "uploadFileOnGroup": false
      },
      //...
    }]
  }
POST/v2/jobs/:jobId/outsourcing/:id/portal/checklist

Add a checklist item

This endpoint allows you to add a checklist item on the portal

Parameters

  • namestring

    The name of the checklist item.

Request

POST
/v2/jobs/:jobId/outsourcing/:id/portal/checklist
curl https://api.lsp.expert/v2/jobs/6703c3db1efed1712305bc4e/outsourcing/66825e48edde360f163d4e68/portal/checklist \
  -u {key}: \
  -d name="I have used the ref material" \

Response

  {
    "id": "6669627c35076b408a557837",
    // ...
    "outsourcing": [
    {
      "id": "66825e48edde360f163d4e68",
      "portal": {
        "sentDateStatus": {
          "status": "processed",
          "updatedAt": "2024-10-14T08:58:16.749Z"
        },
        "checklist": [{
          "name": "I have used the ref material",
          "id": "670cffbe077d755ddaa9b122"
        }],
        "confirm": {
          "enabled": true,
          "generatePurchaseOrderOnAcceptation": false,
          "status": 1
        },
        "enabled": true,
        "reference": "3c68347d664244358976a8af6bd68c77",
        "uploadFileOnGroup": false
      },
      //...
    }]
  }
PUT/v2/jobs/:jobId/outsourcing/:id/portal/checklist/:itemId

Update a checklist item

This endpoint allows you to update a match category on an outsourced job.

Parameters

  • namestring

    The name of the checklist item.

Request

PUT
/v2/jobs/:jobId/outsourcing/:id/portal/checklist/:itemId
curl https://api.lsp.expert/v2/jobs/6703c3db1efed1712305bc4e/outsourcing/66825e48edde360f163d4e68/portal/checklist/670cffbe077d755ddaa9b122 \
  -u {key}: \
  -d name="I have used the ref material (edit)"

Response

  {
    "id": "6669627c35076b408a557837",
    // ...
    "outsourcing": [
    {
      "id": "66825e48edde360f163d4e68",
      "portal": {
        "sentDateStatus": {
          "status": "processed",
          "updatedAt": "2024-10-14T08:58:16.749Z"
        },
        "checklist": [{
          "name": "I have used the ref material (edit)",
          "id": "670cffbe077d755ddaa9b122"
        }],
        "confirm": {
          "enabled": true,
          "generatePurchaseOrderOnAcceptation": false,
          "status": 1
        },
        "enabled": true,
        "reference": "3c68347d664244358976a8af6bd68c77",
        "uploadFileOnGroup": false
      },
      //...
    }]
  }
DEL/v2/jobs/:jobId/outsourcing/:id/portal/checklist/:itemId

Remove a checklist item

This endpoint allows you to remove a match category on a job.

Request

POST
/v2/jobs/:jobId/outsourcing/:id/portal/checklist/:itemId
curl https://api.lsp.expert/v2/jobs/6703c3db1efed1712305bc4e/outsourcing/66825e48edde360f163d4e68/portal/checklist/670cffbe077d755ddaa9b122 \
  -u {key}:

Response

{
    "id": "6669627c35076b408a557837",
    // ...
    "outsourcing": [
    {
      "id": "66825e48edde360f163d4e68",
      "portal": {
        "sentDateStatus": {
          "status": "processed",
          "updatedAt": "2024-10-14T08:58:16.749Z"
        },
        "checklist": [],
        "confirm": {
          "enabled": true,
          "generatePurchaseOrderOnAcceptation": false,
          "status": 1
        },
        "enabled": true,
        "reference": "3c68347d664244358976a8af6bd68c77",
        "uploadFileOnGroup": false
      },
      //...
    }]
  }