REL documentation
orders summaries (http://api.3plcentral.com/rels/orders/summaries)
Resource:
order short synopsis
C# Rel Const:
Rels.OrderSvc.Summaries
URI template:
summaries{?pgsiz,pgnum,rql,sort,orderidcontains,receiverid}
Obtain URI from:
Billboard , /rels/inventory/receiver , /rels/inventory/receiverdigests , /rels/orders/batch , /rels/orders/batchsummary
Get short synopsis of orders.
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
orderidcontains string matches any part of an order id, such as "53" matches order ids 7653, 7536 and 5376
receiverid int
Type Description
TotalResults int
ResourceList IList<Order.Models.OrderSummary>
OrderId int
ReferenceNum string
PoNum string
FullyAllocated bool
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
CreationDate DateTime? ...
IsClosed bool
Links IList<WebApi.Hal.Link>
- /rels/orders/order
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "item": [
      {
        "orderId": 1,
        "referenceNum": "str",
        "poNum": "str",
        "fullyAllocated": true,
        "customerIdentifier": {
          "externalId": "str",
          "name": "str",
          "id": 3
        },
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "creationDate": "2016-12-25T23:00:00",
        "isClosed": true
      }
    ]
  }
}

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.