API referenceOrder
Cancels an order.
The client cancels its order while it is Booked or changes are requested from the client. The publisher cancels an order while it is On review, which is also how it accepts a cancellation request; declineReason tells the client why. The reserved amount goes back to the client's balance. In any other status the answer is 422 with the reason. The other side's webhook receives order.updated with the reason canceled.
POST
/api/orders/{id}/cancelcurl -X POST "/api/orders/{id}/cancel" \
-H "apikey: $MEDIALISTER_CLIENT_API_KEY" \
-H "Content-Type: application/ld+json" \
-d '{
"declineReason": "Decline reason"
}'Authorization
apikeystringheaderrequiredValue for the apikey header parameter.
Parameters
idstringpathrequiredOrder identifier
Body
application/ld+json
The new Order resource
declineReasonstring
Response
application/ld+json
Order resource created
@contextone of@idstringrequired@typestringrequiredidstring<uuid>publishDatestring<date-time> | nullpublishOptionstringDefault:0mediaFormatFormat.jsonld-all.read_order.readstatusenum<integer>One of:01234567Default:0hasClientMessagebooleanDefault:falselinkToContentstring<uri> | nullcontentRevisionContent.jsonld-all.read_order.read | nullamountstringDefault:0paymentFeestringDefault:0incomeFeestringDefault:0currencyCurrency.jsonld-all.read_order.readconversationConversation.jsonld-all.read_order.read | nullnotificationsmap of integer | nullconditionsAcceptedAtstring<date-time> | nulloptionsmap of stringextraOptionsmap of stringotherOptionsmap of stringconditionsAcceptedbooleanDefault:falsenewAmountobjectamountDifferenceBigDecimal.jsonld-all.read_order.read | nullremainingAmountBigDecimal.jsonld-all.read_order.read | nullorderModeratorOrderModerator.jsonld-all.read_order.read | nullcancellationRequestedbooleanSingle source of truth for a pending cancellation request.
Default:falseextrasOrderExtra.jsonld-all.read_order.read[]sensitiveTopicsOrderSensitiveTopicsDto.jsonld-all.read_order.read | nullcreatedAtstring<date-time>updatedAtstring<date-time>publicIdstring | nullinitialPublishDatestring<date-time> | nulltextStatusstringcampaignIdstring<uuid> | nulltotalBigDecimal.jsonld-all.read_order.readfreebooleanreplacedByOrderstring<iri-reference> | null
{
"@context": "string",
"@id": "string",
"@type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"publishDate": "2026-01-15T09:30:00Z",
"publishOption": "0",
"mediaFormat": {
"@context": "string",
"@id": "string",
"@type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"formatType": "/api/format_types/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
"mediaProject": "/api/media_projects/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
"price": 100.1,
"desiredPrice": "string",
"urlExamples": [
"string"
],
"otherOptions": {
"key": "string"
},
"descriptions": [
"string"
],
"currency": "/api/currencies/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
"listed": false,
"byRequest": false,
"turnAroundTime": 0,
"sensitiveTopics": {
"enabled": [
"string"
],
"disabled": [
"string"
],
"bookable": [
"string"
]
},
"notificationsCount": 0,
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z",
"numericPrice": 0,
"options": {
"key": "string"
},
"visible": true,
"createdAtTimestamp": 0,
"updatedAtTimestamp": 0,
"status": 0
},
"status": 0,
"hasClientMessage": false,
"linkToContent": "https://example.com",
"contentRevision": {
"@context": "string",
"@id": "string",
"@type": "string",
"title": "Content Title",
"body": "<div><p>Lorem Ipsum <a href='#'>Link</a></p><img src='https://picsum.photos/200/300' alt='sample1'/><img src='https://picsum.photos/300/200' alt='sample2'/><a href='https://aaa.bbb' title='Title'>Link</a></div>",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z"
},
"amount": "0",
"paymentFee": "0",
"incomeFee": "0",
"currency": {
"@context": "string",
"@id": "string",
"@type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"symbol": "string",
"type": "fiat",
"decimals": 2
},
"conversation": {
"@context": "string",
"@id": "string",
"@type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z"
},
"notifications": {
"key": 0
},
"conditionsAcceptedAt": "2026-01-15T09:30:00Z",
"options": {
"key": "string"
},
"extraOptions": {
"key": "string"
},
"otherOptions": {
"key": "string"
},
"conditionsAccepted": false,
"newAmount": {
"total": "100.00",
"amount": "85.00",
"fee": "85.00"
},
"amountDifference": {},
"remainingAmount": {},
"orderModerator": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z"
},
"cancellationRequested": false,
"extras": [
{
"@context": "string",
"@id": "string",
"@type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"description": "string",
"price": "string",
"currency": {
"@context": "string",
"@id": "string",
"@type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"symbol": "string",
"type": "fiat",
"decimals": 2
},
"paymentFee": "string",
"incomeFee": "string",
"status": 0,
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z",
"desiredPrice": {},
"earnings": {},
"total": {},
"orderExtraTotalPrice": {},
"extraType": 0,
"orderPublicId": "string"
}
],
"sensitiveTopics": {
"enabled": [
"string"
],
"bookable": [
"string"
],
"extra": [
"string"
],
"disabled": [
"string"
]
},
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z",
"publicId": "string",
"initialPublishDate": "2026-01-15T09:30:00Z",
"textStatus": "ON_REVIEW",
"campaignId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"total": {},
"free": true,
"replacedByOrder": "https://example.com/"
}