Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This message is created and sent as an outbound message when an exception order is cancelled in EDGE.

Request

URLURL from associated message destination pipe
ParametersNameTypeRequiredDescriptionIndex
requestIdStringYUnique message identifier
sourceSystemIdStringYEDGE Merchant identifier (MessageDestination.xRefMerchantId)
destinationSystemIdStringY

System initiating message (MessageDestination.providerCode)


messageNameStringYFixed value "CancelExceptionOrder" will be sent 
orderHeaderIdNumberYOrder identifierY
cancelDateStringYCancellation date  in ISO 8601 format
clientReferenceStringNOrder client reference Y
itemsObject ArrayYArray of objects containing cancelled items 
• quantityNumberYCancelled quantity
• skuStringYSKU associated with catalog item
• originalQuantityNumberYOriginal quantity 
Example
Code Block
languagejs
titleJSON
{
   "orderHeaderId": 50003391,
   "cancelDate": "2021-03-31",
   "clientReference": "autoship_118",
   "items": [
      {
         "sku": "Abyss106",
         "quantity": 3,
         "originalQuantity": 3
      }
   ],
   "requestId": "101696",
   "sourceSystemId": "OMSJaggedPeakMerchant",
   "destinationSystemId": "WMSTestProvider",
   "messageName": "CancelExceptionOrder"
}
Code Block
languagexml
titleXML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CancelExceptionOrderRequest>
	<RequestId>101696</RequestId>
	<SourceSystemId>OMSJaggedPeakMerchant</SourceSystemId>
	<DestinationSystemId>WMSTestProvider</DestinationSystemId>
	<MessageName>CancelExceptionOrder</MessageName>
	<OrderHeaderId>50003391</OrderHeaderId>
	<CancelDate>2021-03-31</CancelDate>
	<ClientReference>autoship_118</ClientReference>
	<Items>
		<Item>
			<SKU>Abyss106</SKU>
			<Quantity>3</Quantity>
			<OriginalQuantity>3</OriginalQuantity>
		</Item>
	</Items>
</CancelExceptionOrderRequest>


Response

ParametersNameTypeDescription
resultCodeStringOK or FAIL
resultMessageStringError description if an request failed
Example


Code Block
languagejs
titleSuccess
{
	"resultCode":"OK",
	"resultMessage":""
}
Example
Code Block
languagejs
titleFailure
{  
   "resultCode":"FAIL",
   "resultMessage":"Error message here."
}

...