REL documentation
orders batchsummaries (http://api.3plcentral.com/rels/orders/batchsummaries)
Resource:
Collection: of batchsummary
C# Rel Const:
Rels.OrderSvc.BatchSummaries
URI template:
batchsummaries{?pgsiz,pgnum,rql,sort,open,facilityId}
Obtain URI from:
Billboard
Get a list of batches
Success status: 200
Name Data Type Description
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
open bool include only batches whose members are open or closed within the past week (true) or closed before the past week (false)
facilityId int include only batches whose members are for this facility
Type Description
TotalResults int
ResourceList IList<Order.Models.BatchSummary>
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
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/orders/batchsummary": [
      {
        "readOnly": {
          "batchOrderId": 1,
          "customerIdentifier": {
            "externalId": "str",
            "name": "str",
            "id": 3
          },
          "creationDate": "2016-12-25T23:00:00"
        },
        "description": "str"
      }
    ]
  }
}

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.