Consents

Manage GDPR and privacy consents for your customers. Handle consent collection, tracking, and compliance with data protection regulations. Create required and optional consent types for terms of service, marketing communications, and data processing.

Basic CRUD Actions

Get Consents listing

View on Postman

Get a list of all consent types.

JavaScript

let consents = await Client.API.Core.Consents.all();

TypeScript

import { Response, Consents } from "@tscommerce/sdk-typescript"

Client.API.Core.Consents.all().then((response:Response<Consents>) => {
    response.resource.forEach((consent) => {
        console.log(consent.id, consent.name, consent.required);
    });
});

PHP

$consents = $client->API->Core->Consents->all();

Create new Consent

View on Postman

Create a new consent type.

JavaScript

const payload = {
    name: 'Marketing Communications',
    description: 'Consent for promotional emails and offers',
    required: false
};
let consent = await Client.API.Core.Consents.create(payload);

TypeScript

import { Response, Consent, CreateConsentPayload } from "@tscommerce/sdk-typescript"

const payload:CreateConsentPayload = {
    name: 'Marketing Communications',
    description: 'Consent for promotional emails and offers',
    required: false
};

Client.API.Core.Consents.create(payload).then((response:Response<Consent>) => {
    console.log('Created consent:', response.resource);
});

PHP

$payload = [
    'name' => 'Marketing Communications',
    'description' => 'Consent for promotional emails and offers',
    'required' => false
];
$consent = $client->API->Core->Consents->create($payload);

Get Consent

View on Postman

Get an existing consent type by ID.

JavaScript

const consentId = 123;
let consent = await Client.API.Core.Consents.read(consentId);

TypeScript

import { Response, Consent } from "@tscommerce/sdk-typescript"

const consentId:Consent['id'] = 123;
Client.API.Core.Consents.read(consentId).then((response:Response<Consent>) => {
    console.log('Consent:', response.resource);
});

PHP

$consentId = 123;
$consent = $client->API->Core->Consents->read($consentId);

Update Consent

View on Postman

Update an existing consent type.

JavaScript

const consentId = 123;
const payload = {
    description: 'Updated consent description'
};
let consent = await Client.API.Core.Consents.update(consentId, payload);

TypeScript

import { Response, Consent, UpdateConsentPayload } from "@tscommerce/sdk-typescript"

const consentId:Consent['id'] = 123;
const payload:UpdateConsentPayload = {
    description: 'Updated consent description'
};

Client.API.Core.Consents.update(consentId, payload).then((response:Response<Consent>) => {
    console.log('Updated consent:', response.resource);
});

PHP

$consentId = 123;
$payload = ['description' => 'Updated consent description'];
$consent = $client->API->Core->Consents->update($consentId, $payload);

Delete Consent

View on Postman

Delete a consent type.

JavaScript

const consentId = 123;
Client.API.Core.Consents.delete(consentId);

TypeScript

import { Response, Consent } from "@tscommerce/sdk-typescript"

const consentId:Consent['id'] = 123;
Client.API.Core.Consents.delete(consentId).then((response:Response) => {
    console.log('Consent deleted successfully');
});

PHP

$consentId = 123;
$client->API->Core->Consents->delete($consentId);

Duplication

Duplicate Consent

View on Postman

Create a copy of an existing consent type.

JavaScript

const consentId = 123;
let duplicate = await Client.API.Core.Consents.duplicate(consentId);

TypeScript

import { Response, Consent } from "@tscommerce/sdk-typescript"

const consentId:Consent['id'] = 123;
Client.API.Core.Consents.duplicate(consentId).then((response:Response<Consent>) => {
    console.log('Duplicated consent ID:', response.resource.id);
});

PHP

$consentId = 123;
$duplicate = $client->API->Core->Consents->duplicate($consentId);

Bulk Actions

Bulk delete Consents

View on Postman

Delete multiple consent types at once.

JavaScript

const consentIds = [123, 456, 789];
Client.API.Core.Consents.bulkDelete({ ids: consentIds });

TypeScript

import { Response, BulkDeleteConsentPayload } from "@tscommerce/sdk-typescript"

const payload:BulkDeleteConsentPayload = {
    ids: [123, 456, 789]
};

Client.API.Core.Consents.bulkDelete(payload).then((response:Response) => {
    console.log('Consents deleted successfully');
});

PHP

$payload = ['ids' => [123, 456, 789]];
$client->API->Core->Consents->bulkDelete($payload);