Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"recipient",
"items"
],
"properties": {
"gift": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Gift message text."
},
"subject": {
"type": "string",
"description": "Gift message title."
}
},
"description": "Gift message for the packing slip."
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity"
],
"properties": {
"sku": {
"type": "string",
"description": "Your SKU."
},
"name": {
"type": "string",
"description": "Display name on the packing slip."
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of a file already in the File Library. Give url or id."
},
"url": {
"type": "string",
"description": "Public URL of the print file. Give url or id."
},
"type": {
"type": "string",
"description": "Placement / role of the file, e.g. default, front, back, preview (see the catalog product's files)."
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"value"
],
"properties": {
"id": {
"type": "string",
"description": "Option id, e.g. stitch_color or thread_colors."
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Option value."
}
}
},
"description": "Additional file options."
},
"filename": {
"type": "string",
"description": "File name."
}
}
},
"description": "Print files (needed with a plain catalog variant_id)."
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"value"
],
"properties": {
"id": {
"type": "string",
"description": "Option id, e.g. stitch_color or thread_colors."
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Option value."
}
}
},
"description": "Product options, e.g. embroidery thread colors."
},
"quantity": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Quantity (max 1000 per item)."
},
"variant_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Catalog variant id (then give files)."
},
"external_id": {
"type": "string",
"description": "Your line-item id."
},
"retail_price": {
"type": "string",
"description": "Retail price shown on the packing slip, e.g. \"29.99\"."
},
"sync_variant_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Sync Variant id from your Printful store."
},
"external_variant_id": {
"type": "string",
"description": "Your platform's variant id for a Sync Variant."
},
"product_template_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Product Template to generate print files from (variant_id is then required)."
},
"warehouse_product_variant_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Warehouse product variant id."
}
}
},
"minItems": 1,
"description": "Order items."
},
"shipping": {
"type": "string",
"description": "Shipping method id from printful_calculate_shipping_rates (default STANDARD)."
},
"store_id": {
"type": "string",
"description": "Store id (numeric) for an ACCOUNT-level token; overrides PRINTFUL_STORE_ID. Not needed with a store-level token."
},
"recipient": {
"type": "object",
"required": [
"country_code"
],
"properties": {
"zip": {
"type": "string",
"description": "ZIP / postal code."
},
"city": {
"type": "string",
"description": "City."
},
"name": {
"type": "string",
"description": "Full name."
},
"email": {
"type": "string",
"description": "Email address."
},
"phone": {
"type": "string",
"description": "Phone number."
},
"company": {
"type": "string",
"description": "Company name."
},
"address1": {
"type": "string",
"description": "Address line 1."
},
"address2": {
"type": "string",
"description": "Address line 2."
},
"state_code": {
"type": "string",
"description": "State code — required for US, CA and AU."
},
"tax_number": {
"type": "string",
"description": "Tax number (required for Brazil: CPF/CNPJ)."
},
"country_code": {
"type": "string",
"description": "Two-letter ISO country code, e.g. US."
}
},
"description": "Ship-to address (name, address1, city, country_code, zip are normally needed)."
},
"external_id": {
"type": "string",
"description": "Your own order id; the order is then also addressable as @<external_id>."
},
"packing_slip": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Customer-service email."
},
"phone": {
"type": "string",
"description": "Customer-service phone."
},
"message": {
"type": "string",
"description": "Custom packing-slip message."
},
"logo_url": {
"type": "string",
"description": "Logo / sticker URL (printed monochrome)."
},
"store_name": {
"type": "string",
"description": "Store name override for the return address."
},
"custom_order_id": {
"type": "string",
"description": "Your own order id to print instead of Printful's."
}
},
"description": "Custom packing slip."
},
"retail_costs": {
"type": "object",
"properties": {
"tax": {
"type": "string"
},
"currency": {
"type": "string",
"description": "3-letter currency code."
},
"discount": {
"type": "string"
},
"shipping": {
"type": "string"
},
"subtotal": {
"type": "string"
}
},
"description": "Retail costs to show on the packing slip."
}
}
}