Update Order
PUT
/v1/orders/JXW6VDOKYou can update order detail when order status is Draft.
Request
A unique ID that you provide to track orders. Swiftpod will raise an error if you have any orders with the same order_id.
When the parameter is set to TRUE, the test order functionality is activated, specifically designed for testing the system's operation. This feature generates simulated order processes with distinct stages which are "new order", "in production", and "shipped" with fictitious tracking number. Test orders are not meant to be fulfilled or billed and can be conveniently monitored and tracked within our internal dashboard.
Default value: new_order
The value is 5 for TikTok orders with TikTok labels and 6 for TikTok orders
Required when order_type = 5. Sample link for tiktok orders: https://thddtxn3pa.s3.amazonaws.com/sample_label.usps.s4x6.pdf
A list of line item objects, each containing information about an item in the order.
A unique ID that you provide to track line items. We will raise an error if you have other line items with the same order_item_id.
SKU of the item variant to fulfill. You can find all available IDs for an item in the catalog.
Your product name
The number of items to fulfill. Must be 1 or greater.
The recommended dimensions for the neck label are 2.5 x 2 inches (or approximately 750 x 600 pixels) at 300 dpi resolution, which provides high-quality printing results. Do not use when order_type = 7.
Array of attached preview images. Do not use when order_type = 7.
Use only when order_type = 7, as it is required to identify the artwork's file number
Address for order delivery. We will attempt to verify all addresses before accepting orders.
Full name
Required with country 'US'
Must be formatted as ISO 3166-1 two-letter country code.
Address for return order delivery. We will attempt to verify all addresses before accepting orders. if you send data on it will be shown in label tracking
Full name
Required with country 'US'
Must be formatted as ISO 3166-1 two-letter country code.
Additional charges for faster shipping will apply. Please reach out to your sales representative to get the pricing before sending express orders.
Sample Order - For Reconciliation Only. Permission required
Reprint Order - For Reconciliation Only. Permission required
Set this field to “true” if it’s an FBA Amazon order, “false” if it’s not. It’s important to note that this field is optional and should only be used for FBA orders. Please reach out to your Sales Representative before placing this.
If the “is_fba_order” field is set to “true”, then this field is required. The value of this field contains the URL where the image file of the shipping label is located. Please ignore this field if it’s not an FBA Amazon Order.
If the “is_fba_order” field is set to “true”, then this field is required. The value of this field contains the URL where the image file of item label is located. Please ignore this field if it’s not an FBA Amazon Order.
IOSS number: Import One-Stop Shop. The "IOSS number" is assigned to suppliers and electronic interfaces who sell goods to EU buyers. It allows them to handle VAT collection, declaration, and payment to tax authorities, instead of buyers paying VAT during import for goods costing over 22 EUR. For example: IM0560341269. The IOSS number will be displayed on the shipping label.
Tax id number. This field becomes mandatory if 'tax_id_type' contains a value.
This field becomes mandatory if 'tax_id' contains a value.
The insert array is used to specify additional attachments that should be included with an order. The name available is 'packing_slip'. For 'packing_slip', please provide a valid URL for a PDF or image file in the respective field. If you do not wish to include any attachments with the order, please disregard this array. Please note that each order can have a maximum of one packing slip.
Should be PDF URL or image URL
Currently we only support size 8.5x11.
Set this field to 'true' if the order needs to be packed in clear plastic bag packaging, "false" if it's not.
Use this field to specify the custom packaging. Please contact Customer support before sending orders with these services
{
"order_id": "JXW6VDOK",
"test_order": true,
"order_status": "draft",
"line_items": [
{
"order_item_id": "1-c33",
"sku": "YOUT1Q0XS",
"name": "Line Item 1",
"quantity": 3,
"print_files": [
{
"key": "front",
"url": "https://via.placeholder.com/2400/09f/fff.png"
},
{
"key": "back",
"url": "https://via.placeholder.com/2400/09f/fff.png"
}
],
"preview_files": [
{
"key": "front",
"url": "https://via.placeholder.com/2400/09f/fff.png"
},
{
"key": "back",
"url": "https://via.placeholder.com/2400/09f/fff.png"
}
]
}
],
"address": {
"name": "John Smith",
"email": "johnsmith@demo.com",
"company": "DEMO",
"phone": "(330) 638-1331",
"street1": "4736 Phillips Rice Rd",
"street2": "",
"city": "Cortland",
"state": "OH",
"country": "US",
"zip": "44410",
"force_verified_status": true
},
"return_address": {
"name": "John Smith",
"email": "johnsmith@demo.com",
"company": "DEMO",
"phone": "(330) 638-1331",
"street1": "4736 Phillips Rice Rd",
"street2": "",
"state": "OH",
"city": "Cortland",
"country": "US",
"zip": "44410"
},
"shipping_method": "standard"
}
Request samples
Responses
{
"status": true,
"message": "Success.",
"data": {
"id": "j7ab12cd",
"order_id": "OD-ZA-3-c10"
}
}