SwiftPOD
  1. Api
SwiftPOD
  • Api
    • Webhook
      • List Webhooks
      • Subscribe to Webhook
      • Unsubcribe to webhook
      • Webhook Notification - Order Status Change Example
      • Webhook Notification - Tracking Number Example
      • Webhook Notification - In Transit and Delivered Status Example
      • Webhook Notification - Stock Status Change Example
    • Orders
      GET
    • Create Order
      POST
    • Create Multiple Orders
      POST
    • Get Order
      GET
    • Update Order
      PUT
    • Update Order Status
      PUT
    • Cancel Order
      POST
    • Catalogs
      GET
  • Changelog
  1. Api

Create Order

POST
/v1/orders

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/json

Example
{
    "order_id": "testord01",
    "test_order": false,
    "order_status": "new_order",
    "line_items": [
        {
            "order_item_id": "item_01",
            "sku": "YOUT1Q0XS",
            "name": "Line Item 1",
            "quantity": 1,
            "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",
    "tax_id": "IM0123456888",
    "tax_id_type": "IOSS",
    "insert": [
        {
            "name": "gift_message",
            "url": "https://swiftpod.s3.us-west-1.amazonaws.com/demo/gift-card.jpg",
            "size": "8.5x11"
        }
    ],
    "additional_service": [
        "sticker_and_bag",
        "hologram_sticker"
    ],
    "ship_by_date": "2025-01-19T20:35:47Z"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.swiftpod.com/v1/orders' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_id": "testord01",
    "test_order": false,
    "order_status": "new_order",
    "line_items": [
        {
            "order_item_id": "item_01",
            "sku": "YOUT1Q0XS",
            "name": "Line Item 1",
            "quantity": 1,
            "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",
    "tax_id": "IM0123456888",
    "tax_id_type": "IOSS",
    "insert": [
        {
            "name": "gift_message",
            "url": "https://swiftpod.s3.us-west-1.amazonaws.com/demo/gift-card.jpg",
            "size": "8.5x11"
        }
    ],
    "additional_service": [
        "sticker_and_bag",
        "hologram_sticker"
    ],
    "ship_by_date": "2025-01-19T20:35:47Z"
}'

Responses

🟢201Create Order
text/plain
Body

Example
{
    "status": true,
    "message": "Success.",
    "data": {
        "id": "06lz3a11",
        "order_id": "OD-ZA-30"
    }
}
Modified at 2025-08-04 03:29:08
Previous
Orders
Next
Create Multiple Orders
Built with