Generate Label

post

https://api.orderful.com/v3/labels

Generates a PDF or ZPL file to be used for label printing. For more information, see the Create a Label guide. Supports single label or batch generation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

skipValidation

boolean

Skip validation.

format

string

enum

Output format for the label.

Allowed:

Body Params

Request body for generating a UCC-128 shipping label.

type

string

enum

required

Company/format to generate a label for.

shipFrom

object

Ship from address.

shipTo

object

Ship to address.

vendor

object

Vendor related information.

store

object

Store related information.

distributionCenter

object

Distribution center related information.

carrier

object

Carrier related information.

shipment

object

Shipment related information.

department

object

Department related information.

purchaseOrder

object

Purchase order related information.

pallet

object

Pallet related information.

case

object

Case related information.

carton

object

Carton related information.

item

object

Item related information.

merchandise

object

Merchandise related information.

optionalInformation

string

Optional information.

Headers

orderful-api-key

string

required

Your Orderful API key.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Label generated successfully.