Mercedes.Agency.Orchestration.API

<back to all web services

CancelOrderVoucherRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/order/voucher/cancelCancel order voucher usageCancels the voucher usage for an order
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CancelOrderVoucherResponse:
    success: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CancelOrderVoucherRequest(IPut):
    order_id: int = 0

Python CancelOrderVoucherRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/order/voucher/cancel HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelOrderVoucherRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Orders">
  <OrderId>0</OrderId>
</CancelOrderVoucherRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CancelOrderVoucherResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
  <Success>false</Success>
</CancelOrderVoucherResponse>