KKonsol Developers

Update a trading

PATCH
/integration/v1/tradings/{id}

Changes the fields you send and leaves the rest unchanged.

The body is a JSON merge patch (RFC 7396): null clears a field that can be empty. address, contact and billing are replaced whole. external_ref can be set once and cannot change after that.

Authorization

integrationKey
headerAuthorizationBearer <token>

Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>. Konsol issues it.

Path Parameters

id*string
Formatuuid

Request Body

  1. body

company_id cannot change: create a trading under the other company instead.

Properties1 <= properties
external_ref?ExternalRef

Your own reference for a record: any format, compared exactly and case-sensitively. Leading or trailing whitespace is refused rather than trimmed, so a stored reference always matches what was sent.

Match^\S(.*\S)?$
Length1 <= length <= 128
name?string
Length1 <= length <= 255
status?string
Value in"active""inactive"
mcc?|
Match^[0-9]{4}$
tags?array<>

Replaces the whole list.

Itemsitems <= 32
contact?|null
address?|null

Response Body

The updated trading

application/json
  1. response
id*string
Formatuuid
external_ref?|null
company_id*string
Formatuuid
enterprise_id*|

The company's enterprise, or null when it has none.

Formatuuid
name*string
status*string
Value in"active""inactive"
mcc?string|null
tags*array<string>
contact?|null
address?|null
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
deleted_at*|

When the record was deleted, or null. Lists return deleted records only with include_deleted=true.

Formatdate-time
Example Request
curl -X PATCH 'https://api.konsol.my/integration/v1/tradings/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "external_ref": "ACQ-MBB",  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",  "enterprise_id": "2dbe425a-b3bc-4170-8bae-9e5391aafea6",  "name": "string",  "status": "active",  "mcc": "string",  "tags": [    "string"  ],  "contact": {    "person": "string",    "phone": "string",    "email": "user@example.com"  },  "address": {    "line1": "string",    "line2": "string",    "city": "string",    "postcode": "string",    "state": "MY-01",    "country": "MY"  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "deleted_at": "2019-08-24T14:15:22Z"}