DX STF Client API

<back to all web services

UpdateOrderClientProcessed

Order Requests

Order

Requires Authentication
The following routes are available for this service:
PUT/api/order/{OrderId}/processedUpdate order as customer processed, will also acknowledge order if not yet set.
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 TokenDto(ICommandResponse):
    token: Optional[str] = None


# @Api(Description="Order")
# @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof(TokenDto), StatusCode=202)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateOrderClientProcessed:
    """
    Order
    """

    # @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
    order_id: Optional[str] = None
    """
    Order ID or Token
    """


    # @ApiMember(Description="Customer order reference in destination system")
    customer_reference: Optional[str] = None
    """
    Customer order reference in destination system
    """


    # @ApiMember(Description="Date and Time order was processed in destination system")
    customer_processed_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Date and Time order was processed in destination system
    """

Python UpdateOrderClientProcessed DTOs

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

HTTP + OTHER

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

PUT /api/order/{OrderId}/processed HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}