Type
|
List
|
List
|
Orders
|
URL
|
http://{domain}/api/v2/orders/fulfillment.json
|
Accepts Filters
|
Yes
|
Output Attributes
|
No
|
List Fulfillments
Gets the filtered list of Fulfillments.
Filters
Filter the Fulfillments into a list.
Parameter
|
Type
|
Rules
|
Example
|
status
|
int
|
Fulfillment status
|
1
|
order_status
|
int
|
Order status
|
3
|
company
|
int
|
The Company ID
|
2
|
shipping_provider
|
int
|
The Shipping Provider ID
|
5
|
shipping_provider_class
|
int
|
The Shipping Provider Class ID
|
51
|
customer_id
|
int
|
The Customer ID
|
8
|
customer_type
|
int
|
Type of customer
|
2
|
sale_channel
|
int
|
The Sales Channel ID
|
4
|
warehouse
|
int
|
The Warehouse ID
|
1
|
order_id
|
int
|
The ID of the Order
|
8
|
alternative_id
|
string
|
|
41ABX
|
tracking_number
|
string
|
The Tracking Number of the Order
|
565981684TF74
|
placed_start
|
date
|
Start point of when the Order was placed.
|
1431377356
|
placed_end
|
date
|
End point of when the Order was placed.
|
1431377356
|
modify_start
|
date
|
|
1431377356
|
modify_end
|
date
|
|
1431377356
|
Pagination
Parameters can be added to the CURL call to paginate the List.
The maximum limit is 250. By default, this limit is set to 100.
Parameter
|
Type
|
Default
|
Example
|
limit
|
int
|
1
|
2
|
page
|
int
|
1
|
5
|
Status of Orders
See Record Status section Order Status for status outputs. (See fulfillment section).
Response
Example JSON returned
{
"code": "200",
"data": {
"1": [
{
"id": "1",
"tracking": "",
"line_items": "2",
"total_items": "20",
"weight": "34.60",
"ship_date": "",
"shipping_cost": "",
"status": "2"
},
{
"id": "2",
"tracking": "565981684TF74",
"line_items": "1",
"total_items": "5",
"weight": "8.65",
"ship_date": "1434405368",
"shipping_cost": "8.97",
"status": "5"
}
]
}
}