Path: / rest / order / {key}

The order resource

Path parameters:
key - the order key

Resources
NameDescription
attachment
attachment/{name}
An order attachment
comments
consignments
lines
something
statuses

Method Summary
ResourceDescription
GET /rest/order/{key}The order resource
PUT /rest/order/{key}Creates or updates a new order
POST /rest/order/{key} 
DELETE /rest/order/{key} 
HEAD /rest/order/{key} 

Method Detail
HTTP Example:
GET /rest/order/{key}

API Example:

RESTOrders.getOrder({'key': /* orderKey the order key */});

The order resource

Output:
RESTOrdersBean.Order - the order found
Produces:
application/xml
text/plain
HTTP Example:
PUT /rest/order/{key}

API Example:

RESTOrders.putOrder({'key': /* orderKey the order key */,
  '$entity': /* order the order to create or update */});

Creates or updates a new order

Input:
RESTOrdersBean.Order - the order to create or update
Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain
HTTP return codes:
201 - if created
200 - if updated
HTTP Example:
POST /rest/order/{key}

API Example:

RESTOrders.postOrder({});

Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain
HTTP Example:
DELETE /rest/order/{key}

API Example:

RESTOrders.deleteOrder({});

Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain
HTTP Example:
HEAD /rest/order/{key}

API Example:

RESTOrders.headOrder({});

Output:
javax.ws.rs.core.Response
Produces:
application/xml
text/plain