Skip to main content

POST Cancel Purchased 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

NameInDescriptionRequiredExample
rokt-api-keyheaderAPI authentication keytrueskeletonkey
Content-TypeheaderMedia type of request, 'application/json' is the only supported value at the moment application/json
AcceptheaderExpected media type of response, 'application/json' is the only supported value at the moment application/json
Accept-LanguageheaderExpected 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

{  "itemReservationId": "string"}

Response#

200 OK

Error#

400 BadRequest

{  "description": "string",  "errors": [    {      "code": "string",      "message": "string",      "value": {}    }  ]}

401 Unauthorized

403 Forbidden

{  "description": "string",  "errors": [    {      "code": "string",      "message": "string",      "value": {}    }  ]}

422 UnprocessableEntity

{  "description": "string",  "errors": [    {      "code": "string",      "message": "string",      "value": {}    }  ]}

500 InternalServerError

{  "description": "string",  "errors": [    {      "code": "string",      "message": "string",      "value": {}    }  ]}

504 GatewayTimeout

{  "description": "string",  "errors": [    {      "code": "string",      "message": "string",      "value": {}    }  ]}
Was this article helpful?