Shipping Options Multiple
Uri: https://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 to be used when submitting an order for each order.

Body

Requests shipping options by using order details to be submitted via order details object in the body.

NameDescriptionTypeAdditional information
orders

array (order_details)

None.

Example JSON Body

application/json, text/json

{
  "orders": [
    {
      "order_po": "sample string 1",
      "order_key": "14d3aaaf-b25e-4c94-9aea-ae01ced1fce8",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "ship_by_date": "2024-05-04T04:28:37.5951853-05:00",
      "customs_tax_info": {
        "tax_id": "sample string 1",
        "tax_type": 0
      },
      "gift_message": "sample string 3",
      "test_mode": true,
      "webhook_order_status_url": "sample string 5",
      "document_url": "sample string 6",
      "acct_number_ups": "sample string 7",
      "acct_number_fedex": "sample string 8",
      "custom_data_1": "sample string 9",
      "custom_data_2": "sample string 10",
      "custom_data_3": "sample string 11"
    },
    {
      "order_po": "sample string 1",
      "order_key": "14d3aaaf-b25e-4c94-9aea-ae01ced1fce8",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "ship_by_date": "2024-05-04T04:28:37.5951853-05:00",
      "customs_tax_info": {
        "tax_id": "sample string 1",
        "tax_type": 0
      },
      "gift_message": "sample string 3",
      "test_mode": true,
      "webhook_order_status_url": "sample string 5",
      "document_url": "sample string 6",
      "acct_number_ups": "sample string 7",
      "acct_number_fedex": "sample string 8",
      "custom_data_1": "sample string 9",
      "custom_data_2": "sample string 10",
      "custom_data_3": "sample string 11"
    }
  ]
}

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 '{
  "orders": [
    {
      "order_po": "sample string 1",
      "order_key": "14d3aaaf-b25e-4c94-9aea-ae01ced1fce8",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "ship_by_date": "2024-05-04T04:28:37.5951853-05:00",
      "customs_tax_info": {
        "tax_id": "sample string 1",
        "tax_type": 0
      },
      "gift_message": "sample string 3",
      "test_mode": true,
      "webhook_order_status_url": "sample string 5",
      "document_url": "sample string 6",
      "acct_number_ups": "sample string 7",
      "acct_number_fedex": "sample string 8",
      "custom_data_1": "sample string 9",
      "custom_data_2": "sample string 10",
      "custom_data_3": "sample string 11"
    },
    {
      "order_po": "sample string 1",
      "order_key": "14d3aaaf-b25e-4c94-9aea-ae01ced1fce8",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "ship_by_date": "2024-05-04T04:28:37.5951853-05:00",
      "customs_tax_info": {
        "tax_id": "sample string 1",
        "tax_type": 0
      },
      "gift_message": "sample string 3",
      "test_mode": true,
      "webhook_order_status_url": "sample string 5",
      "document_url": "sample string 6",
      "acct_number_ups": "sample string 7",
      "acct_number_fedex": "sample string 8",
      "custom_data_1": "sample string 9",
      "custom_data_2": "sample string 10",
      "custom_data_3": "sample string 11"
    }
  ]
}'
                            
                        


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('{
  'orders': [
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    },
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    }
  ]
}');
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", "{
  'orders': [
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    },
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    }
  ]
},  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({
  'orders': [
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    },
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    }
  ]
}),
};

$.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": "sample string 1",
      "order_key": "14d3aaaf-b25e-4c94-9aea-ae01ced1fce8",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "ship_by_date": "2024-05-04T04:28:37.5951853-05:00",
      "customs_tax_info": {
        "tax_id": "sample string 1",
        "tax_type": 0
      },
      "gift_message": "sample string 3",
      "test_mode": true,
      "webhook_order_status_url": "sample string 5",
      "document_url": "sample string 6",
      "acct_number_ups": "sample string 7",
      "acct_number_fedex": "sample string 8",
      "custom_data_1": "sample string 9",
      "custom_data_2": "sample string 10",
      "custom_data_3": "sample string 11"
    },
    {
      "order_po": "sample string 1",
      "order_key": "14d3aaaf-b25e-4c94-9aea-ae01ced1fce8",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "template": {},
          "product_guid": "0e4ef469-4843-4e83-a6e0-3eaffb4b8e25",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "ship_by_date": "2024-05-04T04:28:37.5951853-05:00",
      "customs_tax_info": {
        "tax_id": "sample string 1",
        "tax_type": 0
      },
      "gift_message": "sample string 3",
      "test_mode": true,
      "webhook_order_status_url": "sample string 5",
      "document_url": "sample string 6",
      "acct_number_ups": "sample string 7",
      "acct_number_fedex": "sample string 8",
      "custom_data_1": "sample string 9",
      "custom_data_2": "sample string 10",
      "custom_data_3": "sample string 11"
    }
  ]
});

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 = "{
  'orders': [
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    },
    {
      'order_po': 'sample string 1',
      'order_key': '14d3aaaf-b25e-4c94-9aea-ae01ced1fce8',
      'recipient': {
        'first_name': 'sample string 1',
        'last_name': 'sample string 2',
        'company_name': 'sample string 3',
        'address_1': 'sample string 4',
        'address_2': 'sample string 5',
        'address_3': 'sample string 6',
        'city': 'sample string 7',
        'state_code': 'sample string 8',
        'province': 'sample string 9',
        'zip_postal_code': 'sample string 10',
        'country_code': 'sample string 11',
        'phone': 'sample string 12',
        'email': 'sample string 13',
        'address_order_po': 'sample string 14'
      },
      'order_items': [
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        },
        {
          'product_order_po': 'sample string 1',
          'product_qty': 2,
          'product_sku': 'sample string 3',
          'product_image': {
            'pixel_width': 1,
            'pixel_height': 2,
            'product_url_file': 'sample string 3',
            'product_url_thumbnail': 'sample string 4'
          },
          'product_title': 'sample string 5',
          'template': {},
          'product_guid': '0e4ef469-4843-4e83-a6e0-3eaffb4b8e25',
          'custom_data_1': 'sample string 8',
          'custom_data_2': 'sample string 9',
          'custom_data_3': 'sample string 10'
        }
      ],
      'shipping_code': 'sample string 2',
      'ship_by_date': '2024-05-04T04:28:37.5951853-05:00',
      'customs_tax_info': {
        'tax_id': 'sample string 1',
        'tax_type': 0
      },
      'gift_message': 'sample string 3',
      'test_mode': true,
      'webhook_order_status_url': 'sample string 5',
      'document_url': 'sample string 6',
      'acct_number_ups': 'sample string 7',
      'acct_number_fedex': 'sample string 8',
      'custom_data_1': 'sample string 9',
      'custom_data_2': 'sample string 10',
      'custom_data_3': 'sample string 11'
    }
  ]
}"

    response = https.request(request)
    puts response.read_body

NameDescriptionTypeAdditional 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
  },
  "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
    }
  ]
}