fulfillment.failed

Last modified October 5, 2018

This article applies to Contextual Commerce. (Looking for Classic Commerce documentation?)

The fulfillment.failed server webhook event is fired if one or more fulfillment actions fail during order fulfillment (e.g. due to insufficient licenses remaining in a pre-generated list). Please see Fulfillments for more information about fulfillment actions.

About Webhook Expansion

fulfillment.failed is not affected by webhook expansion.

Contents of Event Payload

NameTypeDescription
productstringproduct path of the product for which fulfillment failed
fulfillmentstringfulfillment action ID for the action that failed - see the Fulfillments section of the product detail page in Dashboard
typestringtype of the failed fulfillment: license, file
orderstringinternal order ID of the order for which the fulfillment failed
referencestringcustomer-facing order reference of the order for which the fulfillment failed
accountstringFastSpring-generated customer account ID associated with the order for which the fulfillment failed
subscriptionstringsubscription ID associated with the failed fulfillment, if applicable
reasonstringreason for the failed fulfillment

Example

fulfillment.failed webhook example
{ 
   "product":"vision-annual-subscription",
   "fulfillment":"vision-annual-subscription_license_0",
   "type":"License",
   "order":"zyAQWYNITbCjKd6nF5uYmA",
   "reference":"FUR160818-9535-94173",
   "account":"uKj7izONRfanVwBL9eiG_A",
   "subscription":"-0eLPYEWRkGTrtB-tvydaw",
   "reason":"Does not have available licenses: 3, LicenseDispenser[yoiEYeJ3RnSwTghMu_oDDQ,]"
}