order-pending
Occurs when customer pays, but payment is not captured
Example:
{
"key": "1f3e35e7-92b0-4ad2-b596-a215615398d4",
"locale": {
"appId": 999,
"countryCode": "DEU",
"currencyCode": "EUR",
"languageCode": "de-DE"
},
"occurredAt": "2018-01-20T09:30:15+00:00",
"payload": {
"id": 123,
"address": {
"billing": {
"id": 998,
"additional": "c/o AboutYou",
"city": "Hamburg",
"countryCode": "DEU",
"houseNumber": "12",
"isDefault": {
"billing": false,
"shipping": false
},
"phone": "089999123",
"recipient": {
"firstName": "Anna",
"gender": "m",
"lastName": "Fohlmeister",
"type": "personal"
},
"referenceKey": "address-7656",
"state": "Sachsen",
"street": "Wolfgangsweg",
"zipCode": "20459",
"createdAt": "2018-01-20T09:30:15+00:00",
"updatedAt": "2018-01-20T09:30:15+00:00"
},
"forward": {
"additional": "c/o AboutYou",
"city": "Hamburg",
"countryCode": "DEU",
"houseNumber": "12",
"recipient": {
"firstName": "Anna",
"gender": "m",
"lastName": "Fohlmeister",
"type": "personal"
},
"state": "Sachsen",
"street": "Wolfgangsweg",
"zipCode": "20459",
"createdAt": "2018-11-29T05:20:13+01:00",
"updatedAt": "2018-11-29T05:20:13+01:00"
},
"shipping": {
"id": 998,
"city": "Hamburg",
"collectionPoint": {
"customerKey": "bced-234-234",
"description": "Pedro's Kiosk",
"key": "12345-a",
"type": "hermes_parcelshop"
},
"countryCode": "DEU",
"houseNumber": "10",
"isDefault": {
"billing": false,
"shipping": true
},
"phone": "089999123",
"recipient": {
"firstName": "Anna",
"gender": "m",
"lastName": "Fohlmeister",
"type": "personal"
},
"referenceKey": "address-7656",
"state": "Sachsen",
"street": "Domstrasse",
"zipCode": "20459",
"createdAt": "2018-01-20T09:30:15+00:00",
"updatedAt": "2018-01-20T09:30:15+00:00"
}
},
"basketKey": "basket-c6v7k4eer1",
"cost": {
"appliedReductions": [
{
"amount": {
"absoluteWithTax": 100,
"relative": 0.5
},
"category": "voucher",
"code": "ayou123",
"displayName": "ayou123",
"type": "absolute"
}
],
"costCapture": 1390,
"itemGroups": {
"1234567": {
"brutto": 1190,
"bruttoDiscount": 0,
"bruttoDiscountWithoutMainProduct": 0,
"bruttoWithoutMainProduct": 1190,
"netto": 1000,
"nettoWithoutMainProduct": 1000,
"tax": 190,
"taxWithoutMainProduct": 190
}
},
"tax": {
},
"withoutTax": 1000,
"withoutTaxWithMembershipDiscount": 1234,
"withTax": 1190,
"withTaxWithMembershipDiscountWithoutServiceCosts": 1337
},
"currencyCode": "EUR",
"customer": {
"id": 9876,
"authentication": {
"type": "password"
},
"birthDate": "1981-02-02",
"customData": {
"isVip": true
},
"email": "[email protected]",
"firstName": "Anna",
"gender": "f",
"groups": [
"employee",
"vip"
],
"identities": [
{
"idpCode": "keycloak"
},
{
"externalUserId": "123",
"idpCode": "okta"
}
],
"ipAddress": "172.19.0.2",
"lastName": "Fohlmeister",
"phone": "0049/1234567890",
"publicKey": "customer-1234",
"referenceKey": "customer-1234",
"status": {
"isActive": true,
"isAnonymous": false,
"isGuestCustomer": false,
"isTestCustomer": false
},
"title": "Madam",
"type": "retail",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36",
"createdAt": "2018-01-20T09:30:15+00:00",
"updatedAt": "2018-01-20T09:30:15+00:00"
},
"items": [
{
"availableQuantity": 18,
"campaignKey": "fooCampaign",
"customData": {
"key": "value"
},
"deliveryForecast": {
"subsequentDelivery": {
"key": "christmas"
}
},
"isManuallyReturnedByCci": true,
"itemGroup": {
"id": "ab123",
"isMainItem": true,
"isRequired": true
},
"key": "ac834d23e689u678",
"lowestPriorPrice": {
"relativeDifferenceToPrice": -0.25,
"withTax": 1000
},
"packageId": 1,
"price": {
"appliedReductions": [
{
"amount": {
"absoluteWithTax": 100,
"relative": 0.5
},
"category": "sale",
"code": "ayou123",
"type": "relative"
},
{
"amount": {
"absoluteWithTax": 800,
"relative": 0.4
},
"category": "promotion",
"type": "absolute"
}
],
"overrideWithoutTax": 1357,
"overrideWithTax": 1675,
"reference": {
"size": "100",
"unit": "ml",
"withTax": 595
},
"tax": {
"vat": {
"amount": 190,
"rate": 0.19
}
},
"undiscountedWithOutTax": 1000,
"undiscountedWithTax": 1190,
"withoutTax": 1000,
"withTax": 1190
},
"product": {
"id": 4564545,
"advancedAttributes": {
"materialCompositionTextile": {
"key": "materialCompositionTextile",
"label": "Materialzusammensetzung",
"values": [
{
"fieldSet": [
[
{
"value": "Lining"
}
]
],
"groupSet": [
{
"fieldSet": [
[
{
"value": 80
},
{
"unit": "%"
},
{
"material": "Cotton"
}
]
],
"groupSet": [
]
}
]
}
]
}
},
"attributes": {
"description": {
"key": "description",
"label": "Beschreibung",
"values": [
{
"id": 1234,
"label": "A descriptive string (possibly including HTML)",
"value": "Optional value"
}
]
}
},
"categories": [
[
{
"categoryId": 20201,
"categoryName": "Frauen",
"categoryProperties": {
"priority": {
"name": "priority",
"value": "1"
}
},
"categoryUrl": "/frauen"
}
]
],
"definingAttributes": [
{
"key": "color",
"label": "Farbe"
}
],
"images": [
{
"attributes": {
"description": {
"key": "description",
"label": "Beschreibung",
"values": [
{
"label": "A descriptive string (possibly including HTML)"
}
]
}
},
"hash": "9f6c628a98106dcce2bc5a4ac1de9c14"
}
],
"masterKey": "480306626-1",
"name": "Chelsea Boots",
"createdAt": "2018-01-20T09:30:15+00:00",
"updatedAt": "2018-01-20T09:30:15+00:00"
},
"promotion": {
"id": "649178aa530da10426f3f8d1",
"code": "PROMO0124",
"displayName": "Winter sales 2024",
"name": "PromoABC",
"version": "649178aa530da10426f3f8d2"
},
"status": "available",
"variant": {
"id": 1234567,
"attributes": {
"vendorSize": {
"key": "vendorSize",
"label": "Größe",
"values": [
{
"id": 25472,
"label": "34",
"value": "Thirty Four"
}
]
}
},
"referenceKey": "563843898",
"stock": {
"customData": {
},
"deliveryForecast": {
"deliverable": "directShipping",
"subsequentDelivery": "christmas"
},
"isSellableWithoutStock": false,
"quantity": 18,
"supplierId": 271
},
"createdAt": "2018-01-20T09:30:15+00:00",
"updatedAt": "2018-01-20T09:30:15+00:00"
},
"warehouseId": 123456,
"warehousePackageGroupId": 1,
"createdAt": "2018-01-20T09:30:15+00:00",
"updatedAt": "2018-01-20T09:30:15+00:00"
}
],
"packages": [
{
"id": 1,
"carrierKey": "dhl",
"deliveryDate": {
"maximum": "2018-02-05",
"minimum": "2018-02-02"
},
"deliveryStatus": "open",
"hasExpectedAvailabilityAt": false,
"returnIdentCode": "123-123",
"shipmentKey": "shpmnt-123",
"tracking": {
"id": "79003131200523",
"url": "https://tracking.hermesworld.com/?TrackID=79003131200523"
}
}
],
"payment": [
{
"amount": 1190,
"key": "computop_creditcard"
}
],
"publicKey": "order-2234",
"referenceKey": "order-2234",
"shipping": {
"deliveredOn": "2019-11-29",
"policy": "delivery_deadline"
},
"status": "payment_pending",
"vouchers": [
{
"id": 198234,
"applicableItems": [
{
"isApplied": true,
"key": "a87ff679a2f3e71d9181a67b7542122c"
},
{
"isApplied": false,
"key": "eccbc87e4b5ce2fe28308fd9f2a7baf3"
}
],
"code": "fashion2020",
"type": "absolute",
"value": 1000,
"voucherId": 33413
}
],
"createdAt": "2018-01-20T09:30:15+00:00",
"updatedAt": "2018-01-20T09:30:15+00:00"
},
"type": "order-pending"
}
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
object (object is extensible as desired)id
integeraddress
object (optional)billing
objectforward
object (optional)shipping
object
basketKey
stringconfirmedAt
string (date-time
ISO 8601
) (optional)contacts
array (optional)type
string (optional)value
string (optional)
cost
objectappliedFees
array (optional)appliedReductions
array (optional)costCapture
integer (optional)itemGroups
object,null (optional)tax
objectwithoutTax
integerwithoutTaxWithMembershipDiscount
integer (optional)withTax
integerwithTaxWithMembershipDiscountWithoutServiceCosts
integer (optional)
currencyCode
stringcustomData
object (optional) (object is extensible as desired)customer
object (optional)id
integeranonymisation
object (optional)authentication
object (optional)birthDate
string (optional)customData
object (optional) (object is extensible as desired)email
string (optional) (maximum length: 60)firstName
stringgender
enum (m
f
d
n
) (optional)groups
array (optional)identities
array (optional)ipAddress
string (optional)lastName
stringphone
string (optional)publicKey
string(optional) (minimum length: ) (maximum length: 100)referenceKey
string (optional) (minimum length: ) (maximum length: 100)status
objecttitle
null,string (optional) (maximum length: 30)type
enum (personal
retail
organization
family
)userAgent
string (optional)createdAt
string (date-time
ISO 8601
)updatedAt
string (date-time
ISO 8601
)
detailedStatus
object (optional) (object is extensible as desired)billing
object (object is extensible as desired)order
object (object is extensible as desired)shipping
object (object is extensible as desired)
invoicedAt
string (date-time
ISO 8601
) (optional)items
array (optional)id
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
)
loyaltyCard
object (optional)cardNumber
string (optional)points
integerprovider
string ([A-Za-z]
)
membershipDiscount
object (optional)membershipCardId
integer (optional)pointsUsed
integer (optional)reductionValue
integer (optional)tax
integer (optional)
packages
array (optional)id
integercarrierKey
string (optional)deliveryDate
objectdeliveryStatus
enum (open
shipment_pending
delegation_pending
shipment_completed
cancellation_completed
)hasExpectedAvailabilityAt
boolean (optional)returnIdentCode
null,string (optional)shipmentKey
string (optional)tracking
object (optional)
payment
array (optional)amount
integer (optional)data
object (optional) (object is extensible as desired)installment
array (optional)isGiftCard
boolean (optional)key
string (optional)options
object (optional)transactionKey
string (optional)
promotions
array (optional)id
string (optional)code
string (optional)displayName
string (optional)reduction
integer (optional)version
string (optional)
publicKey
string (optional) (minimum length: ) (maximum length: 100)referenceKey
string (optional) (minimum length: ) (maximum length: 100)shipping
object (optional)deliveredOn
string (optional)deliveryCosts
integer (optional)expressDeliveryCosts
integer (optional)policy
string (minimum length: )
shop
object (optional)id
integercountry
stringlanguage
string
status
enum (order_open
payment_pending
payment_reserved
invoice_completed
cancellation_pending
cancellation_completed
invoice_partially_completed
)vouchers
array (optional)id
integerapplicableItems
array (optional)code
stringtype
enum (absolute
relative
)value
numbervoucherId
integer
createdAt
string (date-time
ISO 8601
)updatedAt
string (date-time
ISO 8601
)
type
enum (order-pending
)