C
C
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 C Downloads
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkRest.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObject jsonToken;
HCkStringBuilder sbAuth;
HCkRest rest;
BOOL bAutoReconnect;
HCkJsonObject json;
const char *invoiceId;
HCkStringBuilder sbPath;
HCkStringBuilder sbJsonRequest;
HCkStringBuilder sbJsonResponse;
int numItems;
int i;
success = FALSE;
// 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)
jsonToken = CkJsonObject_Create();
CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/paypal.json");
// Build the Authorization request header field value.
sbAuth = CkStringBuilder_Create();
// token_type should be "Bearer"
CkStringBuilder_Append(sbAuth,CkJsonObject_stringOf(jsonToken,"token_type"));
CkStringBuilder_Append(sbAuth," ");
CkStringBuilder_Append(sbAuth,CkJsonObject_stringOf(jsonToken,"access_token"));
// 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.
rest = CkRest_Create();
bAutoReconnect = TRUE;
success = CkRest_Connect(rest,"api.sandbox.paypal.com",443,TRUE,bAutoReconnect);
if (success != TRUE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
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:
json = CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,FALSE);
CkJsonObject_UpdateString(json,"merchant_info.email","smith-facilitator@chilkatsoft.com");
CkJsonObject_UpdateString(json,"merchant_info.first_name","Joe");
CkJsonObject_UpdateString(json,"merchant_info.last_name","Facilitator");
CkJsonObject_UpdateString(json,"merchant_info.business_name","Medical Professionals, LLC");
CkJsonObject_UpdateString(json,"merchant_info.phone.country_code","001");
CkJsonObject_UpdateString(json,"merchant_info.phone.national_number","5032141716");
CkJsonObject_UpdateString(json,"merchant_info.address.line1","1234 Main St.");
CkJsonObject_UpdateString(json,"merchant_info.address.city","Portland");
CkJsonObject_UpdateString(json,"merchant_info.address.state","OR");
CkJsonObject_UpdateString(json,"merchant_info.address.postal_code","97217");
CkJsonObject_UpdateString(json,"merchant_info.address.country_code","US");
CkJsonObject_UpdateString(json,"billing_info[0].email","smith-buyer@chilkatsoft.com");
CkJsonObject_UpdateString(json,"shipping_info.first_name","Sally");
CkJsonObject_UpdateString(json,"shipping_info.last_name","Patient");
CkJsonObject_UpdateString(json,"shipping_info.business_name","Not applicable");
CkJsonObject_UpdateString(json,"shipping_info.phone.country_code","001");
CkJsonObject_UpdateString(json,"shipping_info.phone.national_number","5039871234");
CkJsonObject_UpdateString(json,"shipping_info.address.line1","1234 Broad St.");
CkJsonObject_UpdateString(json,"shipping_info.address.city","Portland");
CkJsonObject_UpdateString(json,"shipping_info.address.state","OR");
CkJsonObject_UpdateString(json,"shipping_info.address.postal_code","97216");
CkJsonObject_UpdateString(json,"shipping_info.address.country_code","US");
CkJsonObject_UpdateString(json,"items[0].name","Sutures");
// We are updating the quantity from 100.0 to 200.0
// Note: The UpdateNumber method is added in v9.5.0.65
CkJsonObject_UpdateNumber(json,"items[0].quantity","200.0");
CkJsonObject_UpdateString(json,"items[0].unit_price.currency","USD");
CkJsonObject_UpdateString(json,"items[0].unit_price.value","5.00");
CkJsonObject_UpdateString(json,"payment_term.term_type","NET_45");
CkJsonObject_UpdateString(json,"payment_term.due_date","2016-12-30 PST");
CkJsonObject_UpdateString(json,"note","Medical Invoice 16 Jul, 2013 PST");
// 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"
// }
CkRest_AddHeader(rest,"Authorization",CkStringBuilder_getAsString(sbAuth));
CkRest_AddHeader(rest,"Content-Type","application/json");
invoiceId = "INV2-XV4B-736P-PLVN-SZCE";
sbPath = CkStringBuilder_Create();
CkStringBuilder_Append(sbPath,"/v1/invoicing/invoices/");
CkStringBuilder_Append(sbPath,invoiceId);
// Send the PUT request containign the JSON in the request body, and get the JSON response.
sbJsonRequest = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbJsonRequest);
sbJsonResponse = CkStringBuilder_Create();
success = CkRest_FullRequestSb(rest,"PUT",CkStringBuilder_getAsString(sbPath),sbJsonRequest,sbJsonResponse);
if (success != TRUE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbPath);
CkStringBuilder_Dispose(sbJsonRequest);
CkStringBuilder_Dispose(sbJsonResponse);
return;
}
CkJsonObject_LoadSb(json,sbJsonResponse);
printf("Response Status Code = %d\n",CkRest_getResponseStatusCode(rest));
// Did we get a 200 success response?
if (CkRest_getResponseStatusCode(rest) != 200) {
printf("%s\n",CkJsonObject_emit(json));
printf("Failed.\n");
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbPath);
CkStringBuilder_Dispose(sbJsonRequest);
CkStringBuilder_Dispose(sbJsonResponse);
return;
}
// Sample response JSON is shown below.
// Get some information..
printf("email: %s\n",CkJsonObject_stringOf(json,"merchant_info.email"));
printf("business_name: %s\n",CkJsonObject_stringOf(json,"merchant_info.business_name"));
numItems = CkJsonObject_SizeOfArray(json,"items");
i = 0;
while (i < numItems) {
CkJsonObject_putI(json,i);
printf("item name: %s\n",CkJsonObject_stringOf(json,"items[i].name"));
printf("item quantity: %s\n",CkJsonObject_stringOf(json,"items[i].quantity"));
printf("item currency: %s\n",CkJsonObject_stringOf(json,"items[i].unit_price.currency"));
printf("item value: %s\n",CkJsonObject_stringOf(json,"items[i].unit_price.value"));
printf("----\n");
i = i + 1;
}
printf("Success.\n");
CkJsonObject_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbPath);
CkStringBuilder_Dispose(sbJsonRequest);
CkStringBuilder_Dispose(sbJsonResponse);
}