{"info":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","description":"

The Printway.io API version 3.0 is an API service for viewing the products catalog, get order info and completing order(s) for our printing and fulfillment services.

Requests are made using standard GET, POST, PUT and DELETE. All responses are JSON.

Once you sign up for an account, you will be get an API access token.

Import Postman Collection: https://api.postman.com/collections/25190860-cc4a0e60-2d7e-42a0-b4d0-d610889f6561?access_key=PMAT-01H8GBN56MS9RZV712R5AHPQF4

Note: Request rate limit 50 req/ 3s

App test environment: https://test.printway.work
Test environment domain apis (pw_origin_api): https://test.printway.work/api/v3
Production environment domain apis (pw_origin_api): https://apis.printway.io/v3
Authorization: You can use Bearer or header with key as pw_access_token
The validity period of the access token is 730 days.
Access codes can be generated on the application interface: Store => Connect APIs => Generate Token/ Regenerate Token

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"24593406","collectionId":"a4b4c82f-f299-47f6-a705-6807cfbca19d","publishedId":"2sAYBPkto7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-16T06:59:45.000Z"},"item":[{"name":"Authorization","item":[{"name":"Generate Access Token","id":"733fb44b-01a2-4b14-8380-2f7b1524fde0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"your_email123@printway.io\", // Enter your email\r\n \"password\": \"YourPassword@123\" // Enter your password\r\n}","options":{"raw":{"language":"json"}}},"url":"/auth/token","description":"

You need to authenticate your account to be able to generate an access token.

email: string (required)
\n
password: string (required - at least 12 characters, one capital letter, one number, and one special character)
\n

You need to authenticate your account to be able to regenerate the access token.

email: string (required)
password: string (required - at least 12 characters, one capital letter, one number, and one special character)

Remove the previously generated access token.

Authorization by Bearer or Api key.

Generate, re-generate or destroy access token

\n","_postman_id":"73c13a90-c4c3-425a-8932-0883071ea1c8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}}},{"name":"Order","item":[{"name":"Calculate price for order","id":"d0dab8e9-60b8-4a7e-9f02-80cb8f4d400c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"discount_code\": [], // optional\r\n \"shipping_country_code\": \"\", // string - required\r\n \"shipping_province_code\": \"\", // string - required\r\n \"shipping_service\": \"\", // string - optional\r\n \"order_items\": [\r\n {\r\n \"made_in_location\": \"\", // string - optional\r\n \"product_location\": \"\", // string - optional\r\n \"variant_id\": \"\", // string - required without item_sku\r\n \"item_sku\": \"\", // string - required without variant_id\r\n \"quantity\": 1 // number - required, minimum 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/order/calculate-price","description":"

Calculate the product price and shipping price for the order.

Authorization by Bearer or Api key.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}},"urlObject":{"path":["order","calculate-price"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d0dab8e9-60b8-4a7e-9f02-80cb8f4d400c"},{"name":"Create new order Api","id":"6b84f6f1-a8ac-4511-8482-145973a8d970","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"order_name\",\r\n \"shipping_name\": \"Shipping name\",\r\n \"shipping_phone\": \"123456789\",\r\n \"shipping_address1\": \"581 Cherrywood Drive\",\r\n \"shipping_address2\": \"Address 2\", // optional\r\n \"shipping_city\": \"Sunnyvale\",\r\n \"shipping_province\": \"California\",\r\n \"shipping_province_code\": \"California\",\r\n \"shipping_zip\": \"94087\",\r\n \"shipping_country\": \"United States\",\r\n \"shipping_country_code\": \"US\",\r\n \"shipping_service\": \"US\", // optional\r\n \"discount_code\": [], // optional\r\n \"order_items\": [\r\n {\r\n \"product_location\": \"PW\", // string - optional\r\n \"made_in_location\": \"VN\", // string - optional\r\n \"product_name\": \"Custom your product name\", // string optional\r\n \"item_sku\": \"PW-2LMORM-3.54X3.54 INCHES-ONE SIDE\", // string - required without variant_id\r\n \"variant_id\": \"\", // string - required without item_sku\r\n \"quantity\": 1, // number\r\n \"variant_note\": \"note for item\", // string optional\r\n \"mockup_url\" : \"\", // url optional\r\n \"artwork_front\" : \"\", // url optional (retrived from list of products api)\r\n \"artwork_back\" : \"\", // url optional (retrived from list of products api)\r\n \"artwork_right\" : \"\", // url optional (retrived from list of products api)\r\n \"artwork_left\" : \"\", // url optional (retrived from list of products api)\r\n \"artwork_hood\" : \"\", // url optional (retrived from list of products api)\r\n \"artwork_bothsides\" : \"\" // url optional (retrived from list of products api)\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/order/create-new-order","description":"

Create new order

Authorization by Bearer or Api key

Retrive your order list by condition.

Authorization by Bearer or Api key

Retrieve your order detail.

Authorization with Bearer or Api key.

Cancel an order has not been send to production

Delete an order waiting and unpaid

Order payment with order id api

Calculate price, create new order, retrieve list orders, retrieve detail order, cancel order, ...

Note: We will use sku through 2023, and then will switch to using variant id to create order(s).

\n","_postman_id":"334bea3e-731f-4f58-bc18-445edbc47874","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}}},{"name":"Products","item":[{"name":"Retrieve a list of products","id":"084f4e23-e834-42f2-a43b-d1dabccc9170","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"limit\": 10, // number - optional, default 10, maximum: 100\r\n \"page\": 1, // number - optional, default 1\r\n \"search\": \"\" // string - optional\r\n}","options":{"raw":{"language":"json"}}},"url":"/products/list","description":"

Retrieve out product list.

Authorization with Bearer or Api key.

Get one of our product information by product code.

Authorization with Bearer or Api key.

Retrieve our list of sku, variant, product.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}},"urlObject":{"path":["products","list-sku-catalogs"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4babef64-f38d-4c9b-affc-48442f14f7a5"},{"name":"Retrieve shipping methods by variant_id/sku","id":"98ecf81b-ec30-4e9d-a69a-d1605c2f44bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"variant_id\": [\"102430\", \"102412\"],\r\n \"sku\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"/products/retrieved-shipping-methods","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}},"urlObject":{"path":["products","retrieved-shipping-methods"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"98ecf81b-ec30-4e9d-a69a-d1605c2f44bf"}],"id":"4b41eb65-98b6-44db-8c3e-adf8326d0d55","_postman_id":"4b41eb65-98b6-44db-8c3e-adf8326d0d55","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}}},{"name":"Webhook","item":[{"name":"Retrieve registered webhook","id":"3077c107-b7bd-45cb-be92-2447f31040ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"url":"/webhooks?type=tracking","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}},"urlObject":{"path":["webhooks"],"host":[""],"query":[{"description":{"content":"

tracking | order, default: tracking

\n","type":"text/plain"},"key":"type","value":"tracking"}],"variable":[]}},"response":[],"_postman_id":"3077c107-b7bd-45cb-be92-2447f31040ec"},{"name":"Register webhook","id":"38425fa7-32a8-4198-8252-051fe3edda2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"// Format of HTTP request header names and values\r\n\r\n// The name of the HTTP request header (access_key) you want to set or remove can only contain:\r\n// Alphanumeric characters: a-z, A-Z, and 0-9\r\n// The following special characters: - and _\r\n\r\n// The value of the HTTP request header (access_token) you want to set can only contain:\r\n// Alphanumeric characters: a-z, A-Z, and 0-9\r\n// The following special characters: _ :;.,\\/\"'?!(){}[]@<>=-+*#$&`|~^%\r\n\r\n{\r\n \"access_key\": \"\", // string (required)\r\n \"access_token\": \"\", // string (required)\r\n \"endpoint\": \"\" // https://printway.io\r\n}","options":{"raw":{"language":"json"}}},"url":"/webhooks?type=tracking","description":"

Format of HTTP request header names and values

The name of the HTTP request header (access_key) you want to set or remove can only contain:Alphanumeric characters: a-z, A-Z, and 0-9The following special characters: - and _

The value of the HTTP request header (access_token) you want to set can only contain:Alphanumeric characters: a-z, A-Z, and 0-9The following special characters: _ :;.,\\/\"'?!(){}[]@<>=-+*#$&`|~^%

Our request payload:

\n\n

Type Order:

{\n    \"order_id\": \"\", // string\n    \"pw_order_id\": \"\", // string\n    \"order_items\": [{\n        \"item_sku\": \"\", // string\n        \"order_status\": \"\", // string\n        \"message_error\": \"\", // string\n    }]\n}\n\n

Type Tracking:

{\n    \"pw_order_id\": \"\", // string\n    \"order_id\": \"\", // string\n    \"tracking_number\": \"\", // string\n    \"carrier_name\": \"\", // string\n    \"carrier_code\": \"\", // string\n    \"tracking_url\": \"\" // string\n}\n\n

tracking | order, default: tracking

\n","type":"text/plain"},"key":"type","value":"tracking"}],"variable":[]}},"response":[],"_postman_id":"38425fa7-32a8-4198-8252-051fe3edda2b"},{"name":"Update webhook","id":"8e846dae-8643-4a0a-ba13-c2567efc78d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"access_key\": \"\", // string (required)\r\n \"access_token\": \"\", // string (required)\r\n \"endpoint\": \"\" // https://printway.io\r\n}","options":{"raw":{"language":"json"}}},"url":"/webhooks?type=tracking","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}},"urlObject":{"path":["webhooks"],"host":[""],"query":[{"description":{"content":"

tracking | order, default: tracking

\n","type":"text/plain"},"key":"type","value":"tracking"}],"variable":[]}},"response":[],"_postman_id":"8e846dae-8643-4a0a-ba13-c2567efc78d8"},{"name":"Delete webhook","id":"a77f7a29-4c91-46ab-8af3-549b18b6dd96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"pw-access-token","value":"ACCESS_TOKEN","type":"text"}],"url":"/webhooks?type=order","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}},"urlObject":{"path":["webhooks"],"host":[""],"query":[{"description":{"content":"

tracking | order, default: tracking

\n","type":"text/plain"},"key":"type","value":"order"}],"variable":[]}},"response":[],"_postman_id":"a77f7a29-4c91-46ab-8af3-549b18b6dd96"}],"id":"b62c01ba-158d-4e59-85e8-93f35c68ef3f","_postman_id":"b62c01ba-158d-4e59-85e8-93f35c68ef3f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","id":"a4b4c82f-f299-47f6-a705-6807cfbca19d","name":"Printway APIs documentation v3.0","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"8a8e8e7e-219a-4db5-ba54-9ba4cf23d276","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e79d8d0-8e6b-4e46-b9b7-1e01fbc072c3","type":"text/javascript","exec":[""]}}],"variable":[{"key":"pw_origin_api","value":"","type":"string"},{"key":"pw_access_token","value":"","type":"string"}]}