Back to Collection Items
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample XML: Generate Code to Create XML
; The following XML is sent in the request body.
; <?xml version="1.0" encoding="UTF-8"?>
; <order-header>
; <type>ExternalOrderHeader</type>
; <po-number>PO-957645-18</po-number>
; <version type="integer">1</version>
; <payment-method>invoice</payment-method>
; <ship-to-address>
; <location-code>DUMMYST</location-code>
; </ship-to-address>
; <ship-to-user>
; <login>CoupaRequester</login>
; </ship-to-user>
; <supplier>
; <name>Adam's Apples</name>
; </supplier>
; <payment-term>
; <code>2/10 Net 30</code>
; </payment-term>
; <currency>
; <code>USD</code>
; </currency>
; <order-lines type="array">
; <order-line>
; <description>Supplies</description>
; <line-num>1</line-num>
; <price type="decimal">40.00</price>
; <quantity type="decimal">1.0</quantity>
; <type>OrderQuantityLine</type>
; <account>
; <code>SF-Marketing-Assets</code>
; <account-type>
; <name>Ace Corporate</name>
; </account-type>
; </account>
; <currency>
; <code>USD</code>
; </currency>
; <uom>
; <code>EA</code>
; </uom>
; </order-line>
; <order-line>
; <description>Testing Kit</description>
; <line-num>2</line-num>
; <price type="decimal">100.00</price>
; <quantity type="decimal">1.0</quantity>
; <type>OrderQuantityLine</type>
; <account-allocations type="array">
; <account-allocation>
; <amount type="decimal">10.00</amount>
; <pct type="decimal">10.0</pct>
; <account>
; <code>SF-IT-Assets</code>
; <account-type>
; <name>Ace Corporate</name>
; </account-type>
; </account>
; </account-allocation>
; <account-allocation>
; <amount type="decimal">90.00</amount>
; <pct type="decimal">90.0</pct>
; <account>
; <code>SF-Sales-Assets</code>
; <account-type>
; <name>Ace Corporate</name>
; </account-type>
; </account>
; </account-allocation>
; </account-allocations>
; <currency>
; <code>USD</code>
; </currency>
; <uom>
; <code>EA</code>
; </uom>
; </order-line>
; </order-lines>
; </order-header>
;
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "order-header")
CkXml::ckUpdateChildContent(xml,"type","ExternalOrderHeader")
CkXml::ckUpdateChildContent(xml,"po-number","PO-957645-18")
CkXml::ckUpdateAttrAt(xml,"version",1,"type","integer")
CkXml::ckUpdateChildContentInt(xml,"version",1)
CkXml::ckUpdateChildContent(xml,"payment-method","invoice")
CkXml::ckUpdateChildContent(xml,"ship-to-address|location-code","DUMMYST")
CkXml::ckUpdateChildContent(xml,"ship-to-user|login","CoupaRequester")
CkXml::ckUpdateChildContent(xml,"supplier|name","Adam's Apples")
CkXml::ckUpdateChildContent(xml,"payment-term|code","2/10 Net 30")
CkXml::ckUpdateChildContent(xml,"currency|code","USD")
CkXml::ckUpdateAttrAt(xml,"order-lines",1,"type","array")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|description","Supplies")
CkXml::ckUpdateChildContentInt(xml,"order-lines|order-line|line-num",1)
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line|price",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|price","40.00")
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line|quantity",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|quantity","1.0")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|type","OrderQuantityLine")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|account|code","SF-Marketing-Assets")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|account|account-type|name","Ace Corporate")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|currency|code","USD")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line|uom|code","EA")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|description","Testing Kit")
CkXml::ckUpdateChildContentInt(xml,"order-lines|order-line[1]|line-num",2)
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line[1]|price",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|price","100.00")
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line[1]|quantity",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|quantity","1.0")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|type","OrderQuantityLine")
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line[1]|account-allocations",1,"type","array")
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line[1]|account-allocations|account-allocation|amount",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation|amount","10.00")
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line[1]|account-allocations|account-allocation|pct",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation|pct","10.0")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation|account|code","SF-IT-Assets")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation|account|account-type|name","Ace Corporate")
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line[1]|account-allocations|account-allocation[1]|amount",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation[1]|amount","90.00")
CkXml::ckUpdateAttrAt(xml,"order-lines|order-line[1]|account-allocations|account-allocation[1]|pct",1,"type","decimal")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation[1]|pct","90.0")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation[1]|account|code","SF-Sales-Assets")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|account-allocations|account-allocation[1]|account|account-type|name","Ace Corporate")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|currency|code","USD")
CkXml::ckUpdateChildContent(xml,"order-lines|order-line[1]|uom|code","EA")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckGetXmlSb(xml,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"POST","https://domain.com/purchase_orders/?fields=[" + Chr(34) + "id" + Chr(34) + "]",sbRequestBody,"utf-8","application/xml",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkXml::ckDispose(xml)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkXml::ckDispose(xml)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
-d '<?xml version="1.0" encoding="UTF-8"?>
<order-header>
<type>ExternalOrderHeader</type>
<po-number>PO-957645-18</po-number>
<version type="integer">1</version>
<payment-method>invoice</payment-method>
<ship-to-address>
<location-code>DUMMYST</location-code>
</ship-to-address>
<ship-to-user>
<login>CoupaRequester</login>
</ship-to-user>
<supplier>
<name>Adam\'s Apples</name>
</supplier>
<payment-term>
<code>2/10 Net 30</code>
</payment-term>
<currency>
<code>USD</code>
</currency>
<order-lines type="array">
<order-line>
<description>Supplies</description>
<line-num>1</line-num>
<price type="decimal">40.00</price>
<quantity type="decimal">1.0</quantity>
<type>OrderQuantityLine</type>
<account>
<code>SF-Marketing-Assets</code>
<account-type>
<name>Ace Corporate</name>
</account-type>
</account>
<currency>
<code>USD</code>
</currency>
<uom>
<code>EA</code>
</uom>
</order-line>
<order-line>
<description>Testing Kit</description>
<line-num>2</line-num>
<price type="decimal">100.00</price>
<quantity type="decimal">1.0</quantity>
<type>OrderQuantityLine</type>
<account-allocations type="array">
<account-allocation>
<amount type="decimal">10.00</amount>
<pct type="decimal">10.0</pct>
<account>
<code>SF-IT-Assets</code>
<account-type>
<name>Ace Corporate</name>
</account-type>
</account>
</account-allocation>
<account-allocation>
<amount type="decimal">90.00</amount>
<pct type="decimal">90.0</pct>
<account>
<code>SF-Sales-Assets</code>
<account-type>
<name>Ace Corporate</name>
</account-type>
</account>
</account-allocation>
</account-allocations>
<currency>
<code>USD</code>
</currency>
<uom>
<code>EA</code>
</uom>
</order-line>
</order-lines>
</order-header>'
https://domain.com/purchase_orders/?fields=["id"]
Postman Collection Item JSON
{
"name": "Create External PO w/ Allocations",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<order-header>\n <type>ExternalOrderHeader</type>\n <po-number>PO-957645-18</po-number>\n <version type=\"integer\">1</version>\n <payment-method>invoice</payment-method>\n <ship-to-address>\n <location-code>DUMMYST</location-code>\n </ship-to-address>\n <ship-to-user>\n <login>CoupaRequester</login>\n </ship-to-user>\n <supplier>\n <name>Adam's Apples</name>\n </supplier>\n <payment-term>\n <code>2/10 Net 30</code>\n </payment-term>\n <currency>\n <code>USD</code>\n </currency>\n <order-lines type=\"array\">\n <order-line>\n <description>Supplies</description>\n <line-num>1</line-num>\n <price type=\"decimal\">40.00</price>\n <quantity type=\"decimal\">1.0</quantity>\n <type>OrderQuantityLine</type>\n <account>\n <code>SF-Marketing-Assets</code>\n <account-type>\n <name>Ace Corporate</name>\n </account-type>\n </account>\n <currency>\n <code>USD</code>\n </currency>\n <uom>\n <code>EA</code>\n </uom>\n </order-line>\n <order-line>\n <description>Testing Kit</description>\n <line-num>2</line-num>\n <price type=\"decimal\">100.00</price>\n <quantity type=\"decimal\">1.0</quantity>\n <type>OrderQuantityLine</type>\n <account-allocations type=\"array\">\n <account-allocation>\n <amount type=\"decimal\">10.00</amount>\n <pct type=\"decimal\">10.0</pct>\n <account>\n <code>SF-IT-Assets</code>\n <account-type>\n <name>Ace Corporate</name>\n </account-type>\n </account>\n </account-allocation>\n <account-allocation>\n <amount type=\"decimal\">90.00</amount>\n <pct type=\"decimal\">90.0</pct>\n <account>\n <code>SF-Sales-Assets</code>\n <account-type>\n <name>Ace Corporate</name>\n </account-type>\n </account>\n </account-allocation>\n </account-allocations>\n <currency>\n <code>USD</code>\n </currency>\n <uom>\n <code>EA</code>\n </uom>\n </order-line>\n </order-lines>\n</order-header>"
},
"url": {
"raw": "{{URL}}/purchase_orders/?fields=[\"id\"]",
"host": [
"{{URL}}"
],
"path": [
"purchase_orders",
""
],
"query": [
{
"key": "fields",
"value": "[\"id\"]"
}
]
}
},
"response": [
]
}
