REL documentation
orders ordersparcelshippinglabelhighvolume (http://api.3plcentral.com/rels/orders/ordersparcelshippinglabelhighvolume)
Resource:
Collection: async process for high volume shipping
C# Rel Const:
Rels.OrderSvc.OrdersParcelShippingLabelHighVolume
URI template:
parcels/ordersparcelshippinglabelhighvolume{?labelFormat,includeReturnLabels,batchName,callbackSchemaAndAuthority,shipDate,papiTemplateId,papiTemplateVersion,papiSlipScope,papiSlipFormat,papiUcc128TemplateId,papiUcc128TemplateVersion,papiUcc128Format}
Obtain URI from:
Billboard
Get parcel shipping label(s) for orders
Success status: 204
Name Data Type Description
labelFormat Common.Enum.LabelFormatType specify which label format to request. (default: zpl)
- Zpl
- Png
- Pdf
includeReturnLabels bool include return label along with shipping label
batchName string name to apply to batch
callbackSchemaAndAuthority string the base url for the callback that will update orders, likely a urlencoded https://secure-wms.com
shipDate DateTime specify the date they will be shipped
papiTemplateId string PAPI packing slip template id when usePapiPackingSlips is enabled
papiTemplateVersion int PAPI packing slip template version when usePapiPackingSlips is enabled
papiSlipScope string PAPI packing slip scope (shipment or package) when usePapiPackingSlips is enabled
papiSlipFormat string PAPI packing slip format (pdf or zpl) when usePapiPackingSlips is enabled
papiUcc128TemplateId string PAPI UCC-128 carton template id when usePapiUcc128 is enabled
papiUcc128TemplateVersion int PAPI UCC-128 carton template version when usePapiUcc128 is enabled
papiUcc128Format string PAPI UCC-128 carton format (pdf or zpl) when usePapiUcc128 is enabled
specify the orders to be gotten
Type Description
OrderIdentifiers IEnumerable<Generic.Models.OrderIdentifier> identifies orders to be affected
Id int
Sample content-type: application/hal+json
 
{
  "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@extensiv.com with any questions about this documentation.