order-item-out-of-stock
An order-item-out-of-stock
event is triggered when an item is removed from the order, due to being out-of-stock, when delegated to the merchant.
- After the order is delegated: The webhook is sent whenever an item is out of stock on delegation.
- After the order is shipped: The webhook is sent whenever an item is out of stock on shipping.
Example:
Properties:
key
stringlocale
objectappId
integercountryCode
string (minimum length: ) (maximum length: 3)currencyCode
string (optional) (minimum length: ) (maximum length: 3)languageCode
string (minimum length: ) (maximum length: 5)
occurredAt
stringpayload
objectitems
arrayid
integer (optional)availableQuantity
integer (optional)basketItemKey
string (optional)campaignKey
string (optional)currency
string (optional) (minimum length: ) (maximum length: 3)customData
object (optional) (object is extensible as desired)deliveryForecast
object (optional)isManuallyReturnedByCci
boolean (optional)itemGroup
**** (optional)key
stringlowestPriorPrice
**** (optional)merchant
object (optional)packageId
integerprice
objectproduct
object (object is extensible as desired)promotion
object (optional)reservationKey
string (optional)status
enum (available
unavailable
deliverable
undeliverable
cancelled
returned
delivered
created
pended
confirmed
delegated
partially_shipped
shipped
delivered
cancelled
)variant
object (object is extensible as desired)warehouseId
null,integer (optional)warehousePackageGroupId
null,integer (optional)createdAt
string (date-time
ISO 8601
)updatedAt
string (date-time
ISO 8601
)
order
object (object is extensible as desired)id
integeraddress
object (optional)basketKey
stringconfirmedAt
string (date-time
ISO 8601
) (optional)contacts
array (optional)cost
objectcurrencyCode
stringcustomData
object (optional) (object is extensible as desired)customer
object (optional)detailedStatus
object (optional) (object is extensible as desired)invoicedAt
string (date-time
ISO 8601
) (optional)items
array (optional)loyaltyCard
object (optional)membershipDiscount
object (optional)packages
array (optional)payment
array (optional)promotions
array (optional)publicKey
string (optional) (minimum length: ) (maximum length: 100)referenceKey
string (optional) (minimum length: ) (maximum length: 100)shipping
object (optional)shop
object (optional)status
enum (order_open
payment_pending
payment_reserved
invoice_completed
cancellation_pending
cancellation_completed
invoice_partially_completed
)vouchers
array (optional)createdAt
string (date-time
ISO 8601
)updatedAt
string (date-time
ISO 8601
)
type
enum (order-item-out-of-stock
)