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

Get Order

GET
/v1/orders/{id}

Request

Path Params
id
string 
required
Swiftpod Order ID
Header Params
id
string 
optional
Example:
Order-00699

Request 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 GET 'https://api.swiftpod.com/v1/orders/' \
--header 'id: Order-00699'

Responses

🟢200Get Order
application/json
Body
id
string 
required
order_id
string 
required
test_order
boolean 
required
sample_order
boolean 
required
reprint_order
boolean 
required
created_at
string 
required
updated_at
string 
required
status
string 
required
rejected_at
null 
required
rejected_status
null 
required
cancelled_at
null 
required
line_items
array [object {5}] 
required
id
integer 
required
sku
string 
required
quantity
integer 
required
order_item_id
string 
required
print_files
array [object {2}] 
required
trackings
array [object {8}] 
optional
tracking_number
string 
optional
tracking_url
string 
optional
carrier
string 
optional
created_at
string 
optional
status
string 
optional
label_url
string 
optional
shipped_items
object 
optional
primary
boolean 
optional
shipping_method
string 
required
ioss_number
string 
optional
address
object 
required
name
string 
required
company
null 
required
phone
string 
required
street1
string 
required
street2
null 
required
city
string 
required
state
string 
required
country
string 
required
zip
string 
required
return_address
null 
required
insert
array [object {3}] 
optional
name
string 
required
url
string 
required
size
string 
required
Example
{
  "id": "06lz3a11",
  "order_id": "Example-042",
  "test_order": false,
  "sample_order": false,
  "reprint_order": false,
  "created_at": "2023-05-11T02:24:48.000000Z",
  "updated_at": "2023-05-11T02:24:48.000000Z",
  "status": "new_order",
  "rejected_at": null,
  "rejected_status": null,
  "cancelled_at": null,
  "line_items": [
    {
      "id": 795657,
      "sku": "WORB3H00L",
      "quantity": 2,
      "order_item_id": "Example-042",
      "print_files": [
        {
          "key": "front",
          "url": "https://via.placeholder.com/2400/09f/fff.png"
        },
        {
          "key": "pocket",
          "url": "https://via.placeholder.com/2400/09f/fff.png"
        },
        {
          "key": "rightsleeve",
          "url": "https://via.placeholder.com/2400/09f/fff.png"
        },
        {
          "key": "outernecklabel",
          "url": "https://via.placeholder.com/2400/09f/fff.png"
        }
      ]
    }
  ],
  "trackings": [
    {
      "tracking_number": "IGAY0CX...U8K",
      "tracking_url": "https://a1.asendiausa.com/tracking/?trackingnumber=xxxx",
      "carrier": "AsendiaUsa",
      "created_at": "2023-04-27T11:39:34.000000Z",
      "status": "unknown",
      "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
      "shipped_items": [
        {
          "order_item_id": "Example-042-001",
          "quantity": 3
        }
      ],
      "primary": false
    },
    {
      "tracking_number": "LM334....8US",
      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=xxx",
      "carrier": "USPS",
      "created_at": "2023-04-27T11:40:08.000000Z",
      "status": "pre_transit",
      "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
      "shipped_items": [
        {
          "order_item_id": "Example-042-002",
          "quantity": 3
        },
        {
          "order_item_id": "Example-042-003",
          "quantity": 1
        }
      ],
      "primary": true
    }
  ],
  "shipping_method": "standard",
  "ioss_number": "IM84cbd25",
  "address": {
    "name": "Lynda Adner",
    "company": null,
    "phone": "(+1) 415-419-8616 ext. 60877",
    "street1": "5 N CLARKSON AVE",
    "street2": null,
    "city": "MASSENA",
    "state": "NY",
    "country": "FR",
    "zip": "21364"
  },
  "return_address": null,
  "insert": [
    {
      "name": "packing_slip",
      "url": "https://via.placeholder.com/2400/09f/fff.png",
      "size": "8.5x11"
    },
    {
      "name": "gift_message",
      "url": "https://swiftpod.s3.us-west-1.amazonaws.com/demo/gift-card.jpg",
      "size": "4x6"
    }
  ]
}
Previous
Create Multiple Orders
Next
Update Order
Built with