REL documentation
orders ordercancel (http://api.3plcentral.com/rels/orders/ordercancel)
Resource:
Operator: cancel order
C# Rel Const:
Rels.OrderSvc.OrderCancel
URI template:
{id}/canceler
Obtain URI from:
/rels/orders/order
Cancel an open order.
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int order id
Type Description
Reason string required
Charge decimal? ... optional
InvoiceCreationInfo Generic.Models.InvoiceCreationInfo Leave null unless creating invoice
SetInvoiceDate bool
UtcOffset int hours offset from Coordinated Universal Time at the browser, for example -7 if in MST
Sample content-type: application/hal+json
 
{
  "reason": "str",
  "charge": 1.0,
  "invoiceCreationInfo": {
    "setInvoiceDate": true,
    "utcOffset": 2
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.