REL documentation
orders batch (http://api.3plcentral.com/rels/orders/batch)
Resource:
order batch, with list of included orders
C# Rel Const:
Rels.OrderSvc.Batch
URI template:
batches/{id}
Obtain URI from:
/rels/orders/batchfilesummaries , /rels/orders/batchsummary , /rels/orders/order , /rels/orders/digests , /rels/orders/digestbriefs
Get the batch including a list of the order ids included in the 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
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
Sample accept: application/hal+json
{
  "readOnly": {
    "batchOrderId": 1,
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "creationDate": "2016-12-25T23:00:00"
  },
  "description": "str",
  "orderIdentifiers": [
    {
      "id": 1
    }
  ]
}
To modify the description of the batch and/or the list of orders included in the 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
OrderIdentifiers IEnumerable<Generic.Models.OrderIdentifier> identifies orders included (GET) or to be included (PUT) in the batch more...
Id int
Sample content-type: application/hal+json
 
{
  "readOnly": {
    "batchOrderId": 1,
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "creationDate": "2016-12-25T23:00:00"
  },
  "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
Sample accept: application/hal+json
{
  "readOnly": {
    "batchOrderId": 1,
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "creationDate": "2016-12-25T23:00:00"
  },
  "description": "str",
  "orderIdentifiers": [
    {
      "id": 1
    }
  ]
}
To remove all orders from a batch and delete the batch
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.