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

›Confirmation

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 Cancel Confirmed Item

Allows the partner to cancel a previously purchased (confirmed) item. Rokt will call the relevant provider to make a cancellation and relay back its response.

Description

Sample request:

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

Request

Path

POST /v1/Confirmation/cancel

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
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
{
"itemReservationId": "string"
}
Object {
itemReservationId: String
}

Response

200 OK

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 Release Cart ItemsPOST Any Placements →
  • Description
  • Request
  • Response
  • Error
RESOURCES
DocumentationUser GuideSDKAPIIntegration PartnersHelp
COMPANY
About UsContact UsCareersEngineering Blog
Rokt Documentation
Copyright © Rokt 2021 - All Rights Reserved