Unicode C
Unicode 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 Unicode C Downloads
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkRestW.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObjectW jsonToken;
HCkStringBuilderW sbAuth;
HCkRestW rest;
BOOL bAutoReconnect;
HCkJsonObjectW json;
const wchar_t *invoiceId;
HCkStringBuilderW sbPath;
HCkStringBuilderW sbJsonRequest;
HCkStringBuilderW 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 = CkJsonObjectW_Create();
CkJsonObjectW_LoadFile(jsonToken,L"qa_data/tokens/paypal.json");
// Build the Authorization request header field value.
sbAuth = CkStringBuilderW_Create();
// token_type should be "Bearer"
CkStringBuilderW_Append(sbAuth,CkJsonObjectW_stringOf(jsonToken,L"token_type"));
CkStringBuilderW_Append(sbAuth,L" ");
CkStringBuilderW_Append(sbAuth,CkJsonObjectW_stringOf(jsonToken,L"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 = CkRestW_Create();
bAutoReconnect = TRUE;
success = CkRestW_Connect(rest,L"api.sandbox.paypal.com",443,TRUE,bAutoReconnect);
if (success != TRUE) {
wprintf(L"%s\n",CkRestW_lastErrorText(rest));
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_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 = CkJsonObjectW_Create();
CkJsonObjectW_putEmitCompact(json,FALSE);
CkJsonObjectW_UpdateString(json,L"merchant_info.email",L"smith-facilitator@chilkatsoft.com");
CkJsonObjectW_UpdateString(json,L"merchant_info.first_name",L"Joe");
CkJsonObjectW_UpdateString(json,L"merchant_info.last_name",L"Facilitator");
CkJsonObjectW_UpdateString(json,L"merchant_info.business_name",L"Medical Professionals, LLC");
CkJsonObjectW_UpdateString(json,L"merchant_info.phone.country_code",L"001");
CkJsonObjectW_UpdateString(json,L"merchant_info.phone.national_number",L"5032141716");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.line1",L"1234 Main St.");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.city",L"Portland");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.state",L"OR");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.postal_code",L"97217");
CkJsonObjectW_UpdateString(json,L"merchant_info.address.country_code",L"US");
CkJsonObjectW_UpdateString(json,L"billing_info[0].email",L"smith-buyer@chilkatsoft.com");
CkJsonObjectW_UpdateString(json,L"shipping_info.first_name",L"Sally");
CkJsonObjectW_UpdateString(json,L"shipping_info.last_name",L"Patient");
CkJsonObjectW_UpdateString(json,L"shipping_info.business_name",L"Not applicable");
CkJsonObjectW_UpdateString(json,L"shipping_info.phone.country_code",L"001");
CkJsonObjectW_UpdateString(json,L"shipping_info.phone.national_number",L"5039871234");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.line1",L"1234 Broad St.");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.city",L"Portland");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.state",L"OR");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.postal_code",L"97216");
CkJsonObjectW_UpdateString(json,L"shipping_info.address.country_code",L"US");
CkJsonObjectW_UpdateString(json,L"items[0].name",L"Sutures");
// We are updating the quantity from 100.0 to 200.0
// Note: The UpdateNumber method is added in v9.5.0.65
CkJsonObjectW_UpdateNumber(json,L"items[0].quantity",L"200.0");
CkJsonObjectW_UpdateString(json,L"items[0].unit_price.currency",L"USD");
CkJsonObjectW_UpdateString(json,L"items[0].unit_price.value",L"5.00");
CkJsonObjectW_UpdateString(json,L"payment_term.term_type",L"NET_45");
CkJsonObjectW_UpdateString(json,L"payment_term.due_date",L"2016-12-30 PST");
CkJsonObjectW_UpdateString(json,L"note",L"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"
// }
CkRestW_AddHeader(rest,L"Authorization",CkStringBuilderW_getAsString(sbAuth));
CkRestW_AddHeader(rest,L"Content-Type",L"application/json");
invoiceId = L"INV2-XV4B-736P-PLVN-SZCE";
sbPath = CkStringBuilderW_Create();
CkStringBuilderW_Append(sbPath,L"/v1/invoicing/invoices/");
CkStringBuilderW_Append(sbPath,invoiceId);
// Send the PUT request containign the JSON in the request body, and get the JSON response.
sbJsonRequest = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbJsonRequest);
sbJsonResponse = CkStringBuilderW_Create();
success = CkRestW_FullRequestSb(rest,L"PUT",CkStringBuilderW_getAsString(sbPath),sbJsonRequest,sbJsonResponse);
if (success != TRUE) {
wprintf(L"%s\n",CkRestW_lastErrorText(rest));
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
return;
}
CkJsonObjectW_LoadSb(json,sbJsonResponse);
wprintf(L"Response Status Code = %d\n",CkRestW_getResponseStatusCode(rest));
// Did we get a 200 success response?
if (CkRestW_getResponseStatusCode(rest) != 200) {
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"Failed.\n");
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
return;
}
// Sample response JSON is shown below.
// Get some information..
wprintf(L"email: %s\n",CkJsonObjectW_stringOf(json,L"merchant_info.email"));
wprintf(L"business_name: %s\n",CkJsonObjectW_stringOf(json,L"merchant_info.business_name"));
numItems = CkJsonObjectW_SizeOfArray(json,L"items");
i = 0;
while (i < numItems) {
CkJsonObjectW_putI(json,i);
wprintf(L"item name: %s\n",CkJsonObjectW_stringOf(json,L"items[i].name"));
wprintf(L"item quantity: %s\n",CkJsonObjectW_stringOf(json,L"items[i].quantity"));
wprintf(L"item currency: %s\n",CkJsonObjectW_stringOf(json,L"items[i].unit_price.currency"));
wprintf(L"item value: %s\n",CkJsonObjectW_stringOf(json,L"items[i].unit_price.value"));
wprintf(L"----\n");
i = i + 1;
}
wprintf(L"Success.\n");
CkJsonObjectW_Dispose(jsonToken);
CkStringBuilderW_Dispose(sbAuth);
CkRestW_Dispose(rest);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkStringBuilderW_Dispose(sbJsonRequest);
CkStringBuilderW_Dispose(sbJsonResponse);
}