orders ordersparcelbatchdocuments (http://api.3plcentral.com/rels/orders/ordersparcelbatchdocuments)
Resource:
Collection: document links for one high volume label batch; nothing is saved
C# Rel Const:
Rels.OrderSvc.OrdersParcelBatchDocuments
URI template:
parcels/ordersparcelbatchdocuments{?batchId,slipTemplateId,slipVersion,slipFormat,uccTemplateId,uccVersion,uccFormat}
Obtain URI from:
Document links for one high volume label batch. Reads PAPI and saves nothing.
The template values are separate arguments. A [FromUri] object would hide them from the
query-key filter, and the auto-batch poll would get 400 NotSupported.
Success status: 200
Name (* = required) Data Type Description
batchId * string
slipTemplateId string
slipVersion int
slipFormat string
uccTemplateId string
uccVersion int
uccFormat string
Type Description
BatchId string
LabelFormat string
DocumentsStatus string
DocumentsCombinedUrl string
DocumentsOtherFormats List<Order.Models.ParcelBatchDocumentFile>
Format string
Url string
PageGroup string "label" when every document in this file fits 4x6, "fullPage" otherwise, null when unknown.
DocumentsMissingOrderIds List<string>
LabelsDownloadUrl string
LabelsDownloadStatus string
Sample accept: application/hal+json
{
  "batchId": "str",
  "labelFormat": "str",
  "documentsStatus": "str",
  "documentsCombinedUrl": "str",
  "documentsOtherFormats": [
    {
      "format": "str",
      "url": "str",
      "pageGroup": "str"
    }
  ],
  "documentsMissingOrderIds": [
    "str"
  ],
  "labelsDownloadUrl": "str",
  "labelsDownloadStatus": "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@extensiv.com with any questions about this documentation.