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

Description

The Shipment Notification message is triggered by receipt of an Order Shipped message.

Request

URLURL from associated message destination pipe
ParametersNameTypeRequiredDescriptionIndex
requestIdStringYUnique message identifier
sourceSystemIdStringYSystem initiating message (MessageDestination.providerCode)
destinationSystemIdStringY

EDGE Merchant identifier (MessageDestination.xRefMerchantId)


messageNameStringYFixed value "ShipmentNotification" will be sent 
shipmentGroupIdStringY

EDGE shipmentGroupID, should match the <ORDERSHIPREQUESTID> in the originating Sales Order message

Y
shippedDateTimeStringN

The UTC date and time when the order shipped. The ISO 8601  dateTime format (2019-05-01T01:12:34Z)


cartonsObject ArrayNArray of objects describing Carton details
• cartonIdNumberYCarton's number
• carrierStringYCarrier for shipment (Ex. UPS, FedEx)
• serviceStringYService level of shipment (UPS Ground, FedEx Ground)
• trackingNumberStringYTracking # for this carton
• freightChargeNumberYShipping cost for this carton
• weightNumberYWeight of this carton
• uccStringNUniform Commercial Code
• contentObject ArrayYArray of object describing the contents of the carton
• • orderShipmentIdNumberYReference to this shipment record.
• • skuStringYSKU number of the inventory item
• • quantityNumberYShipped quantity
• • detailsObject ArrayYArray of Objects describing the content
• • • lotNumberStringNLot Number of this content (lotNumber or serialNumber either one is required)
• • • serialNumberStringNSerial Number of this content (lotNumber or serialNumber either one is required)
• • • quantityNumberYThe quantity of the inventory item in this lot
Example
JSON
{  
   "requestId":"123123",
   "sourceSystemId":"3rdPartySystemId",
   "destinationSystemId":"JaggedPeakId",
   "messageName" : "ShipmentNotification",
   "shipmentGroupId":"2096A",
   "shippedDateTime":"2019-05-01T01:12:34Z",
   "cartons":[  
      {  
         "cartonId":1,
         "carrier":"UPS",
         "service":"UPS SurePost 1 lb or Greater",
         "trackingNumber":"1Z546R95YW00032100",
         "freightCharge":10.00,
         "weight":1.00,
         "ucc":"XDV-18704009",
         "content":[  
            {  
               "orderShipmentId":2157,
               "sku":"3780.10",
               "quantity":1,
               "details":[  
                  {  
                     "lotNumber":"7871986A",
                     "quantity":1
                  }
               ]
            }
         ]
      },
      {  
         "cartonId":2,
         "carrier":"UPS",
         "service":"UPS SurePost 1 lb or Greater",
         "trackingNumber":"1Z546R95YW00032100",
         "freightCharge":5.00,
         "weight":2.00,
         "ucc":"XDV-1870400Y",
         "content":[  
            {  
               "orderShipmentId":2154,
               "sku":"TestBTOKitSku1",
               "quantity":6,
               "details":[  
                  {  
                     "lotNumber":"7871986A",
                     "quantity":6
                  }
               ]
            },
            {  
               "orderShipmentId":2155,
               "sku":"TestBTOKitSku2",
               "quantity":10,
               "details":[  
                  {  
                     "lotNumber":"7871986C",
                     "quantity":5
                  },
                  {  
                     "lotNumber":"7871986D",
                     "quantity":5
                  }
               ]
            },
            {  
               "orderShipmentId":2156,
               "sku":"TestBTOKitSku3",
               "quantity":4,
               "details":[  
                  {  
                     "lotNumber":"7871986C",
                     "quantity":3
                  },
                  {  
                     "lotNumber":"7871986D",
                     "quantity":1
                  }
               ]
            }
         ]
      }
   ]
} 
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ShipmentNotificationRequest>
	<RequestId>101690</RequestId>
	<SourceSystemId>OMSJaggedPeakMerchant</SourceSystemId>
	<DestinationSystemId>WMSTestProvider</DestinationSystemId>
	<MessageName>ShipmentNotification</MessageName>
	<ShipmentGroupId>50003444A</ShipmentGroupId>
	<ShippedDateTime>2021-03-01T01:12:34Z</ShippedDateTime>
	<Cartons>
		<Carton>
			<CartonId>1</CartonId>
			<Carrier>UPS</Carrier>
			<Service>UPS GROUND</Service>
			<TrackingNumber>1Z546R95YW00032100</TrackingNumber>
			<FreightCharge>10.00</FreightCharge>
			<Weight>1.00</Weight>
			<UCC>XDV-18704009</UCC>
			<Contents>
				<Content>
					<OrderShipmentId>3076</OrderShipmentId>
					<SKU>PaymentSku_25</SKU>
					<Quantity>1</Quantity>
					<Details>
						<Detail>
							<LotNumber>7871986A</LotNumber>
							<Quantity>1</Quantity>
						</Detail>
					</Details>
				</Content>
			</Contents>
		</Carton>
	</Cartons>
</ShipmentNotificationRequest>

Response

ParametersNameTypeDescription
resultCodeStringOK or FAIL
resultMessageStringError description if an request failed
Example


Success
{
	"resultCode":"OK",
	"resultMessage":""
}
Failure
{  
   "resultCode":"FAIL",
   "resultMessage":"Error message here"
}
  • No labels