Shipping Options Multiple
Uri: https://test-api.finerworks.com/v3/list_shipping_options_multiple
Method: POST
Submit a list of orders to get a list of available shipping options with the required shipping_code needed when submitting an order for each order. This endpoint should be requested under the following conditions. Any changes to the recipient of an order, a product is added or deleted from an order, the quantity of the any product changes.
Body
Requests shipping options by using order details to be submitted via order details object in the body.
| Name | Description | Type | Additional information |
|---|---|---|---|
| orders | array (order_details) |
None. |
Example JSON Body
application/json, text/json
{
"orders": [
{
"order_po": "PO_0001",
"order_key": null,
"recipient": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "PO_0001"
},
"order_items": [
{
"product_order_po": "PO_0001",
"product_qty": 1,
"product_sku": "AP1234P1234",
"product_image": null,
"product_title": "The Big Blue Mountain",
"template": null,
"product_guid": "00000000-0000-0000-0000-000000000000",
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
],
"shipping_code": "SD",
"ship_by_date": null,
"customs_tax_info": null,
"gift_message": null,
"test_mode": false,
"webhook_order_status_url": null,
"document_url": null,
"acct_number_ups": null,
"acct_number_fedex": null,
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
},
{
"order_po": "PO_0002",
"order_key": null,
"recipient": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "PO_0002"
},
"order_items": [
{
"product_order_po": "PO_0002",
"product_qty": 1,
"product_sku": "AP1234P1234",
"product_image": null,
"product_title": "The Big Blue Mountain",
"template": null,
"product_guid": "00000000-0000-0000-0000-000000000000",
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
],
"shipping_code": "SD",
"ship_by_date": null,
"customs_tax_info": null,
"gift_message": null,
"test_mode": false,
"webhook_order_status_url": null,
"document_url": null,
"acct_number_ups": null,
"acct_number_fedex": null,
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
]
}
Sample Code Library
curl --location --request sample_method 'https://test-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 '{
"orders": [
{
"order_po": "PO_0001",
"order_key": null,
"recipient": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "PO_0001"
},
"order_items": [
{
"product_order_po": "PO_0001",
"product_qty": 1,
"product_sku": "AP1234P1234",
"product_image": null,
"product_title": "The Big Blue Mountain",
"template": null,
"product_guid": "00000000-0000-0000-0000-000000000000",
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
],
"shipping_code": "SD",
"ship_by_date": null,
"customs_tax_info": null,
"gift_message": null,
"test_mode": false,
"webhook_order_status_url": null,
"document_url": null,
"acct_number_ups": null,
"acct_number_fedex": null,
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
},
{
"order_po": "PO_0002",
"order_key": null,
"recipient": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "PO_0002"
},
"order_items": [
{
"product_order_po": "PO_0002",
"product_qty": 1,
"product_sku": "AP1234P1234",
"product_image": null,
"product_title": "The Big Blue Mountain",
"template": null,
"product_guid": "00000000-0000-0000-0000-000000000000",
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
],
"shipping_code": "SD",
"ship_by_date": null,
"customs_tax_info": null,
"gift_message": null,
"test_mode": false,
"webhook_order_status_url": null,
"document_url": null,
"acct_number_ups": null,
"acct_number_fedex": null,
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
]
}'
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-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('{
'orders': [
{
'order_po': 'PO_0001',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0001'
},
'order_items': [
{
'product_order_po': 'PO_0001',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
},
{
'order_po': 'PO_0002',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0002'
},
'order_items': [
{
'product_order_po': 'PO_0002',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
]
}');
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://test-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", "{
'orders': [
{
'order_po': 'PO_0001',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0001'
},
'order_items': [
{
'product_order_po': 'PO_0001',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
},
{
'order_po': 'PO_0002',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0002'
},
'order_items': [
{
'product_order_po': 'PO_0002',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
]
}, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
var settings = {
"url": "https://test-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({
'orders': [
{
'order_po': 'PO_0001',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0001'
},
'order_items': [
{
'product_order_po': 'PO_0001',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
},
{
'order_po': 'PO_0002',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0002'
},
'order_items': [
{
'product_order_po': 'PO_0002',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
]
}),
};
$.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({
"orders": [
{
"order_po": "PO_0001",
"order_key": null,
"recipient": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "PO_0001"
},
"order_items": [
{
"product_order_po": "PO_0001",
"product_qty": 1,
"product_sku": "AP1234P1234",
"product_image": null,
"product_title": "The Big Blue Mountain",
"template": null,
"product_guid": "00000000-0000-0000-0000-000000000000",
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
],
"shipping_code": "SD",
"ship_by_date": null,
"customs_tax_info": null,
"gift_message": null,
"test_mode": false,
"webhook_order_status_url": null,
"document_url": null,
"acct_number_ups": null,
"acct_number_fedex": null,
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
},
{
"order_po": "PO_0002",
"order_key": null,
"recipient": {
"first_name": "Bob",
"last_name": "Ross",
"company_name": "Happy Little Trees, Inc",
"address_1": "742 Evergreen Terrace",
"address_2": null,
"address_3": null,
"city": "Mountain Scene",
"state_code": "AK",
"province": null,
"zip_postal_code": "88888",
"country_code": "us",
"phone": "555-555-5555",
"email": null,
"address_order_po": "PO_0002"
},
"order_items": [
{
"product_order_po": "PO_0002",
"product_qty": 1,
"product_sku": "AP1234P1234",
"product_image": null,
"product_title": "The Big Blue Mountain",
"template": null,
"product_guid": "00000000-0000-0000-0000-000000000000",
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
],
"shipping_code": "SD",
"ship_by_date": null,
"customs_tax_info": null,
"gift_message": null,
"test_mode": false,
"webhook_order_status_url": null,
"document_url": null,
"acct_number_ups": null,
"acct_number_fedex": null,
"custom_data_1": null,
"custom_data_2": null,
"custom_data_3": null
}
]
});
req.write(postData);
req.end();
require "uri"
require "net/http"
url = URI("https://test-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 = "{
'orders': [
{
'order_po': 'PO_0001',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0001'
},
'order_items': [
{
'product_order_po': 'PO_0001',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
},
{
'order_po': 'PO_0002',
'order_key': null,
'recipient': {
'first_name': 'Bob',
'last_name': 'Ross',
'company_name': 'Happy Little Trees, Inc',
'address_1': '742 Evergreen Terrace',
'address_2': null,
'address_3': null,
'city': 'Mountain Scene',
'state_code': 'AK',
'province': null,
'zip_postal_code': '88888',
'country_code': 'us',
'phone': '555-555-5555',
'email': null,
'address_order_po': 'PO_0002'
},
'order_items': [
{
'product_order_po': 'PO_0002',
'product_qty': 1,
'product_sku': 'AP1234P1234',
'product_image': null,
'product_title': 'The Big Blue Mountain',
'template': null,
'product_guid': '00000000-0000-0000-0000-000000000000',
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
],
'shipping_code': 'SD',
'ship_by_date': null,
'customs_tax_info': null,
'gift_message': null,
'test_mode': false,
'webhook_order_status_url': null,
'document_url': null,
'acct_number_ups': null,
'acct_number_fedex': null,
'custom_data_1': null,
'custom_data_2': null,
'custom_data_3': null
}
]
}"
response = https.request(request)
puts response.read_body
| Name | Description | Type | Additional information |
|---|---|---|---|
| status | response_status |
None. |
|
| orders | array (order_shipping_options) |
None. |
Example JSON Response
application/json, text/json
{
"status": {
"success": true,
"status_code": 200,
"message": "",
"debug": null,
"reference_id": "d2559e57d7de4b428f02f358aeb60a9e"
},
"orders": [
{
"order_po": "PO_0001",
"options": [
{
"rate": 9.95,
"shipping_method": "USPS Priority Mail",
"shipping_code": "SD",
"calculated_total": {
"order_po": "PO_0001",
"order_subtotal": 122.0,
"order_shipping_rate": 9.95,
"order_discount": 0.0,
"order_sales_tax": 11.28,
"order_sales_tax_rate": 0.825,
"order_credits_used": 0.0,
"order_grand_total": 152.28,
"product_pricing": [
{
"product_qty": 1,
"product_sku": "AP1556P466112",
"product_code": "5M41M9S8X10F131S13X15J2S9X11G1",
"product_price": 8.0,
"add_frame_price": 9.0,
"add_mat_1_price": 10.0,
"add_mat_2_price": 0.0,
"add_glazing_price": 10.0,
"add_color_correct_price": 0.0,
"total_price": 122.0,
"info": null,
"debug": null
}
]
}
},
{
"rate": 21.05,
"shipping_method": "UPS Ground",
"shipping_code": "SD",
"calculated_total": {
"order_po": "PO_0001",
"order_subtotal": 122.0,
"order_shipping_rate": 21.05,
"order_discount": 0.0,
"order_sales_tax": 11.44,
"order_sales_tax_rate": 0.825,
"order_credits_used": 0.0,
"order_grand_total": 154.49,
"product_pricing": [
{
"product_qty": 1,
"product_sku": "AP1556P466112",
"product_code": "5M41M9S8X10F131S13X15J2S9X11G1",
"product_price": 8.0,
"add_frame_price": 9.0,
"add_mat_1_price": 10.0,
"add_mat_2_price": 0.0,
"add_glazing_price": 10.0,
"add_color_correct_price": 0.0,
"total_price": 122.0,
"info": null,
"debug": null
}
]
}
}
],
"order_size": null,
"preferred_option": null
}
]
}