Label

Generate Label

Changed on Nov 3, 2026

Generates a PDF or ZPL file to be used for label printing. For more information, see the <a href="https://docs.orderful.com/docs/generate-shipping-label" target="_blank">Create a Label guide</a>. Supports single label or batch generation.

post/v3/labels

Request

Base URL
https://api.orderful.com
Auth
API key in header orderful-api-key
TypeScript
https://skmtc.dev/orderful/apis/orderful-api/docs/v3/labels/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

skipValidationboolean

Skip validation.

format'zpl' | 'pdf'

Output format for the label.

Headers

orderful-api-keystring required

Your Orderful API key.

Request body

Response

Label generated successfully.

string required

ZPL label content.

string binary required

PDF label content.

Changes

Nov 3, 2026fe0e82430746 Revision changes
- breaking
  removed the enum value BACKCOUNTRY_SINGLE_CARTON of the request property /
- breaking
  removed the enum value BACKCOUNTRY_SINGLE_CARTON of the request property //
- breaking
  removed the enum value UNIFIRST_CORPORATION of the request property /
- breaking
  removed the enum value UNIFIRST_CORPORATION of the request property //
- info
  added the new ADVANCEAUTOPARTS_ANY_CARTON enum value to the request property /
- info
  added the new ADVANCEAUTOPARTS_ANY_CARTON enum value to the request property //
- info
  added the new ADVANCEAUTOPARTS_ANY_PALLET enum value to the request property /
- info
  added the new ADVANCEAUTOPARTS_ANY_PALLET enum value to the request property //
- info
  added the new BACKCOUNTRY_ANY_CARTON enum value to the request property /
- info
  added the new BACKCOUNTRY_ANY_CARTON enum value to the request property //
- info
  added the new BLUEMERCURY_ANY_ANY enum value to the request property /
- info
  added the new BLUEMERCURY_ANY_ANY enum value to the request property //
- info
  added the new CREDO_SINGLE_CARTON enum value to the request property /
- info
  added the new CREDO_SINGLE_CARTON enum value to the request property //
- info
  added the new CVS_SINGLE_CARTON enum value to the request property /
- info
  added the new CVS_SINGLE_CARTON enum value to the request property //
- info
  added the new DOITBEST_SINGLE_CARTON enum value to the request property /
- info
  added the new DOITBEST_SINGLE_CARTON enum value to the request property //
- info
  added the new DOT_FOODS_ANY enum value to the request property /
- info
  added the new DOT_FOODS_ANY enum value to the request property //
- info
  added the new DUNHAMS_SINGLE_CARTON enum value to the request property /
- info
  added the new DUNHAMS_SINGLE_CARTON enum value to the request property //
- info
  added the new FGLSPORTS_MULTI_MARK_FOR_STORE_CARTON enum value to the request property /
- info
  added the new FGLSPORTS_MULTI_MARK_FOR_STORE_CARTON enum value to the request property //
- info
  added the new FGLSPORTS_SINGLE_CARTON enum value to the request property /
- info
  added the new FGLSPORTS_SINGLE_CARTON enum value to the request property //
- info
  added the new FGLSPORTS_SINGLE_MARK_FOR_STORE_CARTON enum value to the request property /
- info
  added the new FGLSPORTS_SINGLE_MARK_FOR_STORE_CARTON enum value to the request property //
- info
  added the new GROVE_CARTON_SINGLE enum value to the request property /
- info
  added the new GROVE_CARTON_SINGLE enum value to the request property //
- info
  added the new GROVE_PALLET_MIXED enum value to the request property /
- info
  added the new GROVE_PALLET_MIXED enum value to the request property //
- info
  added the new GROVE_PALLET_SINGLE enum value to the request property /
- info
  added the new GROVE_PALLET_SINGLE enum value to the request property //
- info
  added the new Genesco - Journey enum value to the request property /
- info
  added the new Genesco - Journey enum value to the request property //
- info
  added the new Genesco - Journey non Footware enum value to the request property /
- info
  added the new Genesco - Journey non Footware enum value to the request property //
- info
  added the new LOVES_MULTI_PALLET enum value to the request property /
- info
  added the new LOVES_MULTI_PALLET enum value to the request property //
- info
  added the new LOVES_SINGLE_CARTON enum value to the request property /
- info
  added the new LOVES_SINGLE_CARTON enum value to the request property //
- info
  added the new LOVES_SINGLE_PALLET enum value to the request property /
- info
  added the new LOVES_SINGLE_PALLET enum value to the request property //
- info
  added the new MARKS_ANY_CARTON enum value to the request property /
- info
  added the new MARKS_ANY_CARTON enum value to the request property //
- info
  added the new MCLANE_ANY_CARTON enum value to the request property /
- info
  added the new MCLANE_ANY_CARTON enum value to the request property //
- info
  added the new MCLANE_ANY_PALLET enum value to the request property /
- info
  added the new MCLANE_ANY_PALLET enum value to the request property //
- info
  added the new MCLANE_TRACEABLE_CARTON enum value to the request property /
- info
  added the new MCLANE_TRACEABLE_CARTON enum value to the request property //
- info
  added the new MEIJER_MULTI_ANY enum value to the request property /
- info
  added the new MEIJER_MULTI_ANY enum value to the request property //
- info
  added the new MUSCLE_FOODS enum value to the request property /
- info
  added the new MUSCLE_FOODS enum value to the request property //
- info
  added the new Macys Level-Any enum value to the request property /
- info
  added the new Macys Level-Any enum value to the request property //
- info
  added the new NATIONSBESTSPORTS_SINGLE_CARTON enum value to the request property /
- info
  added the new NATIONSBESTSPORTS_SINGLE_CARTON enum value to the request property //
- info
  added the new PETSUPERMARKET enum value to the request property /
- info
  added the new PETSUPERMARKET enum value to the request property //
- info
  added the new PETSUPPLIESPLUS_SINGLE_CARTON enum value to the request property /
- info
  added the new PETSUPPLIESPLUS_SINGLE_CARTON enum value to the request property //
- info
  added the new RIVIANA_SINGLE_PALLET enum value to the request property /
- info
  added the new RIVIANA_SINGLE_PALLET enum value to the request property //
- info
  added the new STAPLESCANADA_SINGLE_CARTON enum value to the request property /
- info
  added the new STAPLESCANADA_SINGLE_CARTON enum value to the request property //
- info
  added the new STAPLESCANADA_SINGLE_PALLET enum value to the request property /
- info
  added the new STAPLESCANADA_SINGLE_PALLET enum value to the request property //
- info
  added the new SURLATABLE_SINGLE_CARTON enum value to the request property /
- info
  added the new SURLATABLE_SINGLE_CARTON enum value to the request property //
- info
  added the new UNIFIRST_SINGLE_CARTON enum value to the request property /
- info
  added the new UNIFIRST_SINGLE_CARTON enum value to the request property //
- info
  added the new VAILRESORTS_CARTON_MULTI enum value to the request property /
- info
  added the new VAILRESORTS_CARTON_MULTI enum value to the request property //
- info
  added the new VAILRESORTS_CARTON_SINGLE enum value to the request property /
- info
  added the new VAILRESORTS_CARTON_SINGLE enum value to the request property //
- info
  added the new WALMART_CANADA_CARTON_MIXED enum value to the request property /
- info
  added the new WALMART_CANADA_CARTON_MIXED enum value to the request property //
- info
  added the new WALMART_CANADA_CARTON_SINGLE enum value to the request property /
- info
  added the new WALMART_CANADA_CARTON_SINGLE enum value to the request property //
- info
  added the new WALMART_CANADA_PALLET_MIXED enum value to the request property /
- info
  added the new WALMART_CANADA_PALLET_MIXED enum value to the request property //
- info
  added the new WALMART_CANADA_PALLET_SINGLE enum value to the request property /
- info
  added the new WALMART_CANADA_PALLET_SINGLE enum value to the request property //
- info
  added the new WALMART_CA_CARTON_MIXED_CALGARY_7101 enum value to the request property /
- info
  added the new WALMART_CA_CARTON_MIXED_CALGARY_7101 enum value to the request property //
- info
  added the new WALMART_CA_CARTON_MIXED_CORNWALL_7103 enum value to the request property /
- info
  added the new WALMART_CA_CARTON_MIXED_CORNWALL_7103 enum value to the request property //
- info
  added the new WALMART_CA_CARTON_MIXED_MISSISSAUGA_7102 enum value to the request property /
- info
  added the new WALMART_CA_CARTON_MIXED_MISSISSAUGA_7102 enum value to the request property //
- info
  added the new WALMART_CA_CARTON_SINGLE_CALGARY_7101 enum value to the request property /
- info
  added the new WALMART_CA_CARTON_SINGLE_CALGARY_7101 enum value to the request property //
- info
  added the new WALMART_CA_CARTON_SINGLE_CORNWALL_7103 enum value to the request property /
- info
  added the new WALMART_CA_CARTON_SINGLE_CORNWALL_7103 enum value to the request property //
- info
  added the new WALMART_CA_CARTON_SINGLE_MISSISSAUGA_7102 enum value to the request property /
- info
  added the new WALMART_CA_CARTON_SINGLE_MISSISSAUGA_7102 enum value to the request property //
- info
  added the new WALMART_CA_PALLET_MIXED_CORNWALL_7103 enum value to the request property /
- info
  added the new WALMART_CA_PALLET_MIXED_CORNWALL_7103 enum value to the request property //
- info
  added the new WALMART_CA_PALLET_SINGLE_CORNWALL_7103 enum value to the request property /
- info
  added the new WALMART_CA_PALLET_SINGLE_CORNWALL_7103 enum value to the request property //
- info
  added the new WALMART_CA_PLT_MIXED_CALGARY_7101 enum value to the request property /
- info
  added the new WALMART_CA_PLT_MIXED_CALGARY_7101 enum value to the request property //
- info
  added the new WALMART_CA_PLT_MIXED_MISSISSAUGA_7102 enum value to the request property /
- info
  added the new WALMART_CA_PLT_MIXED_MISSISSAUGA_7102 enum value to the request property //
- info
  added the new WALMART_CA_PLT_SINGLE_CALGARY_7101 enum value to the request property /
- info
  added the new WALMART_CA_PLT_SINGLE_CALGARY_7101 enum value to the request property //
- info
  added the new WALMART_CA_PLT_SINGLE_MISSISSAUGA_7102 enum value to the request property /
- info
  added the new WALMART_CA_PLT_SINGLE_MISSISSAUGA_7102 enum value to the request property //
- info
  added the new WILLIAMSSONOMA_SINGLE_CARTON enum value to the request property /
- info
  added the new WILLIAMSSONOMA_SINGLE_CARTON enum value to the request property //

Operation history