Skip to content
/
Bulk write 'Externalsuppl...

Errands (2.0.0)

The 'Errands' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Generalerrandaction

Operations

Generalerranddefaultdescription

Operations

Generalerrandsubtype

Operations

Generalerrandgroup

Operations

Generalerrandtype

Operations

Generalerrandactionfile

Operations

Generalerrandfile

Operations

Componentconditionvalue

Operations

Componentconditionnotation

Operations

Errandactiondefault

Operations

Inspectionerrandfault

Operations

Inspectionerrandsetting

Operations

Inspectionerrand

Operations

Inspectionerrandchecklist

Operations

Inspectionerrandfile

Operations

Inspectionerrandprotocolsetting

Operations

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

List 'Externalsupplier'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
global_realestatesArray of objects
global_segmentsArray of objects
contact_emailany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

contact_first_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

contact_last_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

contact_phone_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

errands_emailany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

errands_phone_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

invoice_addressany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

org_noany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

receive_email_notificationsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

receive_sms_notificationsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/errands/suppliers/externalsupplier/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful query

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
created_atstring(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
pending_monitor_approval_amountanyread-only
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "name": "string",
    "invoice_address": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "org_no": "stringstri",
    "contact_last_name": "string",
    "receive_sms_notifications": true,
    "organization": { … },
    "errands_phone_number": "string",
    "contact_phone_number": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "pending_monitor_approval_amount": null,
    "contact_email": "user@example.com",
    "errands_email": "user@example.com",
    "contact_first_name": "string",
    "receive_email_notifications": true,
    "custom_id": "string"
  }
]

Bulk write 'Externalsupplier'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/errands/suppliers/externalsupplier/list/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '[
    {
      "name": "string",
      "invoice_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "org_no": "stringstri",
      "contact_last_name": "string",
      "receive_sms_notifications": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "errands_phone_number": "string",
      "contact_phone_number": "string",
      "contact_email": "user@example.com",
      "errands_email": "user@example.com",
      "contact_first_name": "string",
      "receive_email_notifications": true,
      "custom_id": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
created_atstring(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
pending_monitor_approval_amountanyread-only
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "name": "string",
    "invoice_address": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "org_no": "stringstri",
    "contact_last_name": "string",
    "receive_sms_notifications": true,
    "organization": { … },
    "errands_phone_number": "string",
    "contact_phone_number": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "pending_monitor_approval_amount": null,
    "contact_email": "user@example.com",
    "errands_email": "user@example.com",
    "contact_first_name": "string",
    "receive_email_notifications": true,
    "custom_id": "string"
  }
]

Create 'Externalsupplier'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
namestring<= 255 charactersrequired
errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/errands/suppliers/externalsupplier/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "invoice_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "org_no": "stringstri",
    "contact_last_name": "string",
    "receive_sms_notifications": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "errands_phone_number": "string",
    "contact_phone_number": "string",
    "contact_email": "user@example.com",
    "errands_email": "user@example.com",
    "contact_first_name": "string",
    "receive_email_notifications": true,
    "custom_id": "string"
  }'

Responses

Successful creation

Bodyapplication/json
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
created_atstring(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
pending_monitor_approval_amountanyread-only
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
Response
application/json
{
  "name": "string",
  "invoice_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "org_no": "stringstri",
  "contact_last_name": "string",
  "receive_sms_notifications": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "errands_phone_number": "string",
  "contact_phone_number": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pending_monitor_approval_amount": null,
  "contact_email": "user@example.com",
  "errands_email": "user@example.com",
  "contact_first_name": "string",
  "receive_email_notifications": true,
  "custom_id": "string"
}

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.