Resource:Collection: of batchC# Rel Const:Rels.OrderSvc.BatchesURI template:batchesObtain URI from:
To create a new batch and optionally add to it orders specified in the BatchCreate model
Success status: 201; ETag response header supplied
Type | Description | |
---|---|---|
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
Description | string | |
OrderIdentifiers | IEnumerable<Generic.Models.OrderIdentifier> | identifies orders to be included in the batch more... |
Id | int |
Sample content-type: application/hal+json |
{ "customerIdentifier": { "externalId": "str", "name": "str", "id": 3 }, "description": "str", "orderIdentifiers": [ { "id": 1 } ] }
Type | Description | |
---|---|---|
ReadOnly | Order.Models.BatchReadOnly | |
BatchOrderId | int | |
CustomerIdentifier | Generic.Models.CustomerIdentifier | |
ExternalId | string | |
Name | string | |
Id | int | |
CreationDate | DateTime | |
Description | string | |
OrderIdentifiers | IEnumerable<Generic.Models.OrderIdentifier> | identifies orders included (GET) or to be included (PUT) in the batch more... |
Id | int | |
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 | |
- edit | Modify the description and/or the list of order ids | |
- /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", "orderIdentifiers": [ { "id": 1 } ] }
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.