Chilkat Online Tools

Ruby / Salesforce Platform APIs / Create Order With Bundle

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.

# {
#   "allOrNone": true,
#   "compositeRequest": [
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/Order",
#       "referenceId": "refOrder",
#       "body": {
#         "AccountId": "{{defaultAccount}}",
#         "EffectiveDate": "2023-01-01",
#         "Pricebook2Id": "{{standardPricebook}}",
#         "BillToContactId": "{{defaultBillToContact}}",
#         "Status": "Draft"
#       }
#     },
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/AppUsageAssignment",
#       "referenceId": "refAppTag",
#       "body": {
#         "AppUsageType": "SubscriptionManagement",
#         "RecordId": "@{refOrder.id}"
#       }
#     },
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/OrderAction",
#       "referenceId": "refOrderAction",
#       "body": {
#         "OrderId": "@{refOrder.id}",
#         "Type": "New Sale"
#       }
#     },
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/OrderItem",
#       "referenceId": "refWorkAnywhereBundle",
#       "body": {
#         "OrderId": "@{refOrder.id}",
#         "OrderActionId": "@{refOrderAction.id}",
#         "PricebookEntryId": "{{WorkAnywhereBundlePBE}}",
#         "ServiceDate": "2023-01-01",
#         "Quantity": 1,
#         "UnitPrice": 10000,
#         "NetUnitPrice": 10000,
#         "TotalLineAmount": 10000,
#         "PeriodBoundary": "AlignToCalendar",
#         "BillingFrequency2": "Monthly"
#       }
#     },
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/OrderItem",
#       "referenceId": "refVirtualRouter",
#       "body": {
#         "OrderId": "@{refOrder.id}",
#         "OrderActionId": "@{refOrderAction.id}",
#         "PricebookEntryId": "{{VirtualRouterEvergrnPBE}}",
#         "ServiceDate": "2023-01-01",
#         "Quantity": 100,
#         "UnitPrice": 0,
#         "NetUnitPrice": 0,
#         "TotalLineAmount": 0,
#         "PeriodBoundary": "AlignToCalendar",
#         "BillingFrequency2": "Monthly"
#       }
#     },
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/OrderItem",
#       "referenceId": "refBronzeSLA",
#       "body": {
#         "OrderId": "@{refOrder.id}",
#         "OrderActionId": "@{refOrderAction.id}",
#         "PricebookEntryId": "{{SLABronzeEvergrnMonthPBE}}",
#         "ServiceDate": "2023-01-01",
#         "Quantity": 3,
#         "UnitPrice": 0,
#         "NetUnitPrice": 0,
#         "TotalLineAmount": 0,
#         "PeriodBoundary": "AlignToCalendar",
#         "BillingFrequency2": "Monthly"
#       }
#     },
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/OrderItemRelationship",
#       "referenceId": "refOrderItemRelationship1",
#       "body": {
#         "ProductRelationshipTypeId": "{{BundleProductRelationshipType}}",
#         "MainOrderItemId": "@{refWorkAnywhereBundle.id}",
#         "AssociatedOrderItemId": "@{refVirtualRouter.id}",
#         "AssociatedOrderItemPricing": "IncludedInBundlePrice",
#         "AssociatedQuantScaleMethod": "Proportional"
#       }
#     },
#     {
#       "method": "POST",
#       "url": "/services/data/v57.0/sobjects/OrderItemRelationship",
#       "referenceId": "refOrderItemRelationship2",
#       "body": {
#         "ProductRelationshipTypeId": "{{BundleProductRelationshipType}}",
#         "MainOrderItemId": "@{refWorkAnywhereBundle.id}",
#         "AssociatedOrderItemId": "@{refBronzeSLA.id}",
#         "AssociatedOrderItemPricing": "IncludedInBundlePrice",
#         "AssociatedQuantScaleMethod": "Constant"
#       }
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateBool("allOrNone",true)
json.UpdateString("compositeRequest[0].method","POST")
json.UpdateString("compositeRequest[0].url","/services/data/v57.0/sobjects/Order")
json.UpdateString("compositeRequest[0].referenceId","refOrder")
json.UpdateString("compositeRequest[0].body.AccountId","{{defaultAccount}}")
json.UpdateString("compositeRequest[0].body.EffectiveDate","2023-01-01")
json.UpdateString("compositeRequest[0].body.Pricebook2Id","{{standardPricebook}}")
json.UpdateString("compositeRequest[0].body.BillToContactId","{{defaultBillToContact}}")
json.UpdateString("compositeRequest[0].body.Status","Draft")
json.UpdateString("compositeRequest[1].method","POST")
json.UpdateString("compositeRequest[1].url","/services/data/v57.0/sobjects/AppUsageAssignment")
json.UpdateString("compositeRequest[1].referenceId","refAppTag")
json.UpdateString("compositeRequest[1].body.AppUsageType","SubscriptionManagement")
json.UpdateString("compositeRequest[1].body.RecordId","@{refOrder.id}")
json.UpdateString("compositeRequest[2].method","POST")
json.UpdateString("compositeRequest[2].url","/services/data/v57.0/sobjects/OrderAction")
json.UpdateString("compositeRequest[2].referenceId","refOrderAction")
json.UpdateString("compositeRequest[2].body.OrderId","@{refOrder.id}")
json.UpdateString("compositeRequest[2].body.Type","New Sale")
json.UpdateString("compositeRequest[3].method","POST")
json.UpdateString("compositeRequest[3].url","/services/data/v57.0/sobjects/OrderItem")
json.UpdateString("compositeRequest[3].referenceId","refWorkAnywhereBundle")
json.UpdateString("compositeRequest[3].body.OrderId","@{refOrder.id}")
json.UpdateString("compositeRequest[3].body.OrderActionId","@{refOrderAction.id}")
json.UpdateString("compositeRequest[3].body.PricebookEntryId","{{WorkAnywhereBundlePBE}}")
json.UpdateString("compositeRequest[3].body.ServiceDate","2023-01-01")
json.UpdateInt("compositeRequest[3].body.Quantity",1)
json.UpdateInt("compositeRequest[3].body.UnitPrice",10000)
json.UpdateInt("compositeRequest[3].body.NetUnitPrice",10000)
json.UpdateInt("compositeRequest[3].body.TotalLineAmount",10000)
json.UpdateString("compositeRequest[3].body.PeriodBoundary","AlignToCalendar")
json.UpdateString("compositeRequest[3].body.BillingFrequency2","Monthly")
json.UpdateString("compositeRequest[4].method","POST")
json.UpdateString("compositeRequest[4].url","/services/data/v57.0/sobjects/OrderItem")
json.UpdateString("compositeRequest[4].referenceId","refVirtualRouter")
json.UpdateString("compositeRequest[4].body.OrderId","@{refOrder.id}")
json.UpdateString("compositeRequest[4].body.OrderActionId","@{refOrderAction.id}")
json.UpdateString("compositeRequest[4].body.PricebookEntryId","{{VirtualRouterEvergrnPBE}}")
json.UpdateString("compositeRequest[4].body.ServiceDate","2023-01-01")
json.UpdateInt("compositeRequest[4].body.Quantity",100)
json.UpdateInt("compositeRequest[4].body.UnitPrice",0)
json.UpdateInt("compositeRequest[4].body.NetUnitPrice",0)
json.UpdateInt("compositeRequest[4].body.TotalLineAmount",0)
json.UpdateString("compositeRequest[4].body.PeriodBoundary","AlignToCalendar")
json.UpdateString("compositeRequest[4].body.BillingFrequency2","Monthly")
json.UpdateString("compositeRequest[5].method","POST")
json.UpdateString("compositeRequest[5].url","/services/data/v57.0/sobjects/OrderItem")
json.UpdateString("compositeRequest[5].referenceId","refBronzeSLA")
json.UpdateString("compositeRequest[5].body.OrderId","@{refOrder.id}")
json.UpdateString("compositeRequest[5].body.OrderActionId","@{refOrderAction.id}")
json.UpdateString("compositeRequest[5].body.PricebookEntryId","{{SLABronzeEvergrnMonthPBE}}")
json.UpdateString("compositeRequest[5].body.ServiceDate","2023-01-01")
json.UpdateInt("compositeRequest[5].body.Quantity",3)
json.UpdateInt("compositeRequest[5].body.UnitPrice",0)
json.UpdateInt("compositeRequest[5].body.NetUnitPrice",0)
json.UpdateInt("compositeRequest[5].body.TotalLineAmount",0)
json.UpdateString("compositeRequest[5].body.PeriodBoundary","AlignToCalendar")
json.UpdateString("compositeRequest[5].body.BillingFrequency2","Monthly")
json.UpdateString("compositeRequest[6].method","POST")
json.UpdateString("compositeRequest[6].url","/services/data/v57.0/sobjects/OrderItemRelationship")
json.UpdateString("compositeRequest[6].referenceId","refOrderItemRelationship1")
json.UpdateString("compositeRequest[6].body.ProductRelationshipTypeId","{{BundleProductRelationshipType}}")
json.UpdateString("compositeRequest[6].body.MainOrderItemId","@{refWorkAnywhereBundle.id}")
json.UpdateString("compositeRequest[6].body.AssociatedOrderItemId","@{refVirtualRouter.id}")
json.UpdateString("compositeRequest[6].body.AssociatedOrderItemPricing","IncludedInBundlePrice")
json.UpdateString("compositeRequest[6].body.AssociatedQuantScaleMethod","Proportional")
json.UpdateString("compositeRequest[7].method","POST")
json.UpdateString("compositeRequest[7].url","/services/data/v57.0/sobjects/OrderItemRelationship")
json.UpdateString("compositeRequest[7].referenceId","refOrderItemRelationship2")
json.UpdateString("compositeRequest[7].body.ProductRelationshipTypeId","{{BundleProductRelationshipType}}")
json.UpdateString("compositeRequest[7].body.MainOrderItemId","@{refWorkAnywhereBundle.id}")
json.UpdateString("compositeRequest[7].body.AssociatedOrderItemId","@{refBronzeSLA.id}")
json.UpdateString("compositeRequest[7].body.AssociatedOrderItemPricing","IncludedInBundlePrice")
json.UpdateString("compositeRequest[7].body.AssociatedQuantScaleMethod","Constant")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/composite","application/json",json)
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 POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "allOrNone": true,
    "compositeRequest": [
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/Order",
            "referenceId": "refOrder",
            "body": {
                "AccountId": "{{defaultAccount}}",
                "EffectiveDate": "2023-01-01",
                "Pricebook2Id": "{{standardPricebook}}",
                "BillToContactId": "{{defaultBillToContact}}",
                "Status": "Draft"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/AppUsageAssignment",
            "referenceId": "refAppTag",
            "body": {
                "AppUsageType": "SubscriptionManagement",
                "RecordId": "@{refOrder.id}"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/OrderAction",
            "referenceId": "refOrderAction",
            "body": {
                "OrderId": "@{refOrder.id}",
                "Type": "New Sale"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/OrderItem",
            "referenceId": "refWorkAnywhereBundle",
            "body": {
                "OrderId": "@{refOrder.id}",
                "OrderActionId": "@{refOrderAction.id}",
                "PricebookEntryId": "{{WorkAnywhereBundlePBE}}",
                "ServiceDate": "2023-01-01",
                "Quantity": 1,
                "UnitPrice": 10000,
                "NetUnitPrice": 10000,
                "TotalLineAmount": 10000,
                "PeriodBoundary": "AlignToCalendar",
                "BillingFrequency2": "Monthly"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/OrderItem",
            "referenceId": "refVirtualRouter",
            "body": {
                "OrderId": "@{refOrder.id}",
                "OrderActionId": "@{refOrderAction.id}",
                "PricebookEntryId": "{{VirtualRouterEvergrnPBE}}",
                "ServiceDate": "2023-01-01",
                "Quantity": 100,
                "UnitPrice": 0,
                "NetUnitPrice": 0,
                "TotalLineAmount": 0,
                "PeriodBoundary": "AlignToCalendar",
                "BillingFrequency2": "Monthly"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/OrderItem",
            "referenceId": "refBronzeSLA",
            "body": {
                "OrderId": "@{refOrder.id}",
                "OrderActionId": "@{refOrderAction.id}",
                "PricebookEntryId": "{{SLABronzeEvergrnMonthPBE}}",
                "ServiceDate": "2023-01-01",
                "Quantity": 3,
                "UnitPrice": 0,
                "NetUnitPrice": 0,
                "TotalLineAmount": 0,
                "PeriodBoundary": "AlignToCalendar",
                "BillingFrequency2": "Monthly"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/OrderItemRelationship",
            "referenceId": "refOrderItemRelationship1",
            "body": {
                "ProductRelationshipTypeId": "{{BundleProductRelationshipType}}",
                "MainOrderItemId": "@{refWorkAnywhereBundle.id}",
                "AssociatedOrderItemId": "@{refVirtualRouter.id}",
                "AssociatedOrderItemPricing": "IncludedInBundlePrice",
                "AssociatedQuantScaleMethod": "Proportional"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v57.0/sobjects/OrderItemRelationship",
            "referenceId": "refOrderItemRelationship2",
            "body": {
                "ProductRelationshipTypeId": "{{BundleProductRelationshipType}}",
                "MainOrderItemId": "@{refWorkAnywhereBundle.id}",
                "AssociatedOrderItemId": "@{refBronzeSLA.id}",
                "AssociatedOrderItemPricing": "IncludedInBundlePrice",
                "AssociatedQuantScaleMethod": "Constant"
            }
        }
    ]
}'
https://domain.com/services/data/v{{version}}/composite

Postman Collection Item JSON

{
  "name": "Create Order With Bundle",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"allOrNone\": true,\n    \"compositeRequest\": [\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/Order\",\n            \"referenceId\": \"refOrder\",\n            \"body\": {\n                \"AccountId\": \"{{defaultAccount}}\",\n                \"EffectiveDate\": \"2023-01-01\",\n                \"Pricebook2Id\": \"{{standardPricebook}}\",\n                \"BillToContactId\": \"{{defaultBillToContact}}\",\n                \"Status\": \"Draft\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/AppUsageAssignment\",\n            \"referenceId\": \"refAppTag\",\n            \"body\": {\n                \"AppUsageType\": \"SubscriptionManagement\",\n                \"RecordId\": \"@{refOrder.id}\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/OrderAction\",\n            \"referenceId\": \"refOrderAction\",\n            \"body\": {\n                \"OrderId\": \"@{refOrder.id}\",\n                \"Type\": \"New Sale\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/OrderItem\",\n            \"referenceId\": \"refWorkAnywhereBundle\",\n            \"body\": {\n                \"OrderId\": \"@{refOrder.id}\",\n                \"OrderActionId\": \"@{refOrderAction.id}\",\n                \"PricebookEntryId\": \"{{WorkAnywhereBundlePBE}}\",\n                \"ServiceDate\": \"2023-01-01\",\n                \"Quantity\": 1,\n                \"UnitPrice\": 10000,\n                \"NetUnitPrice\": 10000,\n                \"TotalLineAmount\": 10000,\n                \"PeriodBoundary\": \"AlignToCalendar\",\n                \"BillingFrequency2\": \"Monthly\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/OrderItem\",\n            \"referenceId\": \"refVirtualRouter\",\n            \"body\": {\n                \"OrderId\": \"@{refOrder.id}\",\n                \"OrderActionId\": \"@{refOrderAction.id}\",\n                \"PricebookEntryId\": \"{{VirtualRouterEvergrnPBE}}\",\n                \"ServiceDate\": \"2023-01-01\",\n                \"Quantity\": 100,\n                \"UnitPrice\": 0,\n                \"NetUnitPrice\": 0,\n                \"TotalLineAmount\": 0,\n                \"PeriodBoundary\": \"AlignToCalendar\",\n                \"BillingFrequency2\": \"Monthly\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/OrderItem\",\n            \"referenceId\": \"refBronzeSLA\",\n            \"body\": {\n                \"OrderId\": \"@{refOrder.id}\",\n                \"OrderActionId\": \"@{refOrderAction.id}\",\n                \"PricebookEntryId\": \"{{SLABronzeEvergrnMonthPBE}}\",\n                \"ServiceDate\": \"2023-01-01\",\n                \"Quantity\": 3,\n                \"UnitPrice\": 0,\n                \"NetUnitPrice\": 0,\n                \"TotalLineAmount\": 0,\n                \"PeriodBoundary\": \"AlignToCalendar\",\n                \"BillingFrequency2\": \"Monthly\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/OrderItemRelationship\",\n            \"referenceId\": \"refOrderItemRelationship1\",\n            \"body\": {\n                \"ProductRelationshipTypeId\": \"{{BundleProductRelationshipType}}\",\n                \"MainOrderItemId\": \"@{refWorkAnywhereBundle.id}\",\n                \"AssociatedOrderItemId\": \"@{refVirtualRouter.id}\",\n                \"AssociatedOrderItemPricing\": \"IncludedInBundlePrice\",\n                \"AssociatedQuantScaleMethod\": \"Proportional\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v57.0/sobjects/OrderItemRelationship\",\n            \"referenceId\": \"refOrderItemRelationship2\",\n            \"body\": {\n                \"ProductRelationshipTypeId\": \"{{BundleProductRelationshipType}}\",\n                \"MainOrderItemId\": \"@{refWorkAnywhereBundle.id}\",\n                \"AssociatedOrderItemId\": \"@{refBronzeSLA.id}\",\n                \"AssociatedOrderItemPricing\": \"IncludedInBundlePrice\",\n                \"AssociatedQuantScaleMethod\": \"Constant\"\n            }\n        }\n    ]\n}\n",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/composite",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "composite"
      ]
    },
    "description": "Creates a Subscription Management order for a product bundle."
  },
  "response": [
  ]
}