orders batches (http://api.3plcentral.com/rels/orders/batches)
Resource:
Collection: of batch
C# Rel Const:
Rels.OrderSvc.Batches
URI template:
batches
Obtain 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
none
a batch create object
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
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
    }
  ]
}

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.