Orders
Good to know: All the methods shown below are synced to an example Swagger file URL and are kept up to date automatically with changes to the API.
Retrieve a list of orders
Retrieve a list of orders.
GET https://api-v2.printway.io/api/v2/orders/list
Request Body
| Name | Type | Description |
|---|---|---|
created_at_min* | string | String format date : YYYY-MM-DD HH:MM:SS |
created_at_max* | string | String format date : YYYY-MM-DD HH:MM:SS |
search | string | Search by Order ID, Order Name |
limit | number | The maximum number of results to show on a page (Min: 20; Max: 200) |
page | number | The page number |
{
"status": 200,
"message": "Get list order completed!",
"length": 3,
"page": 1,
"limit": 20,
"orders": [
{
"pw_order_id": "PW1000052",
"order_name": "#PW1234edd569",
"dtime_entered": "2023-05-16T03:40:16.399000-07:00",
"shipping_name": "Trung",
"shipping_phone": "123456789",
"shipping_email": "",
"shipping_address1": "Fairport",
"shipping_address2": "Mumblebone Plain",
"shipping_city": "New York City",
"shipping_province": "NY",
"shipping_province_code": "NY",
"shipping_zip": "12345",
"shipping_country": "US",
"shipping_country_code": "US",
"store_name": "Seller Gold's store",
"total_price": 1104.0,
"surcharge": 0,
"discount": 0,
"base_fee": 72.0,
"shipping_fee": 24.0,
"tax_fee": 0.0,
"trackings": [],
"order_items": [
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 24.0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 204.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
}
]
},
{
"pw_order_id": "PW1000053",
"order_name": "#PW1234edd5D69",
"dtime_entered": "2023-05-16T03:40:33.759000-07:00",
"shipping_name": "Trung",
"shipping_phone": "123456789",
"shipping_email": "",
"shipping_address1": "Fairport",
"shipping_address2": "Mumblebone Plain",
"shipping_city": "New York City",
"shipping_province": "NY",
"shipping_province_code": "NY",
"shipping_zip": "12345",
"shipping_country": "US",
"shipping_country_code": "US",
"store_name": "Seller Gold's store",
"total_price": 1104.0,
"surcharge": 0,
"discount": 0,
"base_fee": 72.0,
"shipping_fee": 24.0,
"tax_fee": 0.0,
"trackings": [],
"order_items": [
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 24.0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 204.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
}
]
},
{
"pw_order_id": "PW1000054",
"order_name": "#PW1234eSSdd5D69",
"dtime_entered": "2023-05-16T03:40:39.504000-07:00",
"shipping_name": "Trung",
"shipping_phone": "123456789",
"shipping_email": "",
"shipping_address1": "Fairport",
"shipping_address2": "Mumblebone Plain",
"shipping_city": "New York City",
"shipping_province": "NY",
"shipping_province_code": "NY",
"shipping_zip": "12345",
"shipping_country": "US",
"shipping_country_code": "US",
"store_name": "Seller Gold's store",
"total_price": 1104.0,
"surcharge": 0,
"discount": 0,
"base_fee": 72.0,
"shipping_fee": 24.0,
"tax_fee": 0.0,
"trackings": [],
"order_items": [
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 24.0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 204.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
}
]
}
]
}{
"status": 400,
"message": "Error! Invalid format string date. Please check again."
}Retrieve a specific orders
Retrieve a specific orders.
GET https://api-v2.printway.io/api/v2/orders/detail
Request Body
| Name | Type | Description |
|---|---|---|
pw_order_id* | string | Order ID in our system |
order_name* | string | Your order ID |
{
"status": 200,
"message": "Get detail order completed!",
"order": {
"pw_order_id": "PW1000072",
"order_name": "#Ptd1xfcddddae5D6t",
"dtime_entered": "2023-05-16T04:05:33.251000-07:00",
"shipping_name": "Trung",
"shipping_phone": "123456789",
"shipping_email": "",
"shipping_address1": "Fairport",
"shipping_address2": "Mumblebone Plain",
"shipping_city": "New York City",
"shipping_province": "NY",
"shipping_province_code": "NY",
"shipping_zip": "12345",
"shipping_country": "US",
"shipping_country_code": "US",
"store_name": "Seller Gold's store",
"total_price": 1104.0,
"surcharge": 0,
"discount": 0,
"base_fee": 72.0,
"shipping_fee": 24.0,
"tax_fee": 0.0,
"trackings": [],
"order_items": [
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 24.0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 204.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
},
{
"product_name": "Round wooden sign",
"quantity": 15,
"item_sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"url_mockup": null,
"item_note": null,
"order_status": "waiting",
"payment_status": "unpaid",
"base_cost": 12.0,
"shipping_cost": 0,
"tax_cost": 0.0,
"item_discount": 0,
"item_price": 180.0
}
]
}
}{
"status": 400,
"message": "Invalid! Not found order with pw_order_id: PW1000072 and order_id: Ptd1xfcddddae5D6t."
}Calculate price for order
Calculate price for order.
POST https://api-v2.printway.io/api/v2/orders/calculate-price-order
Request Body
| Name | Type | Description |
|---|---|---|
shipping_province_code* | string | |
shipping_country_code* | string | |
shipping_service | string | Service code: Standard : null AU Express: AUEX (ship AU) US 2 Days (Express): US2DAYS (ship US) US Ground, Special Priority: USGR (ship US) |
order_items* | list | Array item: [ { "made_in_location": "string", "product_name": "string", "quantity": "number", "item_sku": "string" } ] |
{
"status": 200,
"data": {
"discountApplied": [],
"quantity": 90,
"baseFee": 1080.0,
"shippingFee": 24.0,
"taxFee": 0.0,
"totalFee": 1104.0,
"discountFee": 0,
"discountShipping": 0,
"totalPrice": 1104.0,
"orderItems": [
{
"variantId": "ADULTMESHKNITSNEAKERS666-309317",
"sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"quantity": 15,
"baseFee": 180.0,
"shippingFee": 24.0,
"taxFee": 0.0,
"discountFee": 0,
"totalFee": 204.0
},
{
"variantId": "ADULTMESHKNITSNEAKERS666-309317",
"sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"quantity": 15,
"baseFee": 180.0,
"shippingFee": 0,
"taxFee": 0.0,
"discountFee": 0,
"totalFee": 180.0
},
{
"variantId": "ADULTMESHKNITSNEAKERS666-309317",
"sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"quantity": 15,
"baseFee": 180.0,
"shippingFee": 0,
"taxFee": 0.0,
"discountFee": 0,
"totalFee": 180.0
},
{
"variantId": "ADULTMESHKNITSNEAKERS666-309317",
"sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"quantity": 15,
"baseFee": 180.0,
"shippingFee": 0,
"taxFee": 0.0,
"discountFee": 0,
"totalFee": 180.0
},
{
"variantId": "ADULTMESHKNITSNEAKERS666-309317",
"sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"quantity": 15,
"baseFee": 180.0,
"shippingFee": 0,
"taxFee": 0.0,
"discountFee": 0,
"totalFee": 180.0
},
{
"variantId": "ADULTMESHKNITSNEAKERS666-309317",
"sku": "PW-ADULTMESHKNITSNEAKERS666-FRONT-33",
"quantity": 15,
"baseFee": 180.0,
"shippingFee": 0,
"taxFee": 0.0,
"discountFee": 0,
"totalFee": 180.0
}
]
}
}{
"status": 400,
"message": "Invalid! Item Quantity is invalid. Please enter valid item quantity."
}Create an order
Create an order.
POST https://api-v2.printway.io/api/v2/orders/create-new-order
Request Body
| Name | Type | Description |
|---|---|---|
order_id* | string | Your order ID |
shipping_name* | string | shipping name |
shipping_phone | string | |
shipping_address1* | string | |
shipping_address2 | string | |
shipping_city* | string | |
shipping_province* | string | |
shipping_province_code* | string | |
shipping_country* | string | |
shipping_country_code* | string | |
order_items* | list | Array Items: [ { "made_in_location": "string", "product_name": "string", "item_sku": "string", "quantity": "number", "variant_note": "string", "mockup_url": "string", "artwork_front" : "string url", "artwork_back" : "string url", "artwork_2" : "string url", "artwork_3" : "string url", "artwork_4" : "string url", "artwork_5" : "string url" } ] |
shipping_service | string | Service code: Standard : null AU Express: AUEX (ship AU) US 2 Days (Express): US2DAYS (ship US) US Ground, Special Priority: USGR (ship US) |
{
"status": 200,
"message": "Success! Create new order successfully!",
"data": {
"pwOrderId": "PW1000074",
"orderId": "#Ptdddsae5D6t"
}
}{
"status": 400,
"message": "Invalid! Item Quantity is invalid. Please enter valid item quantity."
}// Request:
{
"order_id": "--- Your Order Name ---",
"shipping_name": "--- Shipping Name (Required) ---",
"shipping_phone": "--- Shipping Phone Number (Optional) ---",
"shipping_address1": "--- Shipping Address1 (Required) ---",
"shipping_address2": "--- Shipping Address2 (Optional) ---",
"shipping_city": "--- Shipping City (Required) ---",
"shipping_province": "--- Shipping Province (Required) ---",
"shipping_province_code": "--- Shipping Province Code / State Code (Required) ---",
"shipping_zip": "--- Shipping ZipCode (Required) ---",
"shipping_country": "--- Shipping Country (Required) ---",
"shipping_country_code": "--- Shipping Country Code (ISO 3166-1 alpha-2) (Required) ---",
"shipping_service": "--- Shipping service (Code) (Optional) ---",
"order_items": [
{
"made_in_location": "--- Optional | If it's empty, get the auto-suggested location ---",
"product_name": "--- Product Name ---",
"item_sku": "--- New SKU of products ---",
"quantity": "--- Quantity ---",
"variant_note": "--- Note of Item ---",
"mockup_url" : "--- URL Mockup ---",
"artwork_front" : "--- URL file artwork ---",
"artwork_back" : "--- (Optional) ---",
"artwork_2" : "--- (Optional) ---",
"artwork_3" : "--- (Optional) ---",
"artwork_4" : "--- (Optional) ---",
"artwork_5" : "--- (Optional) ---"
}
]
}
// Example:
{
"order_id": "PW6MTEST",
"shipping_name": "Linca Rito",
"shipping_phone": 123456789,
"shipping_address1": "Fairport",
"shipping_address2": "Mumblebone Plain",
"shipping_city": "New York City",
"shipping_province": "NY",
"shipping_province_code": "NY",
"shipping_zip": 12345,
"shipping_country": "US",
"shipping_country_code": "US",
"shipping_service": null,
"order_items": [
{
"made_in_location": "VN",
"product_name": "Custom Metal Sign",
"item_sku": "PW-MTS-PRINT-24X24 INCHES",
"quantity": 15,
"variant_note": "test",
"mockup_url" : null,
"artwork_front" : null,
"artwork_back" : null,
"artwork_2" : null,
"artwork_3" : null,
"artwork_4" : null,
"artwork_5" : null
}
]
}Cancel an order pending
Cancel an order pending.
POST https://api-v2.printway.io/api/v2/orders/cancel-order
Request Body
| Name | Type | Description |
|---|---|---|
pw_order_id* | string | Order ID in our system |
order_name* | string | Your order ID |
{
"status": 200,
"message": "Success! Order PW1000072 has been canceled."
}
{
"status": 400,
"message": "Invalid! Not found order with pw_order_id: PW1000072 and order_id: Ptd1xfcddddae5D6t."
}Last updated