Chilkat Online Tools

Ruby / EPC 2.0 - Partner Sandbox - 19.4 November [External] / [Partner] Send Acknowledgment Response

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "status": "processing",
#   "partnerStatus": "Order Accepted",
#   "referenceNumber": "ORDER_REFERENCE_NUMBER",
#   "respondingParty ": {
#     "name": "COMPANY_NAME",
#     "address": "COMPANY_STREET_ADDRESS",
#     "city": "COMPANY_CITY",
#     "state": "COMPANY_STATE",
#     "postalCode": "COMPANY_ZIP_CODE",
#     "pointOfContact": {
#       "name": "CONTACT_NAME",
#       "role": "CONTACT_ROLE",
#       "phone": "CONTACT_PHONE_NUMBER",
#       "email": "CONTACT_EMAIL"
#     }
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("status","processing")
json.UpdateString("partnerStatus","Order Accepted")
json.UpdateString("referenceNumber","ORDER_REFERENCE_NUMBER")
json.UpdateString("\"respondingParty \".name","COMPANY_NAME")
json.UpdateString("\"respondingParty \".address","COMPANY_STREET_ADDRESS")
json.UpdateString("\"respondingParty \".city","COMPANY_CITY")
json.UpdateString("\"respondingParty \".state","COMPANY_STATE")
json.UpdateString("\"respondingParty \".postalCode","COMPANY_ZIP_CODE")
json.UpdateString("\"respondingParty \".pointOfContact.name","CONTACT_NAME")
json.UpdateString("\"respondingParty \".pointOfContact.role","CONTACT_ROLE")
json.UpdateString("\"respondingParty \".pointOfContact.phone","CONTACT_PHONE_NUMBER")
json.UpdateString("\"respondingParty \".pointOfContact.email","CONTACT_EMAIL")

# Adds the "Authorization: Bearer {{partner_token}}" header.
http.put_AuthToken("{{partner_token}}")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://domain.com/",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PATCH
	-H "Authorization: Bearer {{partner_token}}"
	-H "Content-Type: application/json"
	-d '{
    "status": "processing",
    "partnerStatus": "Order Accepted",
    "referenceNumber": "ORDER_REFERENCE_NUMBER",
    "respondingParty ": {
        "name": "COMPANY_NAME",
        "address": "COMPANY_STREET_ADDRESS",
        "city": "COMPANY_CITY",
        "state": "COMPANY_STATE",
        "postalCode": "COMPANY_ZIP_CODE",
        "pointOfContact": {
            "name": "CONTACT_NAME",
            "role": "CONTACT_ROLE",
            "phone": "CONTACT_PHONE_NUMBER",
            "email": "CONTACT_EMAIL"
        }
    }
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "[Partner] Send Acknowledgment Response",
  "_postman_id": "1165b237-e991-481e-bd7b-f05d17b2de2f",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{partner_token}}",
        "type": "text"
      },
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"status\": \"processing\",\n    \"partnerStatus\": \"Order Accepted\",\n    \"referenceNumber\": \"ORDER_REFERENCE_NUMBER\",\n    \"respondingParty \": {\n        \"name\": \"COMPANY_NAME\",\n        \"address\": \"COMPANY_STREET_ADDRESS\",\n        \"city\": \"COMPANY_CITY\",\n        \"state\": \"COMPANY_STATE\",\n        \"postalCode\": \"COMPANY_ZIP_CODE\",\n        \"pointOfContact\": {\n            \"name\": \"CONTACT_NAME\",\n            \"role\": \"CONTACT_ROLE\",\n            \"phone\": \"CONTACT_PHONE_NUMBER\",\n            \"email\": \"CONTACT_EMAIL\"\n        }\n    }\n}"
    },
    "url": "{{api_host}}/partner/v2/transactions/{{transaction_id}}/response"
  },
  "response": [
  ]
}