Get Order Status
Uri: https://api.finerworks.com/v3/fetch_order_status
Method: POST
Retrieves an order's current "production" status. If an order is not found, no status will be returned.
Body
Order udpate details to be submitted via XML or JSON
Name | Description | Type | Additional information |
---|---|---|---|
order_pos |
List of unique order submission order_pos. |
array (text) |
None. |
order_ids |
List of unique order submission reference ids you received after your order was successfully submitted. Not required if submitting order_pos |
array (number) |
Required |
Example JSON Body
application/json, text/json
{ "order_pos": null, "order_ids": [ 123456, 123457 ] }
Sample Code Library
curl --location --request sample_method 'https://api.finerworks.comsample_endpoint' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
"order_pos": null,
"order_ids": [
123456,
123457
]
}'
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
'order_pos': null,
'order_ids': [
123456,
123457
]
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
var client = new RestClient("https://api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
'order_pos': null,
'order_ids': [
123456,
123457
]
}, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
var settings = {
"url": "https://api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
'order_pos': null,
'order_ids': [
123456,
123457
]
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'sample_method',
'hostname': 'api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
var postData = JSON.stringify({
"order_pos": null,
"order_ids": [
123456,
123457
]
});
req.write(postData);
req.end();
require "uri"
require "net/http"
url = URI("https://api.finerworks.comsample_endpoint")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::sample_method.new(url)
request["Content-Type"] = "application/json"
request["web_api_key"] = "my-web-api-key-goes-here"
request["app_key"] = "my-app-key-goes-here"
request.body = "{
'order_pos': null,
'order_ids': [
123456,
123457
]
}"
response = https.request(request)
puts response.read_body
Name | Description | Type | Additional information |
---|---|---|---|
status | response_status |
None. |
|
orders | array (order_status) |
None. |
Example JSON Response
application/json, text/json
{ "status": { "success": true, "status_code": 200, "message": "", "debug": null }, "orders": [ { "order_confirmation_id": 411111111, "order_po": "PO_0001", "order_id": 123456, "order_status_id": 7, "order_status_label": "Shipped", "shipments": [ { "creation_date": null, "shipment_date": "2024-10-09T07:31:08.4424567-05:00", "eta_date": null, "delivery_date": "2024-10-11T09:34:08.4424567-05:00", "weight": 3.0, "width": 24.0, "height": 18.0, "depth": 5.0, "tracking_number": "1HYZ1234567890", "tracking_url": "https://shippingservice.com/?tracking=1HYZ1234567890", "carrier": null, "history": null } ] }, { "order_confirmation_id": 411111111, "order_po": "PO_0001", "order_id": 123456, "order_status_id": 7, "order_status_label": "Shipped", "shipments": [ { "creation_date": null, "shipment_date": "2024-10-09T07:31:08.4424567-05:00", "eta_date": null, "delivery_date": "2024-10-11T09:34:08.4424567-05:00", "weight": 3.0, "width": 24.0, "height": 18.0, "depth": 5.0, "tracking_number": "1HYZ1234567890", "tracking_url": "https://shippingservice.com/?tracking=1HYZ1234567890", "carrier": null, "history": null } ] } ] }