Download 4x6 shipment labels (PDF)

POST/v1/api/store/{team_slug}/shipment/export_label

v1Operation ID v1_public_shipment_export_label

Returns one PDF of 4" x 6" shipment labels (ship-from and ship-to addresses and a barcode), one per shipment, made while you wait.

Permission

Any member of the team. No sales order permission is checked.

Business rules

• Send between 1 and 100 shipment ids as [{ "id": ... }]. More than 100 is a 422 limit_reached ("we only allow export of 100 shipments at a time").
• Ids that aren't your team's shipments are skipped; when none is left the reply is 404 shipment_not_found.
• These are YoPrint documents (addresses and barcode), not carrier postage labels. Carrier labels come from Download labels as one PDF.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

The body is an array of objects.

• idstringrequired

  The hash id of one of the shipments.

Response

200The labels as a PDF, shown inline (Content-Disposition: inline).

The answer is a file (application/pdf), not JSON. The example saves it with curl -o.

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  None of the ids is a shipment of your team (shipment_not_found).

  Fix

  Send shipment hash ids from Filter shipments.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  More than 100 ids (limit_reached), or an item without a valid id.

  Fix

  Send at most 100 { "id": ... } objects.

Related

• POSTDownload letter-size shipment labels (PDF)/v1/api/store/{team_slug}/shipment/export_label_full
• POSTDownload packing slips (PDF)/v1/api/store/{team_slug}/shipment/export_packing_slip

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/shipment/export_label' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '[    {      "id": "MQyJUnd3oty75h"    },    {      "id": "dNJl954DcXrrND"    }  ]' \  -o document.pdf

Example response 200

A application/pdf file.