Resource:order batch, no list of included ordersC# Rel Const:Rels.OrderSvc.BatchSummaryURI template:batchsummaries/{id}Obtain URI from:
Get an existing batch
Success status: 200; ETag response header supplied
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | batch id |
Type | Description | |
---|---|---|
ReadOnly | Order.Models.BatchReadOnly | |
BatchOrderId | int | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
CreationDate | DateTime | |
Description | string | |
Links | IList<WebApi.Hal.Link> | |
- /rels/orders/summaries | summaries of orders in the batch | |
- /rels/orders/digests | digests of orders in the batch | |
- /rels/orders/orders | orders in the batch | |
- /rels/orders/batch | Get the batch including order ids | |
- edit | Modify the description | |
- /rels/orders/batchfilesummaries | info on files attached to batch |
{ "readOnly": { "batchOrderId": 1, "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "creationDate": "2016-12-25T23:00:00" }, "description": "str" }
To update the description of a batch
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | batch id |
Type | Description | |
---|---|---|
ReadOnly | Order.Models.BatchReadOnly | |
BatchOrderId | int | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
CreationDate | DateTime | |
Description | string |
Sample content-type: application/hal+json |
{ "readOnly": { "batchOrderId": 1, "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "creationDate": "2016-12-25T23:00:00" }, "description": "str" }
Type | Description | |
---|---|---|
ReadOnly | Order.Models.BatchReadOnly | |
BatchOrderId | int | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
CreationDate | DateTime | |
Description | string | |
Links | IList<WebApi.Hal.Link> | |
- /rels/orders/summaries | summaries of orders in the batch | |
- /rels/orders/digests | digests of orders in the batch | |
- /rels/orders/orders | orders in the batch | |
- /rels/orders/batch | Get the batch including order ids | |
- edit | Modify the description | |
- /rels/orders/batchfilesummaries | info on files attached to batch |
{ "readOnly": { "batchOrderId": 1, "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "creationDate": "2016-12-25T23:00:00" }, "description": "str" }
To remove all orders from a batch and delete the batch
If-Match request header required; Success status: 204
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | batch id |
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.