Changes to API Responses

After you enable Standard Digital Commerce and send API calls, some fields are added and others removed from the responses.

Removed Fields

This table lists the fields that are removed from API responses after you enable Standard Digital Commerce. These fields were previously included in the node of each record (LineItem).

Field Description
Id This is the orderItemId field. Since Standard Digital Commerce doesn't create pseudo-orders, this field is no longer included in the response.
IsActive You can only add active products to the basket. Therefore, this field isn't required as it always returns true.
ListPrice  -
OrderId This is the orderId field. Since Standard Digital Commerce doesn't create pseudo-orders, this field is no longer included in the response.
Pricebook2Id  -
SellingPeriod  -
hasChildren Basket responses always return the full hierarchy. Therefore, this boolean field isn't required.
orderActive This is an order-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field is no longer included in the response.
vlocity_clmperf__BillingAccountId__c This is an order-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field is no longer included in the response.
vlocity_clmperf__CpqMessageData__c Validation errors are present in the messages node of the item. This is a duplicate field that was present in orderItem. Since Standard Digital Commerce doesn't create pseudo-orders, this field isn't returned.
vlocity_clmperf__CurrencyPaymentMode__c This field is useful when you create orders. It isn't returned from basket responses.
vlocity_clmperf__FirstVersionOrderItemId__c This is an order Item-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field isn't returned.
vlocity_clmperf__FulfilmentStatus__c This field was populated by ODIN when an order was submitted. It isn't returned from basket responses.
vlocity_clmperf__IsChangesAllowed__c This field was useful when an order was submitted. It isn't returned from basket responses.
vlocity_clmperf__ItemName__c   -
vlocity_clmperf__OneTimeManualDiscount__c Since Standard Digital Commerce doesn't support manual discounts, this field isn't returned.
vlocity_clmperf__OrderGroupId__c This is an order-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field isn't returned.
vlocity_clmperf__ProductGroupKey__c This field is now called GlobalGroupKey.
vlocity_clmperf__ProductHierarchyGroupKeyPath__c   -
vlocity_clmperf__ProvisioningStatus__c This field was useful when an order was submitted. It isn't returned from basket responses.
vlocity_clmperf__RecurringDiscountPrice__c Since Standard Digital Commerce doesn't support discounts, this field isn't returned.
vlocity_clmperf__RecurringManualDiscount__c Since Standard Digital Commerce doesn't support manual discounts, this field isn't returned.
vlocity_clmperf__RecurringPrice__c   -
vlocity_clmperf__ServiceAccountId__c This is an account-related field. Since Standard Digital Commerce doesn't create pseudo-accounts, this field isn't returned.
vlocity_clmperf__SubAction__c This field was useful when an order was submitted and then a supplemental order was created. It isn't returned from basket responses.
vlocity_clmperf__SupersededOrderItemId__c This is an order item-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field isn't returned.
vlocity_clmperf__SupplementalAction__c This field was useful when an order was submitted and then a supplemental order was created. It isn't returned from basket responses.

Added Fields

These fields are added to API responses after you enable Standard Digital Commerce:

  • vlocity_clmperf__EffectiveQuantity__c

  • vlocity_clmperf__GlobalGroupKey__c = vlocity_clmperf__ProductGroupKey__c

  • vlocity_clmperf__SequenceNumber__c