Orders
GET/v1/ordersRequest
Query Params
page
string
optional
A page number within the paginated result set.
Example:
1
limit
string
optional
Number of results to return per page.
Example:
25
id
string
optional
Filter by Swiftpod order id.
Example:
j76qew83
order_id
string
optional
Filter by your order id.
status
string
optional
Filter by order status choices. Multiple allowed (?status[]=in_production&status[]=cancelled&status[]=rejected&status[]=new_order&status[]=shipped&status=in_production_cancelled).
rejected_status
string
optional
Filter by order rejected status choices. Multiple allowed (?rejected_status[]=ip_violation&rejected_status[]=invalid_artwork)
created_at_before
string
optional
Show before created_at. Structured as UTC date (format: 2022-12-01)
Example:
2022-12-01
created_at_after
string
optional
Show after created_at. Structured as UTC date (format: 2022-01-31)
Example:
2022-01-31
trackings_created_at_before
string
optional
Show before trackings_created_at. Structured as UTC date (format: 2022-12-01)
Example:
2022-12-01
trackings_created_at_after
string
optional
Show after trackings_created_at. Structured as UTC date (format: 2022-01-31)
Example:
2022-01-31
Header Params
Accept
string
optional
Example:
application/json
Request samples
Responses
Orders(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
current_page
integer
required
data
array [object {21}]
required
id
integer
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
optional
rejected_status
null
optional
cancelled_at
null
optional
line_items
array [object {5}]
required
trackings
array [object {8}]
optional
shipping_method
string
required
ioss_number
string
optional
address
object
required
is_fba_order
boolean
optional
fba_shipping_label
string
optional
fba_item_label
string
optional
return_address
null
optional
insert
array [object {3}]
optional
first_page_url
string
required
from
integer
required
last_page
integer
required
last_page_url
string
required
links
array [object {3}]
required
url
string | null
required
label
string
required
active
boolean
required
next_page_url
null
required
path
string
required
per_page
integer
required
prev_page_url
null
required
to
integer
required
total
integer
required
ExampleOrders
{
"current_page": 1,
"data": [
{
"id": 630221,
"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": "INSERT-042",
"print_files": [
{
"key": "front",
"url": ""
},
{
"key": "pocket",
"url": ""
},
{
"key": "rightsleeve",
"url": ""
},
{
"key": "outernecklabel",
"url": ""
}
]
}
],
"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",
"force_verified_delivery": false,
"verified_message": null
},
"is_fba_order": true,
"fba_shipping_label": "https://printfilefix.s3.amazonaws.com/shipping_label.png",
"fba_item_label": "https://printfilefix.s3.amazonaws.com/item_label.png",
"return_address": null,
"insert": [
{
"name": "packing_slip",
"url": "https://res.cloudinary.com/dh2tzfqa8/image/upload/v1683613550/8.5x11_tlwtso.png",
"size": "8.5x11"
},
{
"name": "thankyou_card",
"url": "https://res.cloudinary.com/dh2tzfqa8/image/upload/v1683613859/1000x2000_fuyxl8.png",
"size": "4x6"
}
]
}
],
"first_page_url": "http://api-test.swiftpod.com/v1/orders?limit=25&order_id=INSERT-042&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://api-test.swiftpod.com/v1/orders?limit=25&order_id=INSERT-042&page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://api-test.swiftpod.com/v1/orders?limit=25&order_id=INSERT-042&page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://api-test.swiftpod.com/v1/orders",
"per_page": 1,
"prev_page_url": null,
"to": 1,
"total": 1
}Last modified: 3 months ago