Orders API

Orders APIは新しい注文の作成とその注文処理に必要な確認を行います。

注文状態

処理中の注文状態は下記のように表示されます。

draft 注文は作成されたがまだ申請されていません。編集や後からの申請が可能です。
pending 注文が申請されたが、製造側から認証されていません。必要であれば、まだキャンセル可能です。
エラー 注文が製造ラインに送信されましたが、問題(住所、印刷データの不備、請求の失敗等)が発生した為再確認を行なっています。
キャンセル済 注文がキャンセルされ、処理が続行出来ません。注文の支払いが済んでいる場合は、請求金額がクレジットカードへ返金されます。
inprocess 注文が製造中のためキャンセルや編集はできません。必要であればカスタマーサポートへご連絡ください。
onhold 製造中に問題が発生したため製造中止になりました。お手数ですが、カスタマーサポートへご連絡ください。
partial 一部の商品が発送され、あとの商品が製造中です。
注⽂の製造済 全ての商品が発送済みです。

Orders APIは、draft(下書き)状態の注文を作成し、一遍にpending(保留)状態に移すことができます。承認済みの注文のみが請求されます。注文の申請後にエラーが発生した場合、状態表示がfailed(失敗)になり、手動の再申請待ちになります。

外部ID

外部IDは追加のデータをあなたの側に保存する必要なしに、Printful注文をあなたのシステムからの注文IDとリンクすることを可能にするオプション機能です。 外部IDは最大32文字で、数字、アルファベット、ダッシュ、アンダースコアを含むことができますが、整数を使用することをお勧めします。 各注文の外部IDはストア内で一意である必要があります。

外部ID機能を使用するには注文を作成するときにexternal_id属性を追加するのみです。後で、APIを介して注文にアクセスする必要がある場合、注文IDと外部IDの両方で参照することができます(@記号が付いている場合)。

 
GET /orders/11001  - Printful注文IDによる参照
GET /orders/@98812  - 外部IDによる参照
GET /orders/@AA123123  - 外部IDによる参照
 

ラインアイテムにも external_id 属性を割り当てることができます。この場合、注文ごとに一意である必要があります。

商品の指定

注文を作成、更新、または見積もりするときに商品のバリエーションを指定する一般的な方法は2つあります。

(A)Printfulストアまたは倉庫に既存の商品バリエーションがある場合、その sync_variant_id または external_variant_id warehouse_product_variant_id 指定して参照することができます。

(B)Printfulストア内の既存の商品のバリエーションを持っていない場合、商品カタログ APIからのユニークなvariant_idをデザインデータ、追加オプションを使って、急いでバリエーションを構築することができます。

デザインデータを追加する

デザインデータを同期バリエーション(Sync Variant)に指定する方法が2つあります。1つは、デザインデータのファイルがショップのファイルライブラリに既存する場合、そのファイルIDを指定する方法です。

 
 ... 
 "ファイル":[ 
 {"id":12345}、 
 ]、 
 ... 
 

2つ目のより便利な方法はファイルのURLを指定する方法です。同じURLのファイルがすでに存在する場合は、そのファイルが再利用されます。

 
 ... 
 "ファイル":[ 
 {"url": "http://example.com/t-shirts/123/front.pdf"}、 
 ]、 
 ... 
 

アイテムごとに複数のファイルを指定する

注文の各項目は1つまたは複数のファイルとリンクさせる必要があります。各商品で利用可能なファイルの種類は商品カタログAPIから入手することができます。

type属性を指定して、タイプごとに1つのファイルを追加することができます。defaultタイプの場合、この属性はスキップすることができます。

 
 ...
"files":[
	{
		"type": "default",
		"url": "http://example.com/t-shirts/123/front.pdf"
	},
	{
		"type": "back"
		"url": "http://example.com/t-shirts/123/back.pdf"
	},
	{
		"type": "preview"
		"url": "http://example.com/t-shirts/123/preview.png"
	}
],
...
 

追加ファイルを使用すると商品の価格が上がる可能性があることを忘れないでください。

小売価格

商品が国際配送される場合、注文の商品の小売価格を表示する必要がある場合があります。小売価格のプロパティを有効にするには注文の各商品にretail_price属性を指定する必要があります。また、retail_costsオブジェクトで注文時にカスタム割引額、送料、税金などを指定することもできます。 小売価格が設定されていない場合、納品書にPrintfulの定価が印刷されます。

Get list of orders

GET https://api.printful.com/orders

Returns list of order objects from your store
Input parameters:
status string Filter by order status
offset integer Result set offset
limit integer Number of items per page (max 100)
レスポンス形式:
code integer ステータスコードのレスポンス 200
result Order [ ]
id integer Order ID
external_id string Order ID from the external system
store integer Store ID
status string Order status:
draft - order is not submitted for fulfillment
failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)
pending - order has been submitted for fulfillment
canceled - order is canceled
onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service
inprocess - order is being fulfilled and is no longer cancellable
partial - order is partially fulfilled (some items are shipped already, the rest will follow)
fulfilled - all items are shipped
shipping string Shipping method. Defaults to 'STANDARD'
created timestamp Time when the order was created
updated timestamp Time when the order was updated
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
costs Costs Order costs (Printful prices)
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
pricing_breakdown array Difference between order price and retail costs. Will be shown only if order is completed.
shipments Shipment [ ] Array of shipments already shipped for this order
id integer Shipment ID
carrier string Carrier name
service string Delivery service name
tracking_number string Shipment tracking number
tracking_url string Shipment tracking URL
created timestamp Shipping time
ship_date string Ship date
shipped_at int Ship time in unix timestamp
reshipment boolean Whether this is a reshipment
items ShipmentItem [ ] Array of items in this shipment
item_id integer Line item ID
quantity integer Quantity of items in this shipment
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
paging Paging Paging information
total integer 利用可能なアイテム総数
offset integer Current result set page offset
limit integer ページに表示する最大アイテム数
APIキー
status Filter by order status
offset Result set offset
limit Number of items per page (max 100)
Execute

Create a new order

POST https://api.printful.com/orders

Creates a new order and optionally submits it for fulfillment
Input parameters:
Request body OrderInput Order data
external_id string Order ID from the external system
shipping string Shipping method. Defaults to 'STANDARD'
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
confirm boolean Automatically submit the newly created order for fulfillment (skip the Draft phase)
update_existing boolean Try to update existing order if an order with the specified external_id already exists
レスポンス形式:
code integer ステータスコードのレスポンス 200
result Order
id integer Order ID
external_id string Order ID from the external system
store integer Store ID
status string Order status:
draft - order is not submitted for fulfillment
failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)
pending - order has been submitted for fulfillment
canceled - order is canceled
onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service
inprocess - order is being fulfilled and is no longer cancellable
partial - order is partially fulfilled (some items are shipped already, the rest will follow)
fulfilled - all items are shipped
shipping string Shipping method. Defaults to 'STANDARD'
created timestamp Time when the order was created
updated timestamp Time when the order was updated
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
costs Costs Order costs (Printful prices)
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
pricing_breakdown array Difference between order price and retail costs. Will be shown only if order is completed.
shipments Shipment [ ] Array of shipments already shipped for this order
id integer Shipment ID
carrier string Carrier name
service string Delivery service name
tracking_number string Shipment tracking number
tracking_url string Shipment tracking URL
created timestamp Shipping time
ship_date string Ship date
shipped_at int Ship time in unix timestamp
reshipment boolean Whether this is a reshipment
items ShipmentItem [ ] Array of items in this shipment
item_id integer Line item ID
quantity integer Quantity of items in this shipment
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
APIキー
Request body
confirm Automatically submit the newly created order for fulfillment (skip the Draft phase)
update_existing Try to update existing order if an order with the specified external_id already exists
Execute
デザインデータとPrintfulカタログのvariant_idに基づき、その場で構成し、アイテムを含む注文を作成します。
Request body:
{
    "recipient": {
        "name": "John Doe",
        "address1": "19749 Dearborn St",
        "city": "Chatsworth",
        "state_code": "CA",
        "country_code": "US",
        "zip": "91311"
    },
    "items": [{
        "variant_id": 1,
        "quantity": 1,
        "files": [{
            "url": "http://example.com/files/posters/poster_1.jpg"
        }]
    }]
}
Response data:
{
    "code": 200,
    "result": {
        "id": 21510,
        "external_id": null,
        "status": "draft",
        "shipping": "STANDARD",
        "created": 1390825082,
        "updated": 1390825082,
        "recipient": {
            "name": "John Doe",
            "company": null,
            "address1": "19749 Dearborn St",
            "address2": null,
            "city": "Chatsworth",
            "state_code": "CA",
            "state_name": "California",
            "country_code": "US",
            "country_name": "United States",
            "zip": "91311",
            "phone": null,
            "email": null
        },
        "items": [{
            "id": 17621,
            "external_id": null,
            "variant_id": 1,
            "quantity": 1,
            "price": "13.00",
            "retail_price": null,
            "name": "Unframed Poster 18×24",
            "product": {
                "variant_id": 1,
                "product_id": 1,
                "image": "https://www.printful.com/storage/products/poster_18x24.jpg",
                "name": "Unframed Poster 18×24"
            },
            "files": [{
                "id": 11818,
                "type": "default",
                "hash": null,
                "url": "http://example.com/files/posters/poster_1.jpg",
                "filename": null,
                "mime_type": null,
                "size": 0,
                "width": null,
                "height": null,
                "dpi": null,
                "status": "waiting",
                "created": 1390823900,
                "thumbnail_url": null,
                "preview_url": null,
                "visible": true
            }],
            "options": []
        }],
        "costs": {
            "subtotal": "13.00",
            "discount": "0.00",
            "shipping": "7.95",
            "tax": "1.17",
            "total": "22.12"
        },
        "retail_costs": {
            "subtotal": null,
            "discount": null,
            "shipping": null,
            "tax": null,
            "total": null
        },
        "shipments": []
    }
}
Create an order containing an item, which is based on an existing Sync Variant from the authorized Printful store and is referenced by its Sync Variant ID. Please note, that the existing Sync Variant must be configured (synced) for this to work.
Request body:
{
    "recipient": {
        "name": "John Doe",
        "address1": "19749 Dearborn St",
        "city": "Chatsworth",
        "state_code": "CA",
        "country_code": "US",
        "zip": "91311"
    },
    "items": [{
        "sync_variant_id": 1,
        "quantity": 1
    }]
}
Response data:
{
    "code": 200,
    "result": {
        "id": 11360229,
        "external_id": null,
        "store": 952434,
        "status": "draft",
        "error": null,
        "shipping": "PRINTFUL_FAST",
        "created": 1539584164,
        "updated": 1539584164,
        "recipient": {
            "name": "John Doe",
            "company": null,
            "address1": "19749 Dearborn St",
            "address2": null,
            "city": "Chatsworth",
            "state_code": "CA",
            "state_name": "California",
            "country_code": "US",
            "country_name": "United States",
            "zip": "91311",
            "phone": null,
            "email": null
        },
        "notes": null,
        "items": [
            {
                "id": 7253102,
                "external_id": null,
                "variant_id": 4011,
                "sync_variant_id": 866913817,
                "external_variant_id": "5bc04fbe956147",
                "quantity": 1,
                "price": "12.95",
                "retail_price": null,
                "name": "Short-Sleeve Unisex T-Shirt - S",
                "product": {
                    "variant_id": 4011,
                    "product_id": 71,
                    "image": "https://www.printful.com/products/71/4012_1517927381.jpg",
                    "name": "Bella + Canvas 3001 Unisex Short Sleeve Jersey T-Shirt with Tear Away Label (White / S)"
                },
                "files": [
                    {
                        "id": 76564071,
                        "type": "default",
                        "hash": "1c43709da13e3480049379d41e473ad9",
                        "url": null,
                        "filename": "printfile-23aeb205.png",
                        "mime_type": "image/png",
                        "size": 18660,
                        "width": 1800,
                        "height": 2400,
                        "dpi": 150,
                        "status": "ok",
                        "created": 1539329978,
                        "thumbnail_url": "https://www.printful.com/files/1c4/1c43709da13e3480049379d41e473ad9_thumb.png",
                        "preview_url": "https://www.printful.com/files/1c4/1c43709da13e3480049379d41e473ad9_preview.png",
                        "visible": false
                    },
                    {
                        "id": 76564072,
                        "type": "preview",
                        "hash": "2749bee4a392c4ee2f034c7246706329",
                        "url": null,
                        "filename": "mockup-6da92239.jpg",
                        "mime_type": "image/jpeg",
                        "size": 32944,
                        "width": 600,
                        "height": 600,
                        "dpi": 72,
                        "status": "ok",
                        "created": 1539329982,
                        "thumbnail_url": "https://www.printful.com/files/274/2749bee4a392c4ee2f034c7246706329_thumb.png",
                        "preview_url": "https://www.printful.com/files/274/2749bee4a392c4ee2f034c7246706329_preview.png",
                        "visible": false
                    }
                ],
                "options": [
                    {
                        "id": "embroidery_type",
                        "value": "flat"
                    },
                    {
                        "id": "thread_colors",
                        "value": []
                    },
                    {
                        "id": "thread_colors_3d",
                        "value": []
                    },
                    {
                        "id": "thread_colors_chest_left",
                        "value": []
                    }
                ],
                "sku": null,
                "discontinued": false,
                "out_of_stock": false
            }
        ],
        "is_sample": false,
        "needs_approval": false,
        "not_synced": false,
        "has_discontinued_items": false,
        "can_change_hold": true,
        "costs": {
            "currency": "USD",
            "subtotal": "12.95",
            "discount": "0.00",
            "shipping": "2.60",
            "digitization": "0.00",
            "additional_fee": "0.00",
            "fulfillment_fee": "0.00",
            "tax": "1.35",
            "vat": "0.00",
            "total": "16.90"
        },
        "retail_costs": {
            "currency": "USD",
            "subtotal": null,
            "discount": null,
            "shipping": null,
            "tax": null,
            "vat": null,
            "total": null
        },
        "shipments": [],
        "gift": null,
        "packing_slip": null,
        "dashboard_url": "https://www.printful.com/dashboard?order_id=11360229"
    },
    "extra": []
}
Create an order containing an item, which is based on an existing Sync Variant from the authorized Printful store and is referenced by its external ID. Please note, that the existing Sync Variant must be configured (synced) for this to work.
Request body:
{
    "recipient": {
        "name": "John Doe",
        "address1": "19749 Dearborn St",
        "city": "Chatsworth",
        "state_code": "CA",
        "country_code": "US",
        "zip": "91311"
    },
    "items": [{
        "external_variant_id": "5bc04fbe956148",
        "quantity": 1
    }]
}
Response data:
{
    "code": 200,
    "result": {
        "id": 11360229,
        "external_id": null,
        "store": 952434,
        "status": "draft",
        "error": null,
        "shipping": "PRINTFUL_FAST",
        "created": 1539584164,
        "updated": 1539584164,
        "recipient": {
            "name": "John Doe",
            "company": null,
            "address1": "19749 Dearborn St",
            "address2": null,
            "city": "Chatsworth",
            "state_code": "CA",
            "state_name": "California",
            "country_code": "US",
            "country_name": "United States",
            "zip": "91311",
            "phone": null,
            "email": null
        },
        "notes": null,
        "items": [
            {
                "id": 7253102,
                "external_id": null,
                "variant_id": 4011,
                "sync_variant_id": 866913817,
                "external_variant_id": "5bc04fbe956147",
                "quantity": 1,
                "price": "12.95",
                "retail_price": null,
                "name": "Short-Sleeve Unisex T-Shirt - S",
                "product": {
                    "variant_id": 4011,
                    "product_id": 71,
                    "image": "https://www.printful.com/products/71/4012_1517927381.jpg",
                    "name": "Bella + Canvas 3001 Unisex Short Sleeve Jersey T-Shirt with Tear Away Label (White / S)"
                },
                "files": [
                    {
                        "id": 76564071,
                        "type": "default",
                        "hash": "1c43709da13e3480049379d41e473ad9",
                        "url": null,
                        "filename": "printfile-23aeb205.png",
                        "mime_type": "image/png",
                        "size": 18660,
                        "width": 1800,
                        "height": 2400,
                        "dpi": 150,
                        "status": "ok",
                        "created": 1539329978,
                        "thumbnail_url": "https://www.printful.com/files/1c4/1c43709da13e3480049379d41e473ad9_thumb.png",
                        "preview_url": "https://www.printful.com/files/1c4/1c43709da13e3480049379d41e473ad9_preview.png",
                        "visible": false
                    },
                    {
                        "id": 76564072,
                        "type": "preview",
                        "hash": "2749bee4a392c4ee2f034c7246706329",
                        "url": null,
                        "filename": "mockup-6da92239.jpg",
                        "mime_type": "image/jpeg",
                        "size": 32944,
                        "width": 600,
                        "height": 600,
                        "dpi": 72,
                        "status": "ok",
                        "created": 1539329982,
                        "thumbnail_url": "https://www.printful.com/files/274/2749bee4a392c4ee2f034c7246706329_thumb.png",
                        "preview_url": "https://www.printful.com/files/274/2749bee4a392c4ee2f034c7246706329_preview.png",
                        "visible": false
                    }
                ],
                "options": [
                    {
                        "id": "embroidery_type",
                        "value": "flat"
                    },
                    {
                        "id": "thread_colors",
                        "value": []
                    },
                    {
                        "id": "thread_colors_3d",
                        "value": []
                    },
                    {
                        "id": "thread_colors_chest_left",
                        "value": []
                    }
                ],
                "sku": null,
                "discontinued": false,
                "out_of_stock": false
            }
        ],
        "is_sample": false,
        "needs_approval": false,
        "not_synced": false,
        "has_discontinued_items": false,
        "can_change_hold": true,
        "costs": {
            "currency": "USD",
            "subtotal": "12.95",
            "discount": "0.00",
            "shipping": "2.60",
            "digitization": "0.00",
            "additional_fee": "0.00",
            "fulfillment_fee": "0.00",
            "tax": "1.35",
            "vat": "0.00",
            "total": "16.90"
        },
        "retail_costs": {
            "currency": "USD",
            "subtotal": null,
            "discount": null,
            "shipping": null,
            "tax": null,
            "vat": null,
            "total": null
        },
        "shipments": [],
        "gift": null,
        "packing_slip": null,
        "dashboard_url": "https://www.printful.com/dashboard?order_id=11360229"
    },
    "extra": []
}
Create an order with external order ID, custom item names and retail price information.
Request body:
{
    "external_id": "9887112",
    "recipient": {
        "name": "John Doe",
        "address1": "19749 Dearborn St",
        "city": "Chatsworth",
        "state_code": "CA",
        "country_code": "US",
        "zip": "91311"
    },
    "items": [{
        "variant_id": 2,
        "quantity": 1,
        "name": "Niagara Falls poster",
        "retail_price": "19.99",
        "files": [{
            "url": "http://example.com/files/posters/poster_2.jpg"
        }]
    }, {
        "variant_id": 1,
        "quantity": 3,
        "name": "Grand Canyon poster",
        "retail_price": "17.99",
        "files": [{
            "url": "http://example.com/files/posters/poster_3.jpg"
        }]
    }],
    "retail_costs": {
        "shipping": "24.50"
    }
}
Response data:
{
    "code": 200,
    "result": {
        "id": 21509,
        "external_id": "9887112",
        "status": "draft",
        "shipping": "STANDARD",
        "created": 1390825006,
        "updated": 1390825006,
        "recipient": {
            "name": "John Doe",
            "company": null,
            "address1": "19749 Dearborn St",
            "address2": null,
            "city": "Chatsworth",
            "state_code": "CA",
            "state_name": "California",
            "country_code": "US",
            "country_name": "United States",
            "zip": "91311",
            "phone": null,
            "email": null
        },
        "items": [{
            "id": 17619,
            "external_id": null,
            "variant_id": 2,
            "quantity": 1,
            "price": "18.00",
            "retail_price": "19.99",
            "name": "Niagara Falls poster",
            "product": {
                "variant_id": 2,
                "product_id": 1,
                "image": "https://www.printful.com/storage/products/poster_24x36.jpg",
                "name": "Unframed Poster 24×36"
            },
            "files": [{
                "id": 11819,
                "type": "default",
                "hash": null,
                "url": "http://example.com/files/posters/poster_2.jpg",
                "filename": null,
                "mime_type": null,
                "size": 0,
                "width": null,
                "height": null,
                "dpi": null,
                "status": "waiting",
                "created": 1390824712,
                "thumbnail_url": null,
                "preview_url": null,
                "visible": true
            }],
            "options": []
        }, {
            "id": 17620,
            "external_id": null,
            "variant_id": 1,
            "quantity": 3,
            "price": "13.00",
            "retail_price": "17.99",
            "name": "Grand Canyon poster",
            "product": {
                "variant_id": 1,
                "product_id": 1,
                "image": "https://www.printful.com/storage/products/poster_18x24.jpg",
                "name": "Unframed Poster 18×24"
            },
            "files": [{
                "id": 11820,
                "type": "default",
                "hash": null,
                "url": "http://example.com/files/posters/poster_3.jpg",
                "filename": null,
                "mime_type": null,
                "size": 0,
                "width": null,
                "height": null,
                "dpi": null,
                "status": "waiting",
                "created": 1390824712,
                "thumbnail_url": null,
                "preview_url": null,
                "visible": true
            }],
            "options": []
        }],
        "costs": {
            "subtotal": "57.00",
            "discount": "0.00",
            "shipping": "9.95",
            "tax": "5.13",
            "total": "72.08"
        },
        "retail_costs": {
            "subtotal": "73.96",
            "discount": "0.00",
            "shipping": "24.50",
            "tax": "0.00",
            "total": "98.46"
        },
        "shipments": []
    }
}
Create an order containing a shirt with a preview image added, both front and back print files specified and the option to tear off inside label selected.
Request body:
{
    "recipient": {
        "name": "John Doe",
        "address1": "19749 Dearborn St",
        "city": "Chatsworth",
        "state_code": "CA",
        "country_code": "US",
        "zip": "91311"
    },
    "items": [{
        "variant_id": 1118,
        "quantity": 1,
        "files": [{
            "url": "http://example.com/files/tshirts/shirt_front.ai"
        }, {
            "type": "back",
            "url": "http://example.com/files/tshirts/shirt_back.ai"
        }, {
            "type": "preview",
            "url": "http://example.com/files/tshirts/shirt_mockup.jpg"
        }],
        "options": []
    }]
}
Response data:
{
    "code": 200,
    "result": {
        "id": 21516,
        "external_id": null,
        "status": "draft",
        "shipping": "STANDARD",
        "created": 1390825437,
        "updated": 1390825437,
        "recipient": {
            "name": "John Doe",
            "company": null,
            "address1": "19749 Dearborn St",
            "address2": null,
            "city": "Chatsworth",
            "state_code": "CA",
            "state_name": "California",
            "country_code": "US",
            "country_name": "United States",
            "zip": "91311",
            "phone": null,
            "email": null
        },
        "items": [{
            "id": 17627,
            "external_id": null,
            "variant_id": 1118,
            "quantity": 1,
            "price": "20.50",
            "retail_price": null,
            "name": "Alternative 1070 Short Sleeve Men T-Shirt (Black / M)",
            "product": {
                "variant_id": 1118,
                "product_id": 14,
                "image": "https://www.printful.com/storage/products/14/1095.jpg",
                "name": "Alternative 1070 Short Sleeve Men T-Shirt (Black / M)"
            },
            "files": [{
                "id": 11822,
                "type": "default",
                "hash": null,
                "url": "http://example.com/files/tshirts/shirt_front.ai",
                "filename": null,
                "mime_type": null,
                "size": 0,
                "width": null,
                "height": null,
                "dpi": null,
                "status": "waiting",
                "created": 1390825349,
                "thumbnail_url": null,
                "preview_url": null,
                "visible": true
            }, {
                "id": 11823,
                "type": "back",
                "hash": null,
                "url": "http://example.com/files/tshirts/shirt_back.ai",
                "filename": null,
                "mime_type": null,
                "size": 0,
                "width": null,
                "height": null,
                "dpi": null,
                "status": "waiting",
                "created": 1390825349,
                "thumbnail_url": null,
                "preview_url": null,
                "visible": true
            }, {
                "id": 11824,
                "type": "preview",
                "hash": null,
                "url": "http://example.com/files/tshirts/shirt_mockup.jpg",
                "filename": null,
                "mime_type": null,
                "size": 0,
                "width": null,
                "height": null,
                "dpi": null,
                "status": "waiting",
                "created": 1390825349,
                "thumbnail_url": null,
                "preview_url": null,
                "visible": true
            }],
            "options": []
        }],
        "costs": {
            "subtotal": "20.50",
            "discount": "0.00",
            "shipping": "5.50",
            "tax": "1.85",
            "total": "27.85"
        },
        "retail_costs": {
            "subtotal": null,
            "discount": null,
            "shipping": null,
            "tax": null,
            "total": null
        },
        "shipments": []
    }
}
Create an order containing a pair of leggings with the "Stitch color" option specified.
Request body:
{
    "recipient": {
        "name": "John Doe",
        "address1": "19749 Dearborn St",
        "city": "Chatsworth",
        "state_code": "CA",
        "country_code": "US",
        "zip": "91311"
    },
    "items": [{
        "variant_id": 9144,
        "quantity": 1,
        "files": [{
            "url": "http://example.com/files/leggings/leggings_mockup.jpg"
        }],
        "options": [{"id": "stitch_color", "value": "black"}]
    }]
}
Response data:
{
    "code": 200,
    "result": {
        "id": 22481169,
        "external_id": null,
        "store": 1633247,
        "status": "draft",
        "error": null,
        "errorCode": 0,
        "shipping": "STANDARD",
        "shipping_service_name": "Flat Rate (3-4 business days after fulfillment)",
        "created": 1575645857,
        "updated": 1575645857,
        "recipient": {
            "name": "John Doe",
            "company": null,
            "address1": "19749 Dearborn St",
            "address2": null,
            "city": "Chatsworth",
            "state_code": "CA",
            "state_name": "California",
            "country_code": "US",
            "country_name": "United States",
            "zip": "91311",
            "phone": null,
            "email": null
        },
        "notes": null,
        "items": [
            {
                "id": 13516941,
                "external_id": null,
                "variant_id": 9144,
                "sync_variant_id": null,
                "external_variant_id": null,
                "quantity": 1,
                "price": "26.99",
                "retail_price": null,
                "name": "All-Over Print Men's Leggings (XS)",
                "product": {
                    "variant_id": 9144,
                    "product_id": 288,
                    "image": "https://www.printful.com/products/288/9144_1532344185.jpg",
                    "name": "All-Over Print Men's Leggings (XS)"
                },
                "files": [
                    {
                        "id": 138304686,
                        "type": "default",
                        "hash": "c27a71ab4008c83eba9b554775aa12ca",
                        "url": "http://example.com/files/leggings/leggings_mockup.jpg",
                        "filename": "QmTQo4cxDZ5MoszQAK93JyhFedeMuj7j4x5P7tQnvRi4A5.png",
                        "mime_type": null,
                        "size": 0,
                        "width": null,
                        "height": null,
                        "dpi": null,
                        "status": "waiting",
                        "created": 1575645853,
                        "thumbnail_url": null,
                        "preview_url": null,
                        "visible": true
                    }
                ],
                "options": [
                    {
                        "id": "stitch_color",
                        "value": "black"
                    }
                ],
                "sku": null,
                "discontinued": false,
                "out_of_stock_eu": false,
                "out_of_stock": false
            }
        ],
        "is_sample": false,
        "needs_approval": false,
        "not_synced": false,
        "has_discontinued_items": false,
        "can_change_hold": false,
        "costs": {
            "currency": "EUR",
            "subtotal": "26.99",
            "discount": "0.00",
            "shipping": "3.65",
            "digitization": "0.00",
            "additional_fee": "0.00",
            "fulfillment_fee": "0.00",
            "tax": "2.82",
            "vat": "0.00",
            "total": "33.46"
        },
        "retail_costs": {
            "currency": "EUR",
            "subtotal": null,
            "discount": null,
            "shipping": null,
            "tax": null,
            "vat": null,
            "total": null
        },
        "shipments": [],
        "gift": null,
        "packing_slip": null,
        "dashboard_url": "https://www.printful.com/dashboard/default/orders?order_id=22481169"
    },
    "extra": []
}
Create an order containing a hat with the embroidery type and thread colors specified.
Request body:
{
    "recipient": {
        "name": "John Doe",
        "address1": "19749 Dearborn St",
        "city": "Chatsworth",
        "state_code": "CA",
        "country_code": "US",
        "zip": "91311"
    },
    "items": [{
        "variant_id": 8746,
        "quantity": 1,
        "files": [{
            "url": "http://example.com/files/hats/hats_mockup.jpg"
        }],
        "options": [{
            "id": "embroidery_type",
            "value": "flat"
        },
        {
            "id": "thread_colors",
            "value": ["#FFFFFF", "#A67843"]
        }]
    }]
}
Response data:
{
    "code": 200,
    "result": {
        "id": 22481172,
        "external_id": null,
        "store": 1387102,
        "status": "draft",
        "error": null,
        "errorCode": 0,
        "shipping": "STANDARD",
        "shipping_service_name": "Flat Rate (3-4 business days after fulfillment)",
        "created": 1575647137,
        "updated": 1575647137,
        "recipient": {
            "name": "John Doe",
            "company": null,
            "address1": "19749 Dearborn St",
            "address2": null,
            "city": "Chatsworth",
            "state_code": "CA",
            "state_name": "California",
            "country_code": "US",
            "country_name": "United States",
            "zip": "91311",
            "phone": null,
            "email": null
        },
        "notes": null,
        "items": [
            {
                "id": 13516944,
                "external_id": null,
                "variant_id": 8746,
                "sync_variant_id": null,
                "external_variant_id": null,
                "quantity": 1,
                "price": "12.57",
                "retail_price": null,
                "name": "Yupoong 6606 Retro Trucker Cap (White)",
                "product": {
                    "variant_id": 8746,
                    "product_id": 252,
                    "image": "https://www.printful.com/products/252/8746_1543592826.jpg",
                    "name": "Yupoong 6606 Retro Trucker Cap (White)"
                },
                "files": [
                    {
                        "id": 138304687,
                        "type": "default",
                        "hash": "c27a71ab4008c83eba9b554775aa12ca",
                        "url": "http://example.com/files/hats/hats_mockup.jpg",
                        "filename": "QmTQo4cxDZ5MoszQAK93JyhFedeMuj7j4x5P7tQnvRi4A5.png",
                        "mime_type": "image/png",
                        "size": 37257,
                        "width": 2480,
                        "height": 2480,
                        "dpi": 300,
                        "status": "ok",
                        "created": 1575646661,
                        "thumbnail_url": "https://www.printful.com/files/c27/c27a71ab4008c83eba9b554775aa12ca_thumb.png",
                        "preview_url": "https://www.printful.com/files/c27/c27a71ab4008c83eba9b554775aa12ca_preview.png",
                        "visible": true
                    }
                ],
                "options": [
                    {
                        "id": "embroidery_type",
                        "value": "flat"
                    },
                    {
                        "id": "thread_colors",
                        "value": [
                            "#FFFFFF",
                            "#A67843"
                        ]
                    },
                    {
                        "id": "text_thread_colors",
                        "value": []
                    },
                    {
                        "id": "thread_colors_3d",
                        "value": []
                    }
                ],
                "sku": null,
                "discontinued": false,
                "out_of_stock_eu": false,
                "out_of_stock": false
            }
        ],
        "is_sample": false,
        "needs_approval": false,
        "not_synced": false,
        "has_discontinued_items": false,
        "can_change_hold": false,
        "costs": {
            "currency": "EUR",
            "subtotal": "12.57",
            "discount": "0.00",
            "shipping": "3.65",
            "digitization": "5.75",
            "additional_fee": "0.00",
            "fulfillment_fee": "0.00",
            "tax": "1.91",
            "vat": "0.00",
            "total": "23.88"
        },
        "retail_costs": {
            "currency": "EUR",
            "subtotal": null,
            "discount": null,
            "shipping": null,
            "tax": null,
            "vat": null,
            "total": null
        },
        "shipments": [],
        "gift": null,
        "packing_slip": null,
        "dashboard_url": "https://www.printful.com/dashboard/default/orders?order_id=22481172"
    },
    "extra": []
}

Estimate order costs

POST https://api.printful.com/orders/estimate-costs

Calculates the estimated order costs including item costs, print costs (back prints, inside labels etc.), shipping and taxes
Input parameters:
Request body OrderInput Order data
external_id string Order ID from the external system
shipping string Shipping method. Defaults to 'STANDARD'
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
レスポンス形式:
code integer ステータスコードのレスポンス 200
result OrderCosts
costs Costs Order costs (Printful prices)
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
APIキー
Request body
Execute

Get order data

GET https://api.printful.com/orders/{id}

Returns order data by ID or External ID.
Input parameters:
id integer / string Order ID (integer) or External ID (if prefixed with @)
レスポンス形式:
code integer ステータスコードのレスポンス 200
result Order
id integer Order ID
external_id string Order ID from the external system
store integer Store ID
status string Order status:
draft - order is not submitted for fulfillment
failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)
pending - order has been submitted for fulfillment
canceled - order is canceled
onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service
inprocess - order is being fulfilled and is no longer cancellable
partial - order is partially fulfilled (some items are shipped already, the rest will follow)
fulfilled - all items are shipped
shipping string Shipping method. Defaults to 'STANDARD'
created timestamp Time when the order was created
updated timestamp Time when the order was updated
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
costs Costs Order costs (Printful prices)
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
pricing_breakdown array Difference between order price and retail costs. Will be shown only if order is completed.
shipments Shipment [ ] Array of shipments already shipped for this order
id integer Shipment ID
carrier string Carrier name
service string Delivery service name
tracking_number string Shipment tracking number
tracking_url string Shipment tracking URL
created timestamp Shipping time
ship_date string Ship date
shipped_at int Ship time in unix timestamp
reshipment boolean Whether this is a reshipment
items ShipmentItem [ ] Array of items in this shipment
item_id integer Line item ID
quantity integer Quantity of items in this shipment
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
APIキー
id Order ID (integer) or External ID (if prefixed with @)
Execute

Cancel an order

DELETE https://api.printful.com/orders/{id}

Cancels pending order or draft. Charged amount is returned to the store owner's credit card.
Input parameters:
id integer / string Order ID (integer) or External ID (if prefixed with @)
レスポンス形式:
code integer ステータスコードのレスポンス 200
result Order
id integer Order ID
external_id string Order ID from the external system
store integer Store ID
status string Order status:
draft - order is not submitted for fulfillment
failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)
pending - order has been submitted for fulfillment
canceled - order is canceled
onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service
inprocess - order is being fulfilled and is no longer cancellable
partial - order is partially fulfilled (some items are shipped already, the rest will follow)
fulfilled - all items are shipped
shipping string Shipping method. Defaults to 'STANDARD'
created timestamp Time when the order was created
updated timestamp Time when the order was updated
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
costs Costs Order costs (Printful prices)
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
pricing_breakdown array Difference between order price and retail costs. Will be shown only if order is completed.
shipments Shipment [ ] Array of shipments already shipped for this order
id integer Shipment ID
carrier string Carrier name
service string Delivery service name
tracking_number string Shipment tracking number
tracking_url string Shipment tracking URL
created timestamp Shipping time
ship_date string Ship date
shipped_at int Ship time in unix timestamp
reshipment boolean Whether this is a reshipment
items ShipmentItem [ ] Array of items in this shipment
item_id integer Line item ID
quantity integer Quantity of items in this shipment
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
APIキー
id Order ID (integer) or External ID (if prefixed with @)
Execute

Update order data

PUT https://api.printful.com/orders/{id}

Updates unsubmitted order and optionally submits it for the fulfillment.

Note that you need to post only the fields that need to be changed, not all required fields.

If items array is given in the update data, the items will be:
a) updated, if the update data contains the item id or external_id parameter that alreay exists
b) deleted, if the request doesn't contain the item with previously existing id
c) created as new if the id is not given or does not already exist

Input parameters:
id integer Order ID (integer) or External ID (if prefixed with @)
confirm boolean Automatically submit the newly created order for fulfillment (skip the Draft phase)
Request body OrderInput Order data
external_id string Order ID from the external system
shipping string Shipping method. Defaults to 'STANDARD'
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
レスポンス形式:
code integer ステータスコードのレスポンス 200
result Order
id integer Order ID
external_id string Order ID from the external system
store integer Store ID
status string Order status:
draft - order is not submitted for fulfillment
failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)
pending - order has been submitted for fulfillment
canceled - order is canceled
onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service
inprocess - order is being fulfilled and is no longer cancellable
partial - order is partially fulfilled (some items are shipped already, the rest will follow)
fulfilled - all items are shipped
shipping string Shipping method. Defaults to 'STANDARD'
created timestamp Time when the order was created
updated timestamp Time when the order was updated
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
costs Costs Order costs (Printful prices)
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
pricing_breakdown array Difference between order price and retail costs. Will be shown only if order is completed.
shipments Shipment [ ] Array of shipments already shipped for this order
id integer Shipment ID
carrier string Carrier name
service string Delivery service name
tracking_number string Shipment tracking number
tracking_url string Shipment tracking URL
created timestamp Shipping time
ship_date string Ship date
shipped_at int Ship time in unix timestamp
reshipment boolean Whether this is a reshipment
items ShipmentItem [ ] Array of items in this shipment
item_id integer Line item ID
quantity integer Quantity of items in this shipment
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
APIキー
id Order ID (integer) or External ID (if prefixed with @)
confirm Automatically submit the newly created order for fulfillment (skip the Draft phase)
Request body
Execute

Confirm draft for fulfillment

POST https://api.printful.com/orders/{id}/confirm

Approves for fulfillment an order that was saved as a draft. Store owner's credit card is charged when the order is submitted for fulfillment.
Input parameters:
id integer / string Order ID (integer) or External ID (if prefixed with @)
レスポンス形式:
code integer ステータスコードのレスポンス 200
result Order
id integer Order ID
external_id string Order ID from the external system
store integer Store ID
status string Order status:
draft - order is not submitted for fulfillment
failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)
pending - order has been submitted for fulfillment
canceled - order is canceled
onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service
inprocess - order is being fulfilled and is no longer cancellable
partial - order is partially fulfilled (some items are shipped already, the rest will follow)
fulfilled - all items are shipped
shipping string Shipping method. Defaults to 'STANDARD'
created timestamp Time when the order was created
updated timestamp Time when the order was updated
recipient Address Shipping address
name string Full name
company string Company name
address1 string Address line 1
address2 string Address line 2
city string City
state_code string State code
state_name string State name
country_code string Country code
country_name string Country name
zip string ZIP/Postal code
phone string Phone
email string E-mail
items Item [ ] Array of items in the order
id integer Line item ID
external_id string Line item ID from the external system
variant_id integer Variant ID of the item ordered. See Products API
sync_variant_id integer Sync variant ID of the item ordered.
external_variant_id string External variant ID of the item ordered.
warehouse_product_variant_id integer Warehousing product variant ID of the item ordered. See Warehouse Products API
quantity integer Number of items ordered
price string Printful price of the item
retail_price string Original retail price of the item to be displayed on the packing slip
name string Display name of the item. If not given, a name from the Printful system will be displayed on the packing slip
product ProductVariant Short information about the Product and Variant
variant_id integer Variant ID
product_id integer Product ID of this variant
image string URL of a sample image for this variant
name string Display name of this variant
files File [ ] Array of attached printfiles / preview images
id integer File ID
type string Role of the file in the order
hash string MD5 checksum of the file
url string Source URL where the file is downloaded from
filename string File name
mime_type string MIME type of the file
size integer Size in bytes
width integer Width in pixels
height integer Height in pixels
dpi integer Resolution DPI.
Note: for vector files this may be indicated as only 72dpi, but it doesn't affect print quality since the vector files are resolution independent.
status string File processing status:
ok - file was processed successfuly
waiting - file is being processed
failed - file failed to be processed
created timestamp File creation time
thumbnail_url string Small thumbnail URL
preview_url string Medium preview image URL
visible boolean Show file in the Printfile Library (default true)
options ItemOption [ ] Array of additional options for this product
id string Option ID
value mixed Option value
sku string Product identifier (SKU) from the external system
costs Costs Order costs (Printful prices)
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
retail_costs Costs Retail costs that are to be displayed on the packing slip for international shipments. Retail costs are used only if every item in order contains the retail_price attribute.
currency string 3 letter currency code
subtotal string Total cost of all items
discount string Discount sum
shipping string Shipping costs
digitization string Digitization costs
tax string Sum of taxes (not included in the item price)
vat string Sum of vat (not included in the item price)
total string Grand Total (subtotal-discount+tax+vat+shipping)
pricing_breakdown array Difference between order price and retail costs. Will be shown only if order is completed.
shipments Shipment [ ] Array of shipments already shipped for this order
id integer Shipment ID
carrier string Carrier name
service string Delivery service name
tracking_number string Shipment tracking number
tracking_url string Shipment tracking URL
created timestamp Shipping time
ship_date string Ship date
shipped_at int Ship time in unix timestamp
reshipment boolean Whether this is a reshipment
items ShipmentItem [ ] Array of items in this shipment
item_id integer Line item ID
quantity integer Quantity of items in this shipment
gift GiftData Optional gift message for the packing slip
subject string Gift message title
message string Gift message text
packing_slip PackingSlip Custom packing slip for this order
email string Customer service email
phone string Customer service phone. Should be formatted like this: 111-222-3333
message string Custom packing slip message
APIキー
id Order ID (integer) or External ID (if prefixed with @)
Execute

Printfulを試す準備はできましたか?