FastSpring sends the order.approval.pending webhook after a customer completes a purchase order (PO) which requires your approval. This applies when you enable FastSpring's Invoicing Service and require approval for POs.

When Webhook Expansion is enabled, order.approval.pending includes the full customer account object. If it is not enabled, the webhook only returns the account ID.

Contents of Event Payload

Name	Type	Description
order	string	Internal order ID.
id	string	Internal order ID.
reference	string	Customer-facing order reference.
buyerReference	string	Purchase order number.
ipAddress	number	IP address of the customer.
completed	boolean	False for order.approval.pending.
changed	integer	Date in which the order instance was updated, in milliseconds.
changedValue	integer	Date in which the order instance was updated, in milliseconds.(backward compatibility)
changedInSeconds	integer	Date in which the order instance was updated, in seconds.
changedDisplay	string	Date of the most recent update to the order. This is formatted for display based on the language in which the order was processed.
language	string	2 character ISO code of the order language.
live	boolean	True indicates a live order. False indicates a test order.
currency	string	3 character ISO code of the order currency.
payoutCurrency	string	3 character ISO code for the currency in which your disbursement will be made.
invoiceUrl	string	URL of the associated invoice.
account	string object	FastSpring-generated customer account ID (expansion disabled) If you have enabled webhook expansion, see Account for expanded contents.
total	number	Order total in the transaction's currency.
totalDisplay	string	Order total, formatted for display in the transaction's currency.
totalInPayoutCurrency	number	Order total in your disbursement currency.
totalInPayoutCurrencyDisplay	string	Order total, formatted for display in your disbursement currency.
tax	number	Tax amount
taxDisplay	string	Tax amount, formatted for display in the transaction's currency.
taxInPayoutCurrency	number	Tax amount in the currency of your FastSpring disbursements.
taxInPayoutCurrencyDisplay	string	Tax amount, formatted for display in your disbursement currency.
subtotal	number	Order subtotal in the transaction's currency.
subtotalDisplay	string	Order subtotal, formatted for display in the transaction's currency.
subtotalInPayoutCurrency	number	Order subtotal in your disbursement currency.
subtotalInPayoutCurrencyDisplay	string	Order subtotal, formatted for display in your disbursement currency.
discount	number	Total discount applied to the order in the transaction's currency.
discountDisplay	string	Total discount applied to the order. This is formatted to display in the transaction's currency
discountInPayoutCurrency	number	Total discount applied to the order in your disbursement currency.
discountInPayoutCurrencyDisplay	string	Total discount applied to the order, formatted for display in your disbursement currency.
discountWithTax	number	Discount amount including tax.
discountWithTaxDisplay	string	Discount amount including tax. This is formatted for display in the transaction's currency
discountWithTaxInPayoutCurrency	number	Discount amount including tax in the your disbursement currency.
discountWithTaxInPayoutCurrencyDisplay	string	Discount amount including tax, formatted for display in the your disbursement currency.
billDescriptor	string	Not applicable for this webhook.
payment	object	Not applicable for this webook.
reason	string	Reason approval is required for the order.
customer	object	Customer information.
first	string	Customer's first name.
last	string	Customer's last name.
email	string	Customer's email address.
company	string	Customer's company name
phone	string	Customer's telephone number
address	object	Address information associated with the order.
city	string	City.
regionCode	string	First line of the address. This is applicable when you enable Force physical address collection for all orders on your storefront.
regionDisplay	string	Second line of the address. This is applicable when you enable Force physical address collection for all orders on your storefront.
region	string	State or region.(backward compatibility)
postalCode	string	Postal code.
country	string	Country.
display	string	String of address information formatted for display.
recipients	array	Customer and gift recipient information. This differs from customer and address information on gift purchases.
recipient	object	Recipient information.
first	string	Recipient's first name.
last	string	Recipient's last name.
email	string	Recipient's email address.
company	string	Recipient's associated company.
phone	string	Recipient's phone number.
account	string object	Recipient's FastSpring-generated account ID (expansion disabled) If you have enabled webhook expansion, see Account for expanded contents.
notes	array	Internal order notes. You can enter these from the app.
items	array	One object per product included in the order. For the full array, see Items Contents.
coupons	array	Coupon ID applied to the order.
quote	string	Internal ID of the associated quote.

Examples

Webhook Expansion Disabled

{  
   "order":"8FqrTAgJRSKSQI3djH90eQ",
   "id":"8FqrTAgJRSKSQI3djH90eQ",
   "reference":"YES200316-7019-29124",
   "buyerReference":null,
   "ipAddress": "000.000.00.000",
   "completed":false,
   "changed":1548093006664,
   "changedValue":1548093006664,
   "changedInSeconds":1548093006,
   "changedDisplay":"1/21/19",
   "language":"en",
   "live":false,
   "currency":"USD",
   "payoutCurrency":"USD",
   "quote":"QUOT2J52LKCFCHPOYSW6UTRMNZJA"
"invoiceUrl":"https://yourexamplestore.onfastspring.com/account/order/YES200316-7019-29124/invoice",
   "account":"N8FjcSWcQNeYCc-suM1O8g",
   "total":59.99,
   "totalDisplay":"$59.99",
   "totalInPayoutCurrency":59.99,
   "totalInPayoutCurrencyDisplay":"$59.99",
   "tax":0.0,
   "taxDisplay":"$0.00",
   "taxInPayoutCurrency":0.0,
   "taxInPayoutCurrencyDisplay":"$0.00",
   "subtotal":59.99,
   "subtotalDisplay":"$59.99",
   "subtotalInPayoutCurrency":59.99,
   "subtotalInPayoutCurrencyDisplay":"$59.99",
   "discount":0.0,
   "discountDisplay":"$0.00",
   "discountInPayoutCurrency":0.0,
   "discountInPayoutCurrencyDisplay":"$0.00",
   "discountWithTax":0.0,
   "discountWithTaxDisplay":"$0.00",
   "discountWithTaxInPayoutCurrency":0.0,
   "discountWithTaxInPayoutCurrencyDisplay":"$0.00",
   "billDescriptor":"N/A",
   "payment":{  

   },
   "reason":"purchaseOrder",
   "customer":{  
      "first":"Lieutenant",
      "last":"Wharf",
      "email":"[email protected]",
      "company":"United Federation of Places",
      "phone":"8054099008"
   },
   "address":{  
      "addressLine1":"801 Garden Street",
      "city":"Santa Barbara",
      "regionCode":"CA",
      "regionDisplay":"California",
      "region":"California",
      "postalCode":"93101",
      "country":"US",
      "display":"801 Garden Street, Santa Barbara, California, 93101, US"
   },
   "recipients":[  
      {  
         "recipient":{  
            "first":"Lieutenant",
            "last":"Wharf",
            "email":"[email protected]",
            "company":"United Federation of Places",
            "phone":"8054099008",
            "account":"N8FjcSWcQNeYCc-suM1O8g",
            "address":{  
               "addressLine1":"801 Garden Street",
               "city":"Santa Barbara",
               "regionCode":"CA",
               "regionDisplay":"California",
               "region":"California",
               "postalCode":"93101",
               "country":"US",
               "display":"801 Garden Street, Santa Barbara, California, 93101, US"
            }
         }
      }
   ],
   "notes":[  

   ],
   "items":[  
      {  
         "product":"example-product-1",
         "quantity":1,
         "display":"Example Product 1",
         "sku":"skuex1",
         "subtotal":59.99,
         "subtotalDisplay":"$59.99",
         "subtotalInPayoutCurrency":59.99,
         "subtotalInPayoutCurrencyDisplay":"$59.99",
         "attributes":{  
            "season":"of the forge"
         },
         "discount":0.0,
         "discountDisplay":"$0.00",
         "discountInPayoutCurrency":0.0,
         "discountInPayoutCurrencyDisplay":"$0.00",
         "fulfillments":{  
            "instructions":"Thank you for purchasing Example Product 1. To register, please launch the trial version and select Help | Register Example Product 1. Then, copy and paste the license key above into the License Key field and click Submit."
         }
      }
   ]
}

Webhook Expansion Enabled

{
  "order":"-wgJI5wrQVq2a8V2Z8vpyA",
  "id":"-wgJI5wrQVq2a8V2Z8vpyA",
  "reference":null,
  "buyerReference":null,
  "ipAddress": "000.000.00.000",
  "completed":false,
  "changed":1584726571703,
  "changedValue":1584726571703,
  "changedInSeconds":1584726571,
  "changedDisplay":"3/20/20",
  "language":"en",
  "live":true,
  "currency":"USD",
  "payoutCurrency":"USD",
  "quote":"QUOT2J52LKCFCHPOYSW6UTRMNZJA
"invoiceUrl":"https://yourexamplestore.onfastspring.com/account/order/null/invoice",
  "account":{
    "id":"gB_slATyQBqSpAxA7-1YAg",
    "account":"gB_slATyQBqSpAxA7-1YAg",
    "contact":{
      "first":"Leeroy",
      "last":"Jenkins",
      "email":"[email protected]",
      "company":"Chicken Danger, Inc.",
      "phone":"8054099008"
    },
    "language":"en",
    "country":"US",
    "lookup":{
      "global":"VKMqlZ--TIuD44BvXdNkbg"
    },
    "url":"https://yourexamplestore.onfastspring.com/account"
  },
  "total":10.72,
  "totalDisplay":"$10.72",
  "totalInPayoutCurrency":10.72,
  "totalInPayoutCurrencyDisplay":"$10.72",
  "tax":0.72,
  "taxDisplay":"$0.72",
  "taxInPayoutCurrency":0.72,
  "taxInPayoutCurrencyDisplay":"$0.72",
  "subtotal":10.0,
  "subtotalDisplay":"$10.00",
  "subtotalInPayoutCurrency":10.0,
  "subtotalInPayoutCurrencyDisplay":"$10.00",
  "discount":0.0,
  "discountDisplay":"$0.00",
  "discountInPayoutCurrency":0.0,
  "discountInPayoutCurrencyDisplay":"$0.00",
  "discountWithTax":0.0,
  "discountWithTaxDisplay":"$0.00",
  "discountWithTaxInPayoutCurrency":0.0,
  "discountWithTaxInPayoutCurrencyDisplay":"$0.00",
  "billDescriptor":"N/A",
  "payment":{

  },
  "reason":"PAYMENT",
  "customer":{
    "first":"Leeroy",
    "last":"Jenkins",
    "email":"[email protected]",
    "company":null,
    "phone":null
  },
  "address":{
    "city":"Lincoln",
    "regionCode":"NE",
    "regionDisplay":"Nebraska",
    "region":"Nebraska",
    "postalCode":"68512",
    "country":"US",
    "display":"Lincoln, Nebraska, 68512, US"
  },
  "recipients":[
    {
      "recipient":{
        "first":"Leeroy",
        "last":"Jenkins",
        "email":"[email protected]",
        "company":null,
        "phone":null,
        "account":{
          "id":"gB_slATyQBqSpAxA7-1YAg",
          "account":"gB_slATyQBqSpAxA7-1YAg",
          "contact":{
            "first":"Leeroy",
            "last":"Jenkins",
            "email":"[email protected]",
            "company":"Chicken Danger, Inc.",
            "phone":"8054099008"
          },
          "language":"en",
          "country":"US",
          "lookup":{
            "global":"VKMqlZ--TIuD44BvXdNkbg"
          },
          "url":"https://yourexamplestore.onfastspring.com/account"
        },
        "address":{
          "city":"Lincoln",
          "regionCode":"NE",
          "regionDisplay":"Nebraska",
          "region":"Nebraska",
          "postalCode":"68512",
          "country":"US",
          "display":"Lincoln, Nebraska, 68512, US"
        }
      }
    }
  ],
  "notes":[

  ],
  "items":[
    {
      "product":"example-product-1",
      "quantity":1,
      "display":"Example Product 1",
      "sku":"skuex1",
      "subtotal":10.0,
      "subtotalDisplay":"$10.00",
      "subtotalInPayoutCurrency":10.0,
      "subtotalInPayoutCurrencyDisplay":"$10.00",
      "attributes":{
        "conditions":"{exclude:{countries:['AT','GB']}}"
      },
      "discount":0.0,
      "discountDisplay":"$0.00",
      "discountInPayoutCurrency":0.0,
      "discountInPayoutCurrencyDisplay":"$0.00",
      "driver":{
        "type":"cross-sell",
        "path":"yourexamplestore"
      }
    }
  ]
}