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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Order
*/
@Api(Description="Order")
@ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=TokenDto::class, StatusCode=202)
open class UpdateOrderClientProcessed
{
    /**
    * Order ID or Token
    */
    @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
    open var orderId:UUID? = null

    /**
    * Customer order reference in destination system
    */
    @ApiMember(Description="Customer order reference in destination system")
    open var customerReference:String? = null

    /**
    * Date and Time order was processed in destination system
    */
    @ApiMember(Description="Date and Time order was processed in destination system")
    open var customerProcessedDate:Date? = null
}

open class TokenDto : ICommandResponse
{
    open var token:UUID? = null
}

Kotlin UpdateOrderClientProcessed DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

{}