Page tree
Skip to end of metadata
Go to start of metadata

Description

This message is created and sent as an outbound message when a back 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 "CancelBackorder" 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
JSON
{
   "orderHeaderId": 50003391,
   "cancelDate": "2021-03-31",
   "clientReference": "autoship_118",
   "items": [
      {
         "sku": "Abyss106",
         "quantity": 3,
         "originalQuantity": 3
      }
   ],
   "requestId": "101696",
   "sourceSystemId": "OMSJaggedPeakMerchant",
   "destinationSystemId": "WMSTestProvider",
   "messageName": "CancelBackorder"
}
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CancelBackorderRequest>
	<RequestId>101696</RequestId>
	<SourceSystemId>OMSJaggedPeakMerchant</SourceSystemId>
	<DestinationSystemId>WMSTestProvider</DestinationSystemId>
	<MessageName>CancelBackorder</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>
</CancelBackorderRequest>


Response

ParametersNameTypeDescription
resultCodeStringOK or FAIL
resultMessageStringError description if an request failed
Example


Success
{
	"resultCode":"OK",
	"resultMessage":""
}
Example
Failure
{  
   "resultCode":"FAIL",
   "resultMessage":"Error message here."
}



  • No labels