return
post
/ccadmin/v1/webhook/return
This Event is triggered when a return request is initiated
Request
Supported Media Types
- application/json
This Event is triggered when a return request is initiated
Root Schema : return_request
Type:
object
This Event is triggered when a return request is initiated
Show Source
-
op(optional):
string
Specify the operation to be performed such as ReceiveReturns, InitiateRefund, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete etc.
-
return(optional):
object return
Example:
{
"op":"createExchangeRequest",
"return":{
"agentId":"service",
"authorizationDate":"2018-03-05T13:03:07.698Z",
"refundSubtotal":25,
"relatedReplacementOrders":[
{
"approverIds":[
],
"gwp":false,
"secondaryCurrencyCode":null,
"lastModifiedTime":1.520254987961E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.520254983031E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"paymentGroups":[
{
"amountAuthorized":106.25,
"amount":25,
"paymentMethod":"tokenizedCreditCard",
"id":"pg30412",
"billingAddress":{
"country":"US",
"lastName":"MILLER",
"address3":null,
"city":"Springfield",
"address2":null,
"prefix":null,
"address1":"Address Line 1",
"companyName":null,
"postalCode":"01144",
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"kumar":null,
"firstName":"JESSICA",
"phoneNumber":"12345678",
"faxNumber":null,
"middleName":null,
"state":"MA",
"email":"JESSICA.MILLER@test.com"
},
"currencyCode":"USD"
}
],
"locale":null,
"submittedDate":"2018-03-05T13:03:07.537Z",
"salesChannel":"default",
"configuratorId":null,
"payTaxInSecondaryCurrency":null,
"organizationId":null,
"priceInfo":{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"amount":25,
"secondaryCurrencyShippingAmount":0,
"secondaryCurrencyTotal":0,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":0,
"rawSubtotal":25,
"total":25,
"shipping":0,
"primaryCurrencyTotal":25,
"amountIsFinal":false,
"currencyCode":"USD"
},
"relationships":[
{
"paymentGroupId":"pg30412",
"amount":25,
"relationshipType":"ORDERAMOUNT",
"id":"r40386"
}
],
"catalogId":null,
"exchangeRate":null,
"totalCommerceItemCount":1,
"id":"o30412",
"externalContext":false,
"state":"PENDING_CUSTOMER_RETURN",
"quoteInfo":null,
"taxCalculated":false,
"commerceItems":[
{
"deactivationDate":null,
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingAccountId":null,
"preOrderQuantity":0,
"assetKey":null,
"itemDiscountInfos":[
],
"priceInfo":{
"discounted":false,
"amount":25,
"secondaryCurrencyShippingSurcharge":0,
"rawTotalPrice":99.99,
"salePrice":25,
"priceListId":"salePrices",
"quantityDiscounted":0,
"amountIsFinal":true,
"onSale":true,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"amount":25,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"orderDiscountShare":0,
"tax":0,
"detailedUnitPrice":25,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":99.99
},
"catalogId":null,
"externalRecurringChargeDetails":null,
"externalPriceDetails":null,
"actionCode":null,
"id":"ci3000412",
"serviceId":null,
"serviceAccountId":null,
"quantity":1,
"productId":"prod10013",
"orderDiscountInfos":[
],
"parentAssetKey":null,
"externalId":null,
"rootAssetKey":null,
"transactionDate":null,
"catalogRefId":"sku10030",
"customerAccountId":null,
"recurringChargePriceInfo":null,
"lineAttributes":[
],
"productDisplayName":"Playstation",
"catalogKey":null,
"siteId":"siteUS",
"shopperInput":{
},
"activationDate":null,
"asset":false,
"backOrderQuantity":0
}
],
"taxPriceInfo":{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"valueAddedTax":0,
"amount":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"miscTaxInfo":{
},
"countryTax":0,
"cityTax":0,
"amountIsFinal":true,
"currencyCode":"USD"
},
"shippingGroups":[
{
"lastName":"Anderson",
"shippingMethod":"inStorePickupShippingGroup",
"description":"sg40492",
"submittedDate":null,
"firstName":"Kim",
"priceInfo":{
"secondaryCurrencyTaxAmount":0.68,
"discounted":false,
"shippingTax":1.7,
"secondaryCurrencyShippingAmount":8.4,
"amount":21,
"rawShipping":11,
"amountIsFinal":false,
"currencyCode":"L10174"
},
"phoneNumber":"212-555-1977",
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"commerceItemRelationships":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"commerceItemId":"ci3000500",
"inventoryLocationId":"SiteUS-GlenAllen186",
"amount":0,
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"state":"INITIAL",
"id":"r40526"
}
],
"state":"INITIAL",
"id":"sg40492",
"stateDetail":null,
"trackingNumber":null,
"email":"kim@example.com",
"handlingInstructions":[
],
"shippingGroupClassType":"inStorePickupShippingGroup"
}
],
"freezeDate":null,
"taxExempt":false,
"lastModifiedDate":"2018-03-05T13:03:07.961Z",
"approvalSystemMessages":[
],
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"city":"Syracuse",
"address2":null,
"prefix":null,
"address1":"21 Cedar Ave",
"companyName":null,
"postalCode":"13202",
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"version":2,
"kumar":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"faxNumber":null,
"middleName":null,
"id":"se-980031",
"state":"NY"
},
"middleName":null,
"login":"kim@example.com",
"parentOrganization":null,
"email":"kim@example.com"
},
"approverMessages":[
],
"paymentInitiatedEmailSent":false,
"payShippingInSecondaryCurrency":null,
"shippingGroupCount":1,
"taxExemptionCode":null,
"paymentGroupCount":1,
"recurringChargePriceInfo":null,
"profileId":"se-570031",
"organization":null,
"siteId":"siteUS",
"activeQuoteOrderId":null
}
],
"refundMethodList":[
{
"refundType":"manualRefund",
"amount":25,
"maximumRefundAmount":-1
}
],
"allocatedAmount":25,
"originatingOrder":{
"approverIds":[
],
"gwp":false,
"secondaryCurrencyCode":null,
"lastModifiedTime":1.520254987918E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.400515604E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"paymentGroups":[
{
"amountAuthorized":106.25,
"amount":106.25,
"paymentMethod":"tokenizedCreditCard",
"id":"pg10401",
"billingAddress":{
"country":"US",
"lastName":"MILLER",
"address3":null,
"city":"Springfield",
"address2":null,
"prefix":null,
"address1":"Address Line 1",
"companyName":null,
"postalCode":"01144",
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"kumar":null,
"firstName":"JESSICA",
"phoneNumber":"12345678",
"faxNumber":null,
"middleName":null,
"state":"MA",
"email":"JESSICA.MILLER@test.com"
},
"currencyCode":"USD"
}
],
"locale":null,
"submittedDate":"2014-05-19T16:06:45.000Z",
"salesChannel":"default",
"configuratorId":null,
"payTaxInSecondaryCurrency":null,
"organizationId":null,
"priceInfo":{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"amount":75,
"secondaryCurrencyShippingAmount":0,
"secondaryCurrencyTotal":0,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":6.25,
"rawSubtotal":75,
"total":106.25,
"shipping":25,
"primaryCurrencyTotal":75,
"amountIsFinal":false,
"orderTotalBySite":{
"siteUS":106.25
},
"currencyCode":"USD"
},
"relationships":[
{
"paymentGroupId":"pg10401",
"amount":106.25,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r10374"
}
],
"catalogId":null,
"exchangeRate":null,
"totalCommerceItemCount":2,
"id":"o10401",
"externalContext":false,
"state":"NO_PENDING_ACTION",
"quoteInfo":null,
"taxCalculated":false,
"commerceItems":[
{
"deactivationDate":null,
"returnedQuantity":1,
"availabilityDate":null,
"externalData":[
],
"billingAccountId":null,
"preOrderQuantity":0,
"assetKey":null,
"itemDiscountInfos":[
],
"priceInfo":{
"discounted":false,
"amount":75,
"secondaryCurrencyShippingSurcharge":0,
"rawTotalPrice":299.97,
"salePrice":25,
"priceListId":"salePrices",
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":true,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"amount":75,
"quantity":3,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":2,
"size":3
},
"orderDiscountShare":0,
"tax":6.25,
"detailedUnitPrice":25,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":99.99
},
"catalogId":null,
"externalRecurringChargeDetails":null,
"externalPriceDetails":null,
"actionCode":null,
"id":"ci1000401",
"serviceId":null,
"serviceAccountId":null,
"quantity":2,
"productId":"prod10013",
"orderDiscountInfos":[
],
"parentAssetKey":null,
"externalId":null,
"rootAssetKey":null,
"transactionDate":null,
"catalogRefId":"sku10030",
"customerAccountId":null,
"recurringChargePriceInfo":null,
"lineAttributes":[
],
"productDisplayName":"Playstation",
"catalogKey":null,
"siteId":"siteUS",
"shopperInput":{
},
"activationDate":null,
"asset":false,
"backOrderQuantity":0
}
],
"taxPriceInfo":{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"valueAddedTax":0,
"amount":6.25,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":6.25,
"miscTaxInfo":{
},
"countryTax":0,
"cityTax":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shippingGroups":[
{
"lastName":"Anderson",
"shippingMethod":"inStorePickupShippingGroup",
"description":"sg40492",
"submittedDate":null,
"firstName":"Kim",
"priceInfo":{
"secondaryCurrencyTaxAmount":0.68,
"discounted":false,
"shippingTax":1.7,
"secondaryCurrencyShippingAmount":8.4,
"amount":21,
"rawShipping":11,
"amountIsFinal":false,
"currencyCode":"L10174"
},
"phoneNumber":"212-555-1977",
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"commerceItemRelationships":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"commerceItemId":"ci3000500",
"inventoryLocationId":"SiteUS-GlenAllen186",
"amount":0,
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"state":"INITIAL",
"id":"r40526"
}
],
"state":"INITIAL",
"id":"sg40492",
"stateDetail":null,
"trackingNumber":null,
"email":"kim@example.com",
"handlingInstructions":[
],
"shippingGroupClassType":"inStorePickupShippingGroup"
}
],
"freezeDate":null,
"taxExempt":false,
"lastModifiedDate":"2018-03-05T13:03:07.918Z",
"creationSiteId":"siteUS",
"approvalSystemMessages":[
],
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"customerContactId":"CRMID_12345",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"city":"Syracuse",
"address2":null,
"prefix":null,
"address1":"21 Cedar Ave",
"companyName":null,
"postalCode":"13202",
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"version":2,
"kumar":null,
"externalAddressId":"externalId",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"faxNumber":null,
"middleName":null,
"id":"se-980031",
"state":"NY"
},
"middleName":null,
"login":"kim@example.com",
"parentOrganization":null,
"email":"kim@example.com"
},
"approverMessages":[
],
"paymentInitiatedEmailSent":false,
"payShippingInSecondaryCurrency":null,
"shippingGroupCount":1,
"taxExemptionCode":null,
"paymentGroupCount":1,
"recurringChargePriceInfo":null,
"profileId":"se-570031",
"organization":null,
"siteId":"siteUS",
"markers":[
{
"value":"78900",
"key":"campaign_eloqua"
}
],
"activeQuoteOrderId":null
},
"suggestedShippingRefund":0,
"returnPaymentState":"None",
"processName":"Exchange",
"orderCurrencyCode":"USD",
"processImmediately":false,
"returnAdjustedOrderId":null,
"returnCalculationOrder":null,
"state":"PENDING_CUSTOMER_ACTION",
"unAdjustedRefundSubtotal":25,
"returnItemCount":1,
"trackingNumber":null,
"totalOrderPromotionValueAdjustmentChange":0,
"comments":null,
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"customerContactId":"CRMID_12345",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"firstName":"Kim",
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"repositoryId":"se-980031",
"middleName":null,
"state":"NY"
},
"middleName":null,
"id":"se-570031",
"parentOrganization":null,
"login":"kim@example.com",
"email":"kim@example.com"
},
"suggestedTaxRefund":0,
"nonReturnItemCostAdjustments":[
],
"replacementOrder":{
"approverIds":[
],
"gwp":false,
"secondaryCurrencyCode":null,
"lastModifiedTime":1.520254987961E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.520254983031E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"paymentGroups":[
{
"amountAuthorized":106.25,
"amount":25,
"paymentMethod":"tokenizedCreditCard",
"id":"pg30412",
"billingAddress":{
"country":"US",
"lastName":"MILLER",
"address3":null,
"city":"Springfield",
"address2":null,
"prefix":null,
"address1":"Address Line 1",
"companyName":null,
"postalCode":"01144",
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"kumar":null,
"firstName":"JESSICA",
"phoneNumber":"12345678",
"faxNumber":null,
"middleName":null,
"state":"MA",
"email":"JESSICA.MILLER@test.com"
},
"currencyCode":"USD"
}
],
"locale":null,
"submittedDate":"2018-03-05T13:03:07.537Z",
"salesChannel":"default",
"configuratorId":null,
"payTaxInSecondaryCurrency":null,
"organizationId":null,
"priceInfo":{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"amount":25,
"secondaryCurrencyShippingAmount":0,
"secondaryCurrencyTotal":0,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":0,
"rawSubtotal":25,
"total":25,
"shipping":0,
"primaryCurrencyTotal":25,
"amountIsFinal":false,
"currencyCode":"USD"
},
"relationships":[
{
"paymentGroupId":"pg30412",
"amount":25,
"relationshipType":"ORDERAMOUNT",
"id":"r40386"
}
],
"catalogId":null,
"exchangeRate":null,
"totalCommerceItemCount":1,
"id":"o30412",
"externalContext":false,
"state":"PENDING_CUSTOMER_RETURN",
"quoteInfo":null,
"taxCalculated":false,
"commerceItems":[
{
"deactivationDate":null,
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingAccountId":null,
"preOrderQuantity":0,
"assetKey":null,
"itemDiscountInfos":[
],
"priceInfo":{
"discounted":false,
"amount":25,
"secondaryCurrencyShippingSurcharge":0,
"rawTotalPrice":99.99,
"salePrice":25,
"priceListId":"salePrices",
"quantityDiscounted":0,
"amountIsFinal":true,
"onSale":true,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"amount":25,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"orderDiscountShare":0,
"tax":0,
"detailedUnitPrice":25,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":99.99
},
"catalogId":null,
"externalRecurringChargeDetails":null,
"externalPriceDetails":null,
"actionCode":null,
"id":"ci3000412",
"serviceId":null,
"serviceAccountId":null,
"quantity":1,
"productId":"prod10013",
"orderDiscountInfos":[
],
"parentAssetKey":null,
"externalId":null,
"rootAssetKey":null,
"transactionDate":null,
"catalogRefId":"sku10030",
"customerAccountId":null,
"recurringChargePriceInfo":null,
"lineAttributes":[
],
"productDisplayName":"Playstation",
"catalogKey":null,
"siteId":"siteUS",
"shopperInput":{
},
"activationDate":null,
"asset":false,
"backOrderQuantity":0
}
],
"taxPriceInfo":{
"secondaryCurrencyTaxAmount":0,
"discounted":false,
"valueAddedTax":0,
"amount":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"miscTaxInfo":{
},
"countryTax":0,
"cityTax":0,
"amountIsFinal":true,
"currencyCode":"USD"
},
"shippingGroups":[
{
"lastName":"Anderson",
"shippingMethod":"inStorePickupShippingGroup",
"description":"sg40492",
"submittedDate":null,
"firstName":"Kim",
"priceInfo":{
"secondaryCurrencyTaxAmount":0.68,
"discounted":false,
"shippingTax":1.7,
"secondaryCurrencyShippingAmount":8.4,
"amount":21,
"rawShipping":11,
"amountIsFinal":false,
"currencyCode":"L10174"
},
"phoneNumber":"212-555-1977",
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"commerceItemRelationships":[
{
"availablePickupDate":"2018-05-19T13:00:00.000Z",
"commerceItemId":"ci3000500",
"inventoryLocationId":"SiteUS-GlenAllen186",
"amount":0,
"quantity":1,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"preferredPickupDate":"2018-05-19T13:00:00.000Z",
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"state":"INITIAL",
"id":"r40526"
}
],
"state":"INITIAL",
"id":"sg40492",
"stateDetail":null,
"trackingNumber":null,
"email":"kim@example.com",
"handlingInstructions":[
],
"shippingGroupClassType":"inStorePickupShippingGroup"
}
],
"freezeDate":null,
"taxExempt":false,
"lastModifiedDate":"2018-03-05T13:03:07.961Z",
"creationSiteId":"siteUS",
"approvalSystemMessages":[
],
"profile":{
"lastName":"Anderson",
"firstName":"Kim",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"city":"Syracuse",
"address2":null,
"prefix":null,
"address1":"21 Cedar Ave",
"companyName":null,
"postalCode":"13202",
"jobTitle":null,
"county":null,
"suffix":null,
"ownerId":null,
"version":2,
"kumar":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"faxNumber":null,
"middleName":null,
"id":"se-980031",
"state":"NY"
},
"middleName":null,
"login":"kim@example.com",
"parentOrganization":null,
"email":"kim@example.com"
},
"approverMessages":[
],
"paymentInitiatedEmailSent":false,
"payShippingInSecondaryCurrency":null,
"shippingGroupCount":1,
"taxExemptionCode":null,
"paymentGroupCount":1,
"recurringChargePriceInfo":null,
"profileId":"se-570031",
"organization":null,
"siteId":"siteUS",
"activeQuoteOrderId":null
},
"actualShippingRefund":0,
"actualTaxRefund":0,
"otherRefund":0,
"returnLabel":null,
"processed":false,
"totalItemRefund":25,
"returningItems":true,
"authorizationNumber":"100001",
"exchangeProcess":true,
"replacingItems":false,
"returnFee":0,
"totalReturnItemRefund":25,
"submitExchangeAllowed":false,
"originOfReturn":"contactCenter",
"totalRefundAmount":25,
"unallocatedAmount":0,
"additionalProperties":{
},
"originatingOrderId":"o10401",
"nonReturnItemSubtotalAdjustment":0,
"adjustmentAmount":0,
"replaceItemCount":0,
"returnItemList":[
{
"quantityReturned":1,
"quantityToReturn":1,
"quantityAvailable":0,
"returnItemId":"100001",
"suggestedTaxRefundShare":0,
"shippingGroupId":"sg10401",
"itemCurrencyCode":"USD",
"quantityToExchange":0,
"description":null,
"catalogRefId":"sku10030",
"suggestedShippingRefundShare":0,
"commerceItemId":"ci1000401",
"disposition":null,
"quantityShipped":1,
"returnReason":"defective",
"itemCostAdjustments":[
],
"actualShippingRefundShare":0,
"suggestedRefundAmount":25,
"actualTaxRefundShare":0,
"quantityReceived":0,
"refundAmount":25
}
]
}
}
Nested Schema : return
Type:
Show Source
object
-
actualShippingRefund(optional):
number
Actual Shipping Refund
-
actualTaxRefund(optional):
number
Actual Tax Refund
-
additionalProperties(optional):
object additionalProperties
-
adjustmentAmount(optional):
number
-
agentId(optional):
string
-
allocatedAmount(optional):
number
-
authorizationDate(optional):
string
Authorization date.
-
authorizationNumber(optional):
string
A Return Merchandise Authorization number of the return Request.
-
comments(optional):
string
-
exchangeProcess(optional):
boolean
-
nonReturnItemCostAdjustments(optional):
array nonReturnItemCostAdjustments
-
nonReturnItemSubtotalAdjustment(optional):
number
-
orderCurrencyCode(optional):
string
Currency used to place order
-
originatingOrder(optional):
object return_order
-
originatingOrderId(optional):
string
Originating order id.
-
originOfReturn(optional):
string
-
otherRefund(optional):
number
Other Refund.
-
processed(optional):
boolean
-
processImmediately(optional):
boolean
-
processName(optional):
string
-
profile(optional):
object profile
-
refundMethodList(optional):
array refundMethodList
-
refundSubtotal(optional):
number
Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items.
- relatedReplacementOrders(optional): array relatedReplacementOrders
-
replaceItemCount(optional):
integer
-
replacementOrder(optional):
object return_order
-
replacingItems(optional):
boolean
-
returnAdjustedOrderId(optional):
number
-
returnFee(optional):
integer
Return fee.
-
returningItems(optional):
boolean
-
returnItemCount(optional):
integer
-
returnItemList(optional):
array returnItemList
List of returnable Items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
-
returnItemListIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding returnItemList property is truncated. The value for this field will be true always if present
-
returnLabel(optional):
string
Return label of the return Request.
-
returnPaymentState(optional):
string
-
state(optional):
string
The state of the return request
-
submitExchangeAllowed(optional):
boolean
-
suggestedShippingRefund(optional):
number
Shipping Refund for a returnItem
-
suggestedTaxRefund(optional):
number
Tax Refund of all Return Items.
-
totalItemRefund(optional):
number
-
totalOrderPromotionValueAdjustmentChange(optional):
number
-
totalRefundAmount(optional):
number
-
totalReturnItemRefund(optional):
number
-
trackingNumber(optional):
string
Tracking number of the return request.
-
unAdjustedRefundSubtotal(optional):
number
Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items.
-
unallocatedAmount(optional):
number
Nested Schema : return_order
Type:
Show Source
object
-
activeQuoteOrderId(optional):
string
-
approvalSystemMessages(optional):
array approvalSystemMessages
-
approverIds(optional):
array approverIds
-
approverMessages(optional):
array approverMessages
-
catalogId(optional):
string
-
commerceItems(optional):
array commerceItems
The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
-
commerceItemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding commerceItems property is truncated. The value for this field will be true always if present
-
configuratorId(optional):
string
-
creationSiteId(optional):
string
The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime(optional):
integer
-
exchangeRate(optional):
number
exchangeRate
-
externalContext(optional):
boolean
-
freezeDate(optional):
string
-
gwp(optional):
boolean
-
gwpMarkers(optional):
array gwpMarkers
gwpOrderMarker information
-
id(optional):
string
Order id
-
lastModifiedDate(optional):
string
-
lastModifiedTime(optional):
integer
The last modified time.
-
locale(optional):
string
-
markers(optional):
array markers
Order marker information
-
orderAction(optional):
string
The action performed on the order.
-
organization(optional):
object organization
-
organizationId(optional):
string
The organization ID.
-
paymentGroupCount(optional):
integer
-
paymentGroups(optional):
array paymentGroups
The array of payment groups represent the payment(s) that paid for the order.
-
paymentInitiatedEmailSent(optional):
boolean
-
payShippingInSecondaryCurrency(optional):
boolean
-
payTaxInSecondaryCurrency(optional):
boolean
-
priceGroupId(optional):
string
-
priceInfo(optional):
object priceInfo
Pricing information, an instance of OrderPriceInfo.
-
profile(optional):
object profile
Basic profile information.
-
profileId(optional):
string
The ID of the shopper profile that owns the order.
-
quoteInfo(optional):
object quoteInfo
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
relationships(optional):
array relationships
-
salesChannel(optional):
string
-
secondaryCurrencyCode(optional):
string
Secondary currencyCode
-
shippingGroupCount(optional):
integer
Shipping group count
-
shippingGroups(optional):
array shippingGroups
Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment.
-
siteId(optional):
string
Site used to create order
-
sourceSystem(optional):
string
-
state(optional):
string
State of order
-
submittedDate(optional):
string
Order submitted date
-
taxCalculated(optional):
boolean
Whether tax is calculated or not
-
taxExempt(optional):
boolean
-
taxExemptionCode(optional):
string
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
totalCommerceItemCount(optional):
integer
Nested Schema : profile
Type:
Show Source
object
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
-
firstName(optional):
string
-
id(optional):
string
-
lastName(optional):
string
-
login(optional):
string
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
middleName(optional):
string
-
parentOrganization(optional):
object parentOrganization
-
shippingAddress(optional):
object return_address
Nested Schema : returnItemList
Type:
array
List of returnable Items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
-
Array of:
object returnItem_def
return Item
Nested Schema : items
Type:
Show Source
object
-
amountAdjustment(optional):
number
-
class(optional):
string
-
commerceItemId(optional):
string
- manualAdjustmentShareAdjustment(optional): number
- orderDiscountShareAdjustment(optional): number
-
quantityAdjusted(optional):
integer
-
shippingGroupId(optional):
string
- shippingShareAdjustment(optional): number
- taxShareAdjustment(optional): number
Nested Schema : commerceItems
Type:
array
The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : organization
Type:
Show Source
object
-
active(optional):
boolean
Whether organization is active
-
externalOrganizationId(optional):
string
External id of the organization.
-
id(optional):
string
Id of organization.
-
name(optional):
string
Name of organization
-
repositoryId(optional):
string
Repository id
Nested Schema : paymentGroups
Type:
array
The array of payment groups represent the payment(s) that paid for the order.
Show Source
Nested Schema : priceInfo
Type:
object
Pricing information, an instance of OrderPriceInfo.
Show Source
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
discountAmount(optional):
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal.
-
discounted(optional):
boolean
Whether the price is discounted.
-
manualAdjustmentTotal(optional):
number
The monetary total of manual adjustments.
-
orderTotalBySite(optional):
object orderTotalBySite
The map containing order totals by site for all sites in a given order.
-
primaryCurrencyTotal(optional):
number
The primary currency total amount.
-
rawSubtotal(optional):
number
The monetary raw subtotal.
-
secondaryCurrencyShippingAmount(optional):
number
The secondary currency shipping amount.
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount.
-
secondaryCurrencyTotal(optional):
number
The secondary currency total amount.
-
shipping(optional):
number
The monetary cost of shipping.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The monetary total: amount + shipping + tax.
Nested Schema : profile
Type:
object
Basic profile information.
Show Source
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
The email address
-
firstName(optional):
string
First name.
-
lastName(optional):
string
Last name.
-
login(optional):
string
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
middleName(optional):
string
Middle name.
-
parentOrganization(optional):
object parentOrganization
-
repositoryId(optional):
string
Id of profile
-
shippingAddress(optional):
object shippingAddress
Default shipping address
Nested Schema : quoteInfo
Type:
Show Source
object
-
agentId(optional):
string
-
errorInfo(optional):
string
-
expirationDate(optional):
string
-
externalId(optional):
string
-
providerNote(optional):
string
-
quoteDate(optional):
string
-
rejectionDate(optional):
string
-
rejectionNote(optional):
string
-
requestDate(optional):
string
-
requesterNote(optional):
string
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
discountAmount(optional):
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
frequencyAmountTotals(optional):
number
Frequency amount totals
-
frequencyTaxTotals(optional):
number
Frequency tax totals
-
manualAdjustmentTotal(optional):
number
The total of manual adjustments
-
primaryCurrencyTotal(optional):
number
The primary currency total amount.
-
rawSubTotal(optional):
number
The raw sub total price of the recurring charge.
-
secondaryCurrencyShippingAmount(optional):
number
Secondary currency shipping amoount.
-
secondaryCurrencyTaxAmount(optional):
number
Secondary currency tax amount
-
secondaryCurrencyTotal(optional):
number
Secondary currency total
-
shipping(optional):
number
Shipping amount.
-
tax(optional):
number
The tax amount
Nested Schema : shippingGroups
Type:
array
Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment.
Show Source
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
cityTax(optional):
number
The monetary amount of city tax.
-
countryTax(optional):
number
The monetary amount of country tax.
-
countyTax(optional):
number
The monetary amount of county tax.
-
currencyCode(optional):
string
The three character currency code.
-
discounted(optional):
boolean
Whether the price was discounted.
-
districtTax(optional):
number
Tax amount for the district.
-
isTaxIncluded(optional):
boolean
If Tax is Included
-
miscTax(optional):
number
-
miscTaxInfo(optional):
object miscTaxInfo
-
secondaryCurrencyTaxAmount(optional):
number
The tax amount in secondary currency
-
stateTax(optional):
number
Tax amount for the state.
-
valueAddedTax(optional):
number
The value added tax
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the third party system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that defines it the item is an asset or not.
-
assetKey(optional):
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate(optional):
string(date-time)
The availability date for preOrdered/backOrdered quantity.
-
backOrderQuantity(optional):
integer
The back ordered quantity included.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogId(optional):
string
The ID of the catalog which this commerce item references.
-
catalogKey(optional):
string
The key of the catalog this commerce item references.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a third party system.
-
externalId(optional):
string
An optional, external ID for this commerce item.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
id(optional):
string
The internal/native ID for this commerce item.
-
itemDiscountInfos(optional):
array itemDiscountInfos
Array of item promotions affecting this item.
-
lineAttributes(optional):
array lineAttributes
-
orderDiscountInfos(optional):
array orderDiscountInfos
Array of order promotions affecting this item.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
preOrderQuantity(optional):
integer
The pre ordered quantity included.
-
priceInfo(optional):
object priceInfo
Details about pricing.
-
productDisplayName(optional):
string
The product's display name.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
returnedQuantity(optional):
integer
The quantity returned.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : itemDiscountInfos
Type:
array
Array of item promotions affecting this item.
Show Source
Nested Schema : orderDiscountInfos
Type:
array
Array of order promotions affecting this item.
Show Source
Nested Schema : priceInfo
Type:
object
Details about pricing.
Show Source
-
amount(optional):
number
The monetary amount of this order.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quanity discounted.
-
rawTotalPrice(optional):
number
The raw total price.
-
salePrice(optional):
number
The sale price
-
secondaryCurrencyShippingSurcharge(optional):
number
Extra handling cost in secondary currency for shipping the product.
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
secondaryCurrencyShippingSurcharge(optional):
number
Extra handling cost in secondary currency for shipping the product.
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the third party system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The map values associated with an externalData item.
Nested Schema : values
Type:
object
The map values associated with an externalData item.
Show Source
-
key(optional):
string
Map key defined by external system.
-
value(optional):
string
Map value defined by external system.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount of discount this item received from the promotion.
-
couponCodes(optional):
array couponCodes
One or more coupon codes used to grant the item promotion providing the discount.
-
promotionId(optional):
string
The promotion id that resulted in the discount.
Nested Schema : couponCodes
Type:
array
One or more coupon codes used to grant the item promotion providing the discount.
Show Source
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The amount of discount this item received from the promotion.
-
couponCodes(optional):
array couponCodes
One or more coupon codes used to grant the order promotion providing the discount.
-
promotionId(optional):
string
The promotion id that resulted in the discount.
Nested Schema : couponCodes
Type:
array
One or more coupon codes used to grant the order promotion providing the discount.
Show Source
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity.
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this price info
-
range(optional):
object range
Represents which specific items are covered by this price info.
-
secondaryCurrencyTaxAmount(optional):
number
tax amount in secondaryCurrency
-
tax(optional):
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this price info covers.
-
lowBound(optional):
integer
The lower bound of the range this price info covers, inclusive.
-
size(optional):
integer
The number of items in this range, inclusive.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity.
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
integer
The number of items in this range, inclusive.
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove(optional):
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data(optional):
integer
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity(optional):
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
-
giftDetail(optional):
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType(optional):
string
The type of the gift. (sku, product)
-
key(optional):
string
-
quantity(optional):
number
The total quantity of sku for this gift selection.
-
removedQuantity(optional):
number
Quantity that has been manually removed by a Shopper.
-
selectedQuantity(optional):
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity(optional):
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value(optional):
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object
-
key(optional):
string
Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
-
value(optional):
string
Order marker value. In the case of a marketing campaign, it represents the actual unique campaign ID
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The monetary amount of the payment.
-
amountAuthorized(optional):
number
The amount authorized.
-
billingAddress(optional):
object billingAddress
The billing address details
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
id(optional):
string
The internal ID of the payment group.
-
paymentMethod(optional):
string
Nested Schema : billingAddress
Type:
object
The billing address details
Show Source
-
address1(optional):
string
The 1st line of address field
-
address2(optional):
string
The 2nd line of address field
-
address3(optional):
string
The 3rd line of address field
-
city(optional):
string
The city of the customer
-
companyName(optional):
string
The company name
-
country(optional):
string
The country of the customer
-
county(optional):
string
The county
-
email(optional):
string
The email of the customer
-
faxNumber(optional):
string
The fax number of the customer
-
firstName(optional):
string
The first name of the customer
-
jobTitle(optional):
string
The job title
-
lastName(optional):
string
The last name of customer
-
middleName(optional):
string
The middle name of the customer
-
ownerId(optional):
string
The ID of the owner of this address
-
phoneNumber(optional):
string
The phone number of the customer
-
postalCode(optional):
string
The postal code
-
prefix(optional):
string
The prefix
-
state(optional):
string
The state
-
suffix(optional):
string
The suffix
Nested Schema : orderTotalBySite
Type:
object
The map containing order totals by site for all sites in a given order.
Nested Schema : shippingAddress
Type:
object
Default shipping address
Show Source
-
address1(optional):
string
Address Line 1.
-
address2(optional):
string
Address Line 2.
-
address3(optional):
string
Address Line 3.
-
city(optional):
string
City.
-
country(optional):
string
Country.
-
county(optional):
string
Name of the county.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
repositoryId(optional):
string
Id of shipping address
-
state(optional):
string
State.
Nested Schema : items
Type:
Show Source
object
-
membershipId(optional):
string
membershipId of the profile.
-
programId(optional):
string
programId of Loyalty Program
-
programName(optional):
string
programName of Loyalty Program
-
repositoryId(optional):
string
repository Id
-
status(optional):
string
status of Enrollment.
Nested Schema : items
Type:
Show Source
object
-
actualShipDate(optional):
string
The actual shipped date of this shipping group.
-
commerceItemRelationships(optional):
array commerceItemRelationships
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order.
-
description(optional):
string
The description of this shipping group.
-
email(optional):
string
The email address of the person responsible for picking up the contents of this shipping group.
-
firstName(optional):
string
The first name of the person responsible for picking up the contents of this shipping group.
-
handlingInstructions(optional):
array handlingInstructions
Handling instructions.
-
id(optional):
string
The ID of this shipping group.
-
lastName(optional):
string
The second name of the person responsible for picking up the contents of this shipping group.
-
phoneNumber(optional):
string
The phone number of the person responsible for picking up the contents of this shipping group.
-
priceInfo(optional):
object priceInfo
The pricing details about this shipping group.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shipOnDate(optional):
string
The date this shipping group is expected to ship upon.
-
shippingAddress(optional):
object shippingAddress
The shipping address for this shipping group.
-
shippingGroupClassType(optional):
string
The class type for the ShippingGroup.
-
shippingMethod(optional):
string
The shipping method.
-
specialInstructions(optional):
object specialInstructions
Special instructions for the shipping group. Keys and values are strings.
-
state(optional):
string
The state of this shipping group.
-
stateDetail(optional):
string
Details about the state of this shipping group.
-
submittedDate(optional):
string
The date the shipping group was submitted.
-
trackingNumber(optional):
string
The tracking number.
Nested Schema : commerceItemRelationships
Type:
array
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order.
Show Source
Nested Schema : priceInfo
Type:
object
The pricing details about this shipping group.
Show Source
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts.
-
discounted(optional):
boolean
Whether this item is discounted.
-
rawShipping(optional):
number
The monetary amount of the cost of raw shipping.
-
secondaryCurrencyShippingAmount(optional):
number
The secondary currency shipping amount.
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount.
-
shippingTax(optional):
number
The shipping tax
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingAddress
Type:
object
The shipping address for this shipping group.
Show Source
-
address1(optional):
string
Address Line 1.
-
address2(optional):
string
Address Line 2.
-
address3(optional):
string
Address Line 3.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
Name of the county.
-
email(optional):
string
The email address
-
faxNumber(optional):
string
The fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
ownerId(optional):
string
The ID of the owner of this address.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Suffix.
Nested Schema : specialInstructions
Type:
object
Special instructions for the shipping group. Keys and values are strings.
Show Source
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
The monetary value.
-
availablePickupDate(optional):
string(date-time)
The items available store pickup date.
-
commerceItemExternalId(optional):
string
The referenced commerce item's external ID.
-
commerceItemId(optional):
string
The referenced commerce item's internal ID.
-
id(optional):
string
The native ID of this item.
-
inventoryLocationId(optional):
string
Defines the inventory location that services the referenced commerce item.
-
preferredPickupDate(optional):
string(date-time)
The items preferred store pickup date.
-
quantity(optional):
integer
The quantity of items referenced by this relationship.
-
range(optional):
object range
The range covered by these commerce items
-
relationshipType(optional):
string
The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.
-
returnedQuantity(optional):
integer
Number of referenced items that were returned.
-
state(optional):
string
Nested Schema : range
Type:
object
The range covered by these commerce items
Show Source
-
highBound(optional):
integer
The upper bound of the range.
-
lowBound(optional):
integer
The lower bound of the range, inclusive.
-
size(optional):
integer
The number of items in this range, inclusive.
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : miscTaxInfo
Type:
object
Nested Schema : parentOrganization
Type:
Show Source
object
-
active(optional):
boolean
-
approvalRequired(optional):
boolean
-
billingAddress(optional):
object return_address
-
contract(optional):
object contract
-
description(optional):
string
-
id(optional):
string
-
name(optional):
string
-
repositoryId(optional):
string
-
secondaryAddresses(optional):
object secondaryAddresses
-
shippingAddress(optional):
object return_address
Nested Schema : return_address
Type:
Show Source
object
-
address1(optional):
string
Address1 of the address
-
city(optional):
string
City of the address
-
country(optional):
string
Country of the address
-
firstName(optional):
string
First name
-
lastName(optional):
string
Last name
-
middleName(optional):
string
Middle name
-
postalCode(optional):
string
Postal Code of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
State of the address
Nested Schema : items
Type:
Show Source
object
-
membershipId(optional):
string
membershipId of the profile.
-
programId(optional):
string
programId of Loyalty Program
-
programName(optional):
string
programName of Loyalty Program
-
repositoryId(optional):
string
repository Id
-
status(optional):
string
status of Enrollment.
Nested Schema : returnItem_def
Type:
object
return Item
Show Source
- actualShippingRefundShare(optional): number
- actualTaxRefundShare(optional): number
-
catalogRefId(optional):
string
-
childReturnItems(optional):
array childReturnItems
List of child return Items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
-
childReturnItemsIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding childReturnItems property is truncated. The value for this field will be true always if present
-
commerceItemId(optional):
string
-
discription(optional):
string
-
disposition(optional):
string
-
itemCostAdjustments(optional):
array itemCostAdjustments
-
itemCurrencyCode(optional):
string
-
quantityAvailable(optional):
integer
-
quantityReceived(optional):
integer
-
quantityReturned(optional):
integer
-
quantityShipped(optional):
integer
-
quantityToExchange(optional):
integer
-
quantityToReturn(optional):
integer
-
refundAmount(optional):
number
-
returnItemId(optional):
string
-
returnReason(optional):
string
-
shippingGroupId(optional):
string
-
suggestedRefundAmount(optional):
number
- suggestedShippingRefundShare(optional): number
- suggestedTaxRefundShare(optional): number
Nested Schema : childReturnItems
Type:
array
List of child return Items. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
-
Array of:
object returnItem_def
return Item
Nested Schema : items
Type:
Show Source
object
-
amountAdjustment(optional):
number
-
commerceItemId(optional):
string
- manualAdjustmentShareAdjustment(optional): number
- orderDiscountShareAdjustment(optional): number
-
quantityAdjusted(optional):
integer
-
shippingGroupId(optional):
string
- shippingShareAdjustment(optional): number
- taxShareAdjustment(optional): number
Response
Supported Media Types
- application/json
200 Response
No response is returned as this is an event webhook