Rokt

https://docs.rokt.com
Admin
Rokt is an e-commerce marketing platform that uses machine learning to deliver personalized offers,...
Tokens:33,544
Snippets:338
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET deletion requests response example

Source: https://docs.rokt.com/developer-reference/apis/data-deletion-api

Example response for the GET /data/deletion-requests endpoint, returning a list of deletion request objects with their current status.

```json
[
    {
        "taskId": "20675afe-f4e5-4ee6-bfb7-d5fddcffe16d",
        "status": "actioned",
        "deletionType": "emailsDeletion",
        "creationTime": "2022-03-01T11:00:00+11:00",
        "accountId": "3008848650853038987",
        "readyTime": null,
        "actionedTime": null,
        "cancelledTime": null
    }
]
```

--------------------------------

### Sample Request #2 with Quantity

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

Example request using cartItemId and quantity to confirm items.

```http
    POST /v1/cart/confirm  
    {  
        "cartId": "1580265846172",  
        "orderId": "1580265885747",  
        "items": [  
            {  
                "cartItemId": "30d0a389-5f63-4e20-9553-13ff40f8b11c",  
                "quantity": "15"  
            }  
        ]  
    }  
```

--------------------------------

### Initialize Adobe Client Data Layer

Source: https://docs.rokt.com/integration-guides/ecommerce/tag-managers/adobe-experience-platform

Example of initializing the window.adobeDataLayer object and pushing initial user, ecommerce, and event data.

```javascript
window.adobeDataLayer = window.adobeDataLayer || [];  
  
window.adobeDataLayer.push({  
  email: "jenny.smith@rokt.com",  
  user: { firstname: "Jenny", lastname: "Smith" },  
  ecommerce: { transaction: { amount: "12.36" } },  
  event: "page loaded",  
});
```

--------------------------------

### Sample Request for POST /v1/cart/release

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

An example of the JSON payload used to release specific items from a cart.

```json
 POST /v1/cart/release  
    {  
        "cartId": "1580265846172",  
        "items": [  
            {  
                "cartItemId": "30d0a389-5f63-4e20-9553-13ff40f8b11c",  
                "itemReservationId": "rokt_item_reservation_id.63a94103-75da-4d71-8c14-84674d286b98"  
            }  
        ]  
    }  
```

--------------------------------

### Sample Request #1 with Reservation ID

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

Example request using cartItemId and itemReservationId to confirm items.

```http
    POST /v1/cart/confirm  
    {  
        "cartId": "1580265846172",  
        "orderId": "1580265885747",  
        "items": [  
            {  
                "cartItemId": "30d0a389-5f63-4e20-9553-13ff40f8b11c",  
                "itemReservationId": "rokt_item_reservation_id.63a94103-75da-4d71-8c14-84674d286b98"  
            }  
        ]  
    }  
```

--------------------------------

### Create data deletion request example

Source: https://docs.rokt.com/developer-reference/apis/data-deletion-api

Example JSON payload for the POST /data/deletion-requests/emails endpoint. At least one entry across the email lists is required, and sha256Emails must be base64 encoded.

```json
{
  "accountId": "2456192011195196284677",
  "rawEmails": [
    "test@test.com"
  ],
  "sha256Emails": [
    "kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
  ]
}
```

--------------------------------

### Cancel deletion request response example

Source: https://docs.rokt.com/developer-reference/apis/data-deletion-api

Example response for the DELETE /data/deletion-requests/:taskId endpoint indicating a successful cancellation.

```json
{
  "data": {
    "message": "successful cancelled task with taskId: 3bc2e8b0-88ee-400c-8696-44897bc95cd3"
  }
}
```

--------------------------------

### POST Reserve Cart Items Sample Request

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

An example of the JSON payload required to reserve items in a cart.

```json
    POST /v1/cart/reserve  
    {  
        "cartId": "1580265846172",  
        "items": [  
            {  
                "cartItemId": "30d0a389-5f63-4e20-9553-13ff40f8b11c",  
                "quantity": 1  
            }  
        ]  
    }  
```

--------------------------------

### Example data layer with utag_data

Source: https://docs.rokt.com/integration-guides/ecommerce/tag-managers/tealium

Shows how to define a data layer object with email and name attributes. This is the base structure that Tealium uses to share variables with tags.

```javascript
window.utag_data = window.utag_data || {}  
  
utag_data['email_address'] = 'test@test.com'  
utag_data['first_name'] = 'john'  
utag_data['last_name'] = 'doe'  

```

--------------------------------

### Data Layer Path: Email

Source: https://docs.rokt.com/integration-guides/ecommerce/tag-managers/adobe-experience-platform

Example script for pushing an email address to the data layer, resulting in the path name adobeDataLayer.email.

```javascript
window.adobeDataLayer.push({  
  email: "jenny.smith@rokt.com",  
});
```

--------------------------------

### GET /v1/partnership/accounts/{account_id}/marketplacecontrolslists

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Reads the marketplace controls for a managed account. Use this to view which verticals are blocked in your partner taxonomy.

```APIDOC
## GET /v1/partnership/accounts/{account_id}/marketplacecontrolslists

### Description
Reads the marketplace controls for a managed account. Use this to view which verticals are blocked in your partner taxonomy.

### Method
GET

### Endpoint
/v1/partnership/accounts/{account_id}/marketplacecontrolslists

### Parameters
#### Path Parameters
- `account_id` (string) - Required - The managed account identifier.

### Response
#### Success Response (200)
- Marketplace controls list.

```

--------------------------------

### Data Layer Path: Nested User Firstname

Source: https://docs.rokt.com/integration-guides/ecommerce/tag-managers/adobe-experience-platform

Example script for pushing a nested user object, resulting in the path name adobeDataLayer.user.firstname.

```javascript
window.adobeDataLayer.push({  
  user: {  
    firstname: "Jenny",  
  },  
});
```

--------------------------------

### GET /v1/partnership/vertical-mappings

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Retrieves the category taxonomy mappings for the platform. Use this to confirm that your platform's categories have been mapped to Rokt's categories during onboarding.

```APIDOC
## GET /v1/partnership/vertical-mappings

### Description
Retrieves the vertical mappings for the platform. Use this to confirm that your platform's categories have been mapped to Rokt's categories during onboarding.

### Method
GET

### Endpoint
/v1/partnership/vertical-mappings

### Response
#### Success Response (200)
- **mappings** (array) - List of vertical mappings

#### Response Example
{
  "mappings": []
}
```

--------------------------------

### GET /v1/partnership/vertical-mappings

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Returns your seeded category mappings in your own taxonomy. Read-only; Rokt creates the rows. An empty list means nothing is seeded and every register will fail with a 400.

```APIDOC
## GET /v1/partnership/vertical-mappings

### Description
Returns your seeded category mappings in your own taxonomy. Read-only; Rokt creates the rows. An empty list means nothing is seeded and every register will fail with a 400.

### Method
GET

### Endpoint
/v1/partnership/vertical-mappings

### Parameters
#### Query Parameters
- `parent_account_id` (string) - Required - Your parent account identifier.

### Response
#### Success Response (200)
- List of vertical mappings in your own taxonomy.

#### Error Response (400)
- Returned when no mappings are seeded.

```

--------------------------------

### POST Any Placements Sample Request

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

A sample request body for the POST /v1/placements/any endpoint to check for available placements.

```json
POST /v1/placements/any  
{  
    "cartId": "1580265846172",  
    "attributes": {  
        "eventId": "1100526195FA115A",  
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36",  
        "venueName": "Madison Square Garden",  
        "eventdate": "20311212",  
        "country": "US",  
        "locale": "en-US"  
    },  
"pageIdentifier": "checkout.upsell"  
}  
```

--------------------------------

### POST /v1/partnership/accounts/{account_id}/payout-setup

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Initiates Stripe Connect onboarding for a merchant. In V1, Rokt pays the partner-side payout to your manager account, not to individual managed accounts; distributing each merchant's portion is your platform's responsibility.

```APIDOC
## POST /v1/partnership/accounts/{account_id}/payout-setup

### Description
Initiates Stripe Connect onboarding for a merchant. In V1, Rokt pays the partner-side payout to your manager account, not to individual managed accounts; distributing each merchant's portion is your platform's responsibility.

### Method
POST

### Endpoint
/v1/partnership/accounts/{account_id}/payout-setup

### Parameters
#### Path Parameters
- `account_id` (string) - Required - The managed account identifier.

### Response
#### Success Response (200)
- `X-Operation-Id` (string) - Operation ID for polling the long-running operation.

```

--------------------------------

### POST Any Placements Path

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

The path for the POST /v1/Placements/any endpoint.

```text
POST /v1/Placements/any  
```

--------------------------------

### GET /data/deletion-requests

Source: https://docs.rokt.com/developer-reference/apis/data-deletion-api

Returns a list of current (PENDING, READY) and past (ACTIONED, CANCELLED) data deletion requests to verify their status.

```APIDOC
## GET /data/deletion-requests

### Description
Returns a list of current (PENDING, READY) and past (ACTIONED, CANCELLED) data deletion requests to verify their status.

### Method
GET

### Endpoint
https://api.rokt.com/data/deletion-requests

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **taskId** (string) - The unique identifier of the deletion request.
- **status** (string) - The status of the request (e.g., actioned).
- **deletionType** (string) - The type of deletion (e.g., emailsDeletion).
- **creationTime** (string) - The creation timestamp.
- **accountId** (string) - The account identifier.
- **readyTime** (string or null) - The time when the request became ready.
- **actionedTime** (string or null) - The time when the request was actioned.
- **cancelledTime** (string or null) - The time when the request was cancelled.

#### Response Example
[
    {
        "taskId": "20675afe-f4e5-4ee6-bfb7-d5fddcffe16d",
        "status": "actioned",
        "deletionType": "emailsDeletion",
        "creationTime": "2022-03-01T11:00:00+11:00",
        "accountId": "3008848650853038987",
        "readyTime": null,
        "actionedTime": null,
        "cancelledTime": null
    }
]
```

--------------------------------

### POST Any Placements 200 OK Response

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

The successful response structure for the POST /v1/Placements/any endpoint.

```json
{
  "result": true  
}
```

--------------------------------

### POST Any Placements Request Body Schema

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

The required structure for the request body when calling the POST /v1/Placements/any endpoint.

```json
{
  "cartId": "string",  
  "pageIdentifier": "string",  
  "url": "string",  
  "attributes": {  
    "attribute": "string"  
  }  
}
```

--------------------------------

### POST /v1/placements/any

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

Allows the partner to determine whether there are any placements to display, and potentially skip the upsell/cross-sell stage if applicable. Based on whether this returns true or false the partner can choose to show or skip the upsell page in the transaction flow.

```APIDOC
## POST /v1/placements/any

### Description
Allows the partner to determine whether there are any placements to display, and potentially skip the upsell/cross-sell stage if applicable. Based on whether this returns true or false the partner can choose to show or skip the upsell page in the transaction flow.

### Method
POST

### Endpoint
/v1/placements/any

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Headers
- **rokt-api-key** (string) - Required - API authentication key. Example: skeletonkey
- **Content-Type** (string) - Optional - Media type of request, 'application/json' is the only supported value at the moment. Example: application/json
- **Accept** (string) - Optional - Expected media type of response, 'application/json' is the only supported value at the moment. Example: application/json
- **rokt-session-id** (string) - Optional - SessionId used by Rokt internally for tracking, referral, logging and debugging. Optional for this endpoint (sessionId generated if not provided). Example: ca75f48-ebbd-4d8e-83c3-fdd70893294d
- **rokt-tag-id** (string) - Required - Unique Rokt Tag ID. Example: 253_439d21r21r21321
- **Accept-Language** (string) - Optional - Expected locale of the consumer. This can be the full locale including language and country, or a neutral locale which only has the language. When locale is specified only placements and offers that match the locale are included for consideration. Example: en-US

#### Request Body
- **cartId** (string) - Required - The cart ID.
- **pageIdentifier** (string) - Required - The page identifier.
- **url** (string) - Optional - The URL.
- **attributes** (object) - Optional - Additional attributes. Each attribute is a string key-value pair.

### Request Example
```json
{
  "cartId": "1580265846172",
  "attributes": {
    "eventId": "1100526195FA115A",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36",
    "venueName": "Madison Square Garden",
    "eventdate": "20311212",
    "country": "US",
    "locale": "en-US"
  },
  "pageIdentifier": "checkout.upsell"
}
```

### Response
#### Success Response (200)
- **result** (boolean) - Indicates whether there are any placements to display.

#### Response Example
```json
{
  "result": true
}
```

### Error Responses
#### 400 BadRequest
```json
{
  "description": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "value": {}
    }
  ]
}
```

#### 401 Unauthorized
No response body provided.

#### 403 Forbidden
```json
{
  "description": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "value": {}
    }
  ]
}
```

#### 422 UnprocessableEntity
```json
{
  "description": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "value": {}
    }
  ]
}
```

#### 500 InternalServerError
```json
{
  "description": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "value": {}
    }
  ]
}
```

#### 504 GatewayTimeout
```json
{
  "description": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "value": {}
    }
  ]
}
```
```

--------------------------------

### GET /v1/partnership/operations/{operation_id}

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Polls a long-running operation to recover from network timeouts without re-issuing the write. Operation IDs are opaque and only readable by the authorized manager.

```APIDOC
## GET /v1/partnership/operations/{operation_id}

### Description
Polls a long-running operation to recover from network timeouts without re-issuing the write. Operation IDs are opaque and only readable by the authorized manager.

### Method
GET

### Endpoint
/v1/partnership/operations/{operation_id}

### Parameters
#### Path Parameters
- `operation_id` (string) - Required - The operation identifier returned in X-Operation-Id.

### Response
#### Success Response (200)
- Operation status (object) - The current status of the operation.

```

--------------------------------

### PUT /v1/partnership/accounts/{account_id}/marketplacecontrolslists

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Updates the marketplace controls for a managed account. Block verticals in your partner taxonomy; Rokt translates server-side.

```APIDOC
## PUT /v1/partnership/accounts/{account_id}/marketplacecontrolslists

### Description
Updates the marketplace controls for a managed account. Block verticals in your partner taxonomy; Rokt translates server-side.

### Method
PUT

### Endpoint
/v1/partnership/accounts/{account_id}/marketplacecontrolslists

### Parameters
#### Path Parameters
- `account_id` (string) - Required - The managed account identifier.

#### Request Body
- Marketplace controls list (object) - Required - The updated controls.

### Response
#### Success Response (200)
- Updated marketplace controls list.

```

--------------------------------

### GET /v1/partnership/accounts

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Lists all managed accounts for your parent account. A single-account detail endpoint is not yet exposed; use per-resource reads to inspect an individual managed account.

```APIDOC
## GET /v1/partnership/accounts

### Description
Lists all managed accounts for your parent account. A single-account detail endpoint is not yet exposed; use per-resource reads to inspect an individual managed account.

### Method
GET

### Endpoint
/v1/partnership/accounts

### Parameters
#### Query Parameters
- `parent_account_id` (string) - Required - Your parent account identifier.

### Response
#### Success Response (200)
- List of managed accounts.

```

--------------------------------

### Data Layer Path: Deeply Nested Transaction Amount

Source: https://docs.rokt.com/integration-guides/ecommerce/tag-managers/adobe-experience-platform

Example script for pushing a deeply nested ecommerce transaction object, resulting in the path name adobeDataLayer.ecommerce.transaction.amount.

```javascript
window.adobeDataLayer.push({  
  ecommerce: {  
    transaction: {  
      amount: "12.36",  
    },  
  },  
});
```

--------------------------------

### POST /v1/partnership/accounts/{account_id}/pages

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Adds a surface (confirmation, tracking, returns) to an already-onboarded merchant without re-registering.

```APIDOC
## POST /v1/partnership/accounts/{account_id}/pages

### Description
Adds a surface (confirmation, tracking, returns) to an already-onboarded merchant without re-registering.

### Method
POST

### Endpoint
/v1/partnership/accounts/{account_id}/pages

### Parameters
#### Path Parameters
- `account_id` (string) - Required - The managed account identifier.

#### Request Body
- Surface type (string) - Required - The surface to add (confirmation, tracking, returns).
t
### Response
#### Success Response (200)
- `X-Operation-Id` (string) - Operation ID for polling the long-running operation.

```

--------------------------------

### POST /v1/accounts/register/partnership

Source: https://docs.rokt.com/developer-reference/apis/partnerships-api

Registers a merchant under your partnership. Idempotent on external_account_id, which should be your stable, non-sensitive identifier for the merchant.

```APIDOC
## POST /v1/accounts/register/partnership

### Description
Registers a merchant under your partnership. Idempotent on `external_account_id` (your stable identifier for the merchant; keep it non-sensitive; see Idempotency for the uniqueness scope).

### Method
POST

### Endpoint
/v1/accounts/register/partnership

### Parameters
#### Request Body
- `external_account_id` (string) - Required - Your stable identifier for the merchant; must be non-sensitive.

### Response
#### Success Response (200)
- `X-Operation-Id` (string) - Operation ID for polling the long-running operation.

```

--------------------------------

### POST Cancel Purchased Item Sample Request

Source: https://docs.rokt.com/developer-reference/apis/ecommerce/cart-api

A sample request payload for cancelling an item using its reservation ID.

```http
    POST /v1/confirmation/cancel  
    {  
        "itemReservationId": "rokt_item_reservation_id.63a94103-75da-4d71-8c14-84674d286b98"  
    }  
```
Tokens:
Raw