Update Customer
Uri: https://api.finerworks.com/v3/update_customer
Method: POST

Updates an existing order's customer (shipping information).


Body

Customer address details to be submitted via JSON

NameDescriptionTypeAdditional information
order_id

Assigned FinerWorks order id number

number

Required

customer_info

Name and address information of your customer (the shipping address).

address

None.

Example JSON Body

application/json, text/json

{
  "order_id": 12345,
  "customer_info": {
    "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": "12345"
  }
}

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_id": 12345,
  "customer_info": {
    "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": "12345"
  }
}'
                            
                        


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_id': 12345,
  'customer_info': {
    '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': '12345'
  }
}');
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_id': 12345,
  'customer_info': {
    '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': '12345'
  }
},  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_id': 12345,
  'customer_info': {
    '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': '12345'
  }
}),
};

$.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_id": 12345,
  "customer_info": {
    "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": "12345"
  }
});

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_id': 12345,
  'customer_info': {
    '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': '12345'
  }
}"

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


                        

NameDescriptionTypeAdditional information
success

Indicates if the status returned was successful

boolean

None.

status_code

HTTP Status code

HttpStatusCode

None.

message

Additional information may be included here

text

None.

debug

Used to assist debugging any errors

Object

None.

Example JSON Response

application/json, text/json

{
  "success": true,
  "status_code": 200,
  "message": "",
  "debug": null
}