Rokt Documentation
  • Documentation
  • User Guide
  • SDK
  • API
  • Third-Party Integrations
  • Help

›Placements

Getting Started

  • Introduction

Transactions

    Events

    • Overview
    • Authentication
    • POST Events

    Cart

    • Overview
    • POST Reserve Cart Items
    • POST Confirm Cart Items
    • POST Release Cart Items

    Confirmation

    • POST Cancel Confirmed Item

    Placements

    • POST Any Placements

Customer Data

  • Referral Export
  • Transaction Export
  • Custom Audience Import
  • Unsubscribe Import
  • Attributes

Reporting

  • Overview
  • Authentication
  • Account Level

    • GET Account Summary
    • GET Account Campaigns Overview
    • GET Account Campaigns Breakdown
    • GET Account Campaigns Histogram
    • GET Account Transactions Overview
    • GET Account Transactions Breakdown

    Campaign Level

    • GET Campaign Overview
    • GET Campaign Breakdown
    • GET Campaign Histogram

    Creative Level

    • GET Creative Overview
    • GET Creative Breakdown

    Metadata

    • GET Campaign Metadata
    • GET Audience Metadata
    • GET Creative Metadata
    • GET Accounts Metadata

Rokt Calendar

  • Overview
Edit

POST Any Placements

Allows the partner to determine whether there are any placements to display, and potentially skip the upsell stage if applicable.

Description

To decide if it’s worth showing the page containing the Rokt add-to-cart placement. Based on whether this returns true or false the partner can choose to show or skip the upsell page in the transaction flow.

Sample request:

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"
}

Request

Path

POST /v1/Placements/any

Parameters

NameTypeInDescriptionRequiredExample
rokt-api-key headerAPI authentication keytrueskeletonkey
Content-Type headerMedia type of request, 'application/json' is the only supported value at the moment application/json
Accept headerExpected media type of response, 'application/json' is the only supported value at the moment application/json
rokt-session-id headerSessionId used by Rokt internally for tracking, referral, logging and debugging. Optional for this endpoint (sessionId generated if not provided). ca75f48-ebbd-4d8e-83c3-fdd70893294d
rokt-tag-id headerUnique Rokt Tag IDtrue253_439d21r21r21321
Accept-Language headerExpected 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. en-US

Request Body

Example Value
Schema
{
"cartId": "string",
"pageIdentifier": "string",
"url": "string",
"attributes": {
"attribute": "string"
}
}
Object {
cartId: String
pageIdentifier: String
url: String
attributes: Object {
[string]: String
}
}

Response

200 OK

Example Value
Schema
{
"result": true
}
Object {
result: Boolean
}

Error

400 BadRequest

Example Value
Schema
{
"description": "string",
"errors": [
{
"code": "string",
"message": "string",
"value": {}
}
]
}
Object {
description: String
errors: Array [
Object {
code: String
message: String
value: Object {}
}
]
}

401 Unauthorized

403 Forbidden

Example Value
Schema
{
"description": "string",
"errors": [
{
"code": "string",
"message": "string",
"value": {}
}
]
}
Object {
description: String
errors: Array [
Object {
code: String
message: String
value: Object {}
}
]
}

422 UnprocessableEntity

Example Value
Schema
{
"description": "string",
"errors": [
{
"code": "string",
"message": "string",
"value": {}
}
]
}
Object {
description: String
errors: Array [
Object {
code: String
message: String
value: Object {}
}
]
}

500 InternalServerError

Example Value
Schema
{
"description": "string",
"errors": [
{
"code": "string",
"message": "string",
"value": {}
}
]
}
Object {
description: String
errors: Array [
Object {
code: String
message: String
value: Object {}
}
]
}

504 GatewayTimeout

Example Value
Schema
{
"description": "string",
"errors": [
{
"code": "string",
"message": "string",
"value": {}
}
]
}
Object {
description: String
errors: Array [
Object {
code: String
message: String
value: Object {}
}
]
}
← POST Cancel Confirmed ItemReferral Export →
  • Description
  • Request
  • Response
  • Error
RESOURCES
DocumentationUser GuideSDKAPIIntegration PartnersHelp
COMPANY
About UsContact UsCareersEngineering Blog
Rokt Documentation
Copyright © Rokt 2021 - All Rights Reserved