Changes to API Responses

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

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).

FieldDescription
IdThis is the orderItemId field. Since Standard Digital Commerce doesn't create pseudo-orders, this field is no longer included in the response.
IsActiveYou can only add active products to the basket. Therefore, this field isn't required as it always returns true.
ListPrice 
OrderIdThis is the orderId field. Since Standard Digital Commerce doesn't create pseudo-orders, this field is no longer included in the response.
Pricebook2Id 
SellingPeriod 
hasChildrenBasket responses always return the full hierarchy. Therefore, this boolean field isn't required.
orderActiveThis 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__cThis 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__CatalogItemReferenceDateTime__cThis is a versioning-related field. Since Standard Digital Commerce doesn't support versioning, this field isn't returned.
vlocity_clmperf__CpqMessageData__cValidation 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__CpqPricingMessage__cThis field typically populates errors related to margin pricing. Since Standard Digital Commerce doesn't support margin pricing, the field isn't returned.
vlocity_clmperf__CurrencyPaymentMode__cThis field is useful when you create orders. It isn't returned from basket responses.
vlocity_clmperf__FirstVersionOrderItemId__cThis is an order Item-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field isn't returned.
vlocity_clmperf__FulfilmentStatus__cThis field was populated by ODIN when an order was submitted. It isn't returned from basket responses.
vlocity_clmperf__IsChangesAllowed__cThis field was useful when an order was submitted. It isn't returned from basket responses.
vlocity_clmperf__ItemName__c 
vlocity_clmperf__OneTimeManualDiscount__cSince Standard Digital Commerce doesn't support manual discounts, this field isn't returned.
vlocity_clmperf__OrderGroupId__cThis is an order-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field isn't returned.
vlocity_clmperf__ProductGroupKey__cThis field is now called GlobalGroupKey.
vlocity_clmperf__ProductHierarchyGroupKeyPath__c 
vlocity_clmperf__ProvisioningStatus__cThis field was useful when an order was submitted. It isn't returned from basket responses.
vlocity_clmperf__RecurringDiscountPrice__cSince Standard Digital Commerce doesn't support discounts, this field isn't returned.
vlocity_clmperf__RecurringManualDiscount__cSince Standard Digital Commerce doesn't support manual discounts, this field isn't returned.
vlocity_clmperf__RecurringPrice__c 
vlocity_clmperf__ServiceAccountId__cThis is an account-related field. Since Standard Digital Commerce doesn't create pseudo-accounts, this field isn't returned.
vlocity_clmperf__SubAction__cThis 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__cThis is an order item-related field. Since Standard Digital Commerce doesn't create pseudo-orders, this field isn't returned.
vlocity_clmperf__SupplementalAction__cThis field was useful when an order was submitted and then a supplemental order was created. It isn't returned from basket responses.

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