Skip to content

Updating an existing Vendor

Request

This endpoint returns structured Vendor objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the vendors top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
Bodyapplication/jsonrequired
vendorobject
{
  "vendor": {
    "name": "string",
    "archived": true,
    "external_reference": {
      "service_name": "string",
      "service_model": "string",
      "service_model_ref": "string",
      "external_message": "string",
      "external_link": "string",
      "external_status": "string",
      "locked": true
    }
  }
}

Responses

Vendor has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
vendorsobject
external_referencesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "vendors": {
    "property1": {
      "archived": true,
      "external_reference_ids": [
        "string"
      ],
      "externally_managed": true,
      "in_use": true,
      "name": "string"
    },
    "property2": {
      "archived": true,
      "external_reference_ids": [
        "string"
      ],
      "externally_managed": true,
      "in_use": true,
      "name": "string"
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}