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

Description

The Inventory Advice message is an outbound message providing a third-party system with information about an inventory items 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 "InventoryAdvice" will be sent 
skuStringYSKU number of the inventory item
descriptionStringNSKU description of the inventory item
manufacturerPartNoStringNManufacturer’s part number
upcNumberStringNItem UPC number
legacyNumberStringN

Inventory item legacy number


uomNameStringNEDGE code indicating unit of measure for item
globalATPNumberNSum of ATP quantities (calculated regardless of the number of providers associated with the SKU. In other words, the value of Include All Providers does not affect global ATP)
providersObject ArrayYArray of objects containing providers associated with the item
• providerCodeStringYProviders assigned to the item
• onHandQtyNumberYTotal physical quantity existing at the distribution center. This includes allocated orders.
• onHoldQtyNumberYTotal physical quantity placed on hold at the distribution center. This quantity is not sellable.
• reservedQtyNumberYTotal quantity reserved in EDGE, which includes orders that were placed and allocated, exception orders as well as backordered.
• atpQtyNumberYAvailable To Promise. Quantity that is available to sell (OnHandQty – OnHoldQty – ReservedQty)
• safetyStockQtyNumberNAmount of inventory to reserve at the SKU/item level for situations such as in-store purchases, displays and sales.
• lotsObject ArrayNArray of objects containing lots associated with the provider
• • lotCodeStringY

Lot code associated with SKU


• • quantityNumberYQuantity from this lot
• • expirationDateStringYThe expiration date for the specified lot. Date and time in ISO 8601 format.
• • manufacturedDateStringYThe date items included in this lot were manufactured. Date and time in ISO 8601 format. 
Example
JSON
{
   "skus": [
      {
         "sku": "blacknight0",
         "description": "blacknight0",
         "manufacturerPartNo": "sku_0",
         "upcNumber": "1900000",
         "legacyNumber": "",
         "uomName": "test",
         "globalATP": 100,
         "providers": [
            {
               "providerCode": "JaggedPeak",
               "onHandQty": 100,
               "onHoldQty": 0,
               "reservedQty": 1,
               "atpQty": 99,
               "lots": [
                  {
                     "lotCode": "12345",
                     "quantity": 10,
                     "expirationDate": "2021-04-18",
                     "manufacturedDate": "2021-04-18"
                  }
               ]
            },
            {
               "providerCode": "ProviderFL",
               "onHandQty": 0,
               "onHoldQty": 0,
               "reservedQty": 0,
               "atpQty": 0,
               "lots": [
                  {
                     "lotCode": "12345",
                     "quantity": 10,
                     "expirationDate": "2021-04-18",
                     "manufacturedDate": "2021-04-18"
                  }
               ]
            }
         ]
      },
      {
         "sku": "BTS_Usage",
         "description": "BTS_Usage",
         "manufacturerPartNo": "",
         "legacyNumber": "",
         "uomName": "test",
         "globalATP": 100,
         "providers": [
            {
               "providerCode": "JaggedPeak",
               "onHandQty": 25,
               "onHoldQty": 0,
               "reservedQty": 0,
               "atpQty": 25,
               "lots": [
                  {
                     "lotCode": "12345",
                     "quantity": 10,
                     "expirationDate": "2021-04-18",
                     "manufacturedDate": "2021-04-18"
                  }
               ]
            }
         ]
      }
   ],
   "requestId": "101833",
   "sourceSystemId": "OMSJaggedPeakMerchant",
   "destinationSystemId": "WMSTestProvider",
   "messageName": "InventoryAdvice"
}
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<InventoryAdviceRequest>
	<RequestId>101833</RequestId>
	<SourceSystemId>OMSJaggedPeakMerchant</SourceSystemId>
	<DestinationSystemId>WMSTestProvider</DestinationSystemId>
	<MessageName>InventoryAdvice</MessageName>
	<SKUs>
		<SKU>
			<SKU>blacknight0</SKU>
			<Description>blacknight0</Description>
			<ManufacturerPartNo>sku_0</ManufacturerPartNo>
			<UPCNumber>1900000</UPCNumber>
			<LegacyNumber/>
			<UOMName>test</UOMName>
			<GlobalATP>100</GlobalATP>
			<Providers>
				<Provider>
					<ProviderCode>JaggedPeak</ProviderCode>
					<OnHandQty>100</OnHandQty>
					<OnHoldQty>0</OnHoldQty>
					<ReservedQty>1</ReservedQty>
					<ATPQty>99</ATPQty>
					<Lots>
						<Lot>
							<LotCode>12345</LotCode>
							<Quantity>10</Quantity>
							<ExpirationDate>2021-04-18</ExpirationDate>
							<ManufacturedDate>2021-04-18</ManufacturedDate>
						</Lot>
					</Lots>
				</Provider>
				<Provider>
					<ProviderCode>ProviderFL</ProviderCode>
					<OnHandQty>0</OnHandQty>
					<OnHoldQty>0</OnHoldQty>
					<ReservedQty>0</ReservedQty>
					<ATPQty>0</ATPQty>
					<Lots>
						<Lot>
							<LotCode>12345</LotCode>
							<Quantity>10</Quantity>
							<ExpirationDate>2021-04-18</ExpirationDate>
							<ManufacturedDate>2021-04-18</ManufacturedDate>
						</Lot>
					</Lots>
				</Provider>
			</Providers>
		</SKU>
		<SKU>
			<SKU>BTS_Usage</SKU>
			<Description>BTS_Usage</Description>
			<ManufacturerPartNo/>
			<LegacyNumber/>
			<UOMName>test</UOMName>
			<GlobalATP>100</GlobalATP>
			<Providers>
				<Provider>
					<ProviderCode>JaggedPeak</ProviderCode>
					<OnHandQty>25</OnHandQty>
					<OnHoldQty>0</OnHoldQty>
					<ReservedQty>0</ReservedQty>
					<ATPQty>25</ATPQty>
					<Lots>
						<Lot>
							<LotCode>12345</LotCode>
							<Quantity>10</Quantity>
							<ExpirationDate>2021-04-18</ExpirationDate>
							<ManufacturedDate>2021-04-18</ManufacturedDate>
						</Lot>
					</Lots>
				</Provider>
			</Providers>
		</SKU>
	</SKUs>
</InventoryAdviceRequest>

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