Zig
Zig
PayPal - Update Invoice
See more PayPal Examples
Update a PayPal invoice.Note: This example requires Chilkat v9.5.0.65 or greater.
See also PayPal Update Invoice REST API Reference
Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
// Note: Requires Chilkat v9.5.0.65 or greater.
// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
const json_token = try chilkat.JsonObject.init();
defer json_token.deinit();
json_token.loadFile("qa_data/tokens/paypal.json") catch {};
// Build the Authorization request header field value.
const sb_auth = try chilkat.StringBuilder.init();
defer sb_auth.deinit();
// token_type should be "Bearer"
sb_auth.append(try json_token.stringOf(alloc, "token_type")) catch {};
sb_auth.append(" ") catch {};
sb_auth.append(try json_token.stringOf(alloc, "access_token")) catch {};
// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
const rest = try chilkat.Rest.init();
defer rest.deinit();
const b_auto_reconnect = true;
rest.connect("api.sandbox.paypal.com", 443, true, b_auto_reconnect) catch {
std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
return;
};
// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request. Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------
// First create the JSON with updated information:
const json = try chilkat.JsonObject.init();
defer json.deinit();
json.setEmitCompact(false);
json.updateString("merchant_info.email", "smith-facilitator@chilkatsoft.com") catch {};
json.updateString("merchant_info.first_name", "Joe") catch {};
json.updateString("merchant_info.last_name", "Facilitator") catch {};
json.updateString("merchant_info.business_name", "Medical Professionals, LLC") catch {};
json.updateString("merchant_info.phone.country_code", "001") catch {};
json.updateString("merchant_info.phone.national_number", "5032141716") catch {};
json.updateString("merchant_info.address.line1", "1234 Main St.") catch {};
json.updateString("merchant_info.address.city", "Portland") catch {};
json.updateString("merchant_info.address.state", "OR") catch {};
json.updateString("merchant_info.address.postal_code", "97217") catch {};
json.updateString("merchant_info.address.country_code", "US") catch {};
json.updateString("billing_info[0].email", "smith-buyer@chilkatsoft.com") catch {};
json.updateString("shipping_info.first_name", "Sally") catch {};
json.updateString("shipping_info.last_name", "Patient") catch {};
json.updateString("shipping_info.business_name", "Not applicable") catch {};
json.updateString("shipping_info.phone.country_code", "001") catch {};
json.updateString("shipping_info.phone.national_number", "5039871234") catch {};
json.updateString("shipping_info.address.line1", "1234 Broad St.") catch {};
json.updateString("shipping_info.address.city", "Portland") catch {};
json.updateString("shipping_info.address.state", "OR") catch {};
json.updateString("shipping_info.address.postal_code", "97216") catch {};
json.updateString("shipping_info.address.country_code", "US") catch {};
json.updateString("items[0].name", "Sutures") catch {};
// We are updating the quantity from 100.0 to 200.0
// Note: The UpdateNumber method is added in v9.5.0.65
json.updateNumber("items[0].quantity", "200.0") catch {};
json.updateString("items[0].unit_price.currency", "USD") catch {};
json.updateString("items[0].unit_price.value", "5.00") catch {};
json.updateString("payment_term.term_type", "NET_45") catch {};
json.updateString("payment_term.due_date", "2016-12-30 PST") catch {};
json.updateString("note", "Medical Invoice 16 Jul, 2013 PST") catch {};
// The JSON created by the above code is this:
// {
// "merchant_info": {
// "email": "smith-facilitator@chilkatsoft.com",
// "first_name": "Joe",
// "last_name": "Facilitator",
// "business_name": "Medical Professionals, LLC",
// "phone": {
// "country_code": "001",
// "national_number": "5032141716"
// },
// "address": {
// "line1": "1234 Main St.",
// "city": "Portland",
// "state": "OR",
// "postal_code": "97217",
// "country_code": "US"
// }
// },
// "billing_info": [
// {
// "email": "smith-buyer@chilkatsoft.com"
// }
// ],
// "shipping_info": {
// "first_name": "Sally",
// "last_name": "Patient",
// "business_name": "Not applicable",
// "phone": {
// "country_code": "001",
// "national_number": "5039871234"
// },
// "address": {
// "line1": "1234 Broad St.",
// "city": "Portland",
// "state": "OR",
// "postal_code": "97216",
// "country_code": "US"
// }
// },
// "items": [
// {
// "name": "Sutures",
// "quantity": 200.0,
// "unit_price": {
// "currency": "USD",
// "value": "5.00"
// }
// }
// ],
// "payment_term": {
// "term_type": "NET_45",
// "due_date": "2016-12-30 PST"
// },
// "note": "Medical Invoice 16 Jul, 2013 PST"
// }
rest.addHeader("Authorization", try sb_auth.getAsString(alloc)) catch {};
rest.addHeader("Content-Type", "application/json") catch {};
const invoice_id = "INV2-XV4B-736P-PLVN-SZCE";
const sb_path = try chilkat.StringBuilder.init();
defer sb_path.deinit();
sb_path.append("/v1/invoicing/invoices/") catch {};
sb_path.append(invoice_id) catch {};
// Send the PUT request containign the JSON in the request body, and get the JSON response.
const sb_json_request = try chilkat.StringBuilder.init();
defer sb_json_request.deinit();
json.emitSb(sb_json_request) catch {};
const sb_json_response = try chilkat.StringBuilder.init();
defer sb_json_response.deinit();
rest.fullRequestSb("PUT", try sb_path.getAsString(alloc), sb_json_request, sb_json_response) catch {
std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
return;
};
json.loadSb(sb_json_response) catch {};
std.debug.print("Response Status Code = {d}\n", .{rest.getResponseStatusCode()});
// Did we get a 200 success response?
if (rest.getResponseStatusCode() != 200) {
std.debug.print("{s}\n", .{try json.emit(alloc)});
std.debug.print("Failed.\n", .{});
return;
}
// Sample response JSON is shown below.
// Get some information..
std.debug.print("email: {s}\n", .{try json.stringOf(alloc, "merchant_info.email")});
std.debug.print("business_name: {s}\n", .{try json.stringOf(alloc, "merchant_info.business_name")});
const num_items = json.sizeOfArray("items");
var i: i32 = 0;
while (i < num_items) {
json.setI(i);
std.debug.print("item name: {s}\n", .{try json.stringOf(alloc, "items[i].name")});
std.debug.print("item quantity: {s}\n", .{try json.stringOf(alloc, "items[i].quantity")});
std.debug.print("item currency: {s}\n", .{try json.stringOf(alloc, "items[i].unit_price.currency")});
std.debug.print("item value: {s}\n", .{try json.stringOf(alloc, "items[i].unit_price.value")});
std.debug.print("----\n", .{});
i = i + 1;
}
std.debug.print("Success.\n", .{});
}