orders ordersparcelbatches (http://api.3plcentral.com/rels/orders/ordersparcelbatches)
Resource:
Collection: request a list of batches
C# Rel Const:
Rels.OrderSvc.OrdersParcelBatches
URI template:
parcels/ordersparcelbatches{?startDate,endDate,includeOrderPackages}
Obtain URI from:
Get a list of high volume shipment batches
Success status: 200
Name Data Type Description
startDate string
endDate string
includeOrderPackages bool
Type Description
ParcelBatches IEnumerable<Order.Models.ParcelBatch>
LabelLayout string
LabelFormat string
BatchId string
ExternalBatchId string
BatchNotes string
Customer string
Facility string
OrderIds string
CreatedAt string
ProcessedAt string
DoneDate string
Errors int
Warnings int
Completed int
Forms int
Count int
RemovedErrorOrders string
BatchShipmentsUrl string
BatchLabelsUrl string
BatchErrorsUrl string
LabelDownloadPdf string
LabelDownloadZpl string
FormDownload string
Status string
CloseOrders bool
WtIdsToClose List<int>
FailedOrderIds List<string>
OrderData List<Order.Models.BatchOrderData>
OrderId int? ...
PackageCount int
IsPackageSplit bool
IsFailed bool
Sample accept: application/hal+json
{
  "parcelBatches": [
    {
      "labelLayout": "str",
      "labelFormat": "str",
      "batchId": "str",
      "externalBatchId": "str",
      "batchNotes": "str",
      "customer": "str",
      "facility": "str",
      "orderIds": "str",
      "createdAt": "str",
      "processedAt": "str",
      "doneDate": "str",
      "errors": 12,
      "warnings": 13,
      "completed": 14,
      "forms": 15,
      "count": 16,
      "removedErrorOrders": "str",
      "batchShipmentsUrl": "str",
      "batchLabelsUrl": "str",
      "batchErrorsUrl": "str",
      "labelDownloadPdf": "str",
      "labelDownloadZpl": "str",
      "formDownload": "str",
      "status": "str",
      "closeOrders": true,
      "wtIdsToClose": [
        1
      ],
      "failedOrderIds": [
        "str"
      ],
      "orderData": [
        {
          "orderId": 1,
          "packageCount": 1,
          "isPackageSplit": true,
          "isFailed": 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.