SHshipengine
batches

Process Batch ID Labels

Changed on

Process Batch ID Labels

post/v1/batches/{batch_id}/process/labels

Request

  • Base URL
    https://api.shipengine.com
  • URL
    https://api.shipengine.com/v1/batches/{batch_id}/process/labels
  • Auth
    API key in header API-Key

Request body

ship_datestring date-time

An ISO 8601 string that represents a date and time.

label_layout'4x6' | 'letter' | 'A4' | 'A6'

The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.

label_format'pdf' | 'png' | 'zpl'

The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.

Label FormatSupported Carriers
pdfAll carriers
pngfedex <br> stamps_com <br> ups <br> usps
zplaccess_worldwide <br> apc <br> asendia <br> dhl_global_mail <br> dhl_express <br> dhl_express_australia <br> dhl_express_canada <br> dhl_express_worldwide <br> dhl_express_uk <br> dpd <br> endicia <br> fedex <br> fedex_uk <br> firstmile <br> imex <br> newgistics <br> ontrac <br> rr_donnelley <br> stamps_com <br> ups <br> usps
display_scheme'label' | 'paperless' | 'label_and_paperless'

The display format that the label should be shown in.

Example request

{
  "ship_date": "2018-09-23T15:00:00.000Z"
}

Response

The request was successful.

string required

Changes

  • b81c65818a89Revision changes
    • breaking

      removed the enum value label_and_qr_code of the request property /

    • breaking

      removed the enum value qr_code of the request property /

  • 97d4f65fe53dRevision changes
    • info

      added the new A4 enum value to the request property /

    • info

      added the new A6 enum value to the request property /