DN Import API

DN is the abbreviation of Delivery Notification. This article introduces the general DN Import API use case for easily understanding and applying this API.

Introduction

DN Import API is designed to facility the import of outbound ASNs (Advanced Shipping Notices) into the WISE system, ensuring seamless integration with the WMS and accurate transfer of outbound shipment information for the efficient processing.

API Request

API: POST /edi/outbound/order

Body Request:

Main Fields

	FieldName	Description	DataType	Length	Required	Version	Sample
Root
1	CompanyID	Hard code, assigned by UNIS system admin.	string	15	Yes	1.2	"LT"
2	CustomerID	Hard code, assigned by UNIS accounting dept.	string	15	Yes	1.2	"AUKINT0001"
3	FacilityID	Indicates which warehouse UNIS ship from. It should be assigned by UNIS CSR	string	15	yes	1.2	"889"
4	POContent (opens in a new tab)		object		yes	1.2
5	TitleID	TitleID which setup under Customer	string		no	1.3	""

POContent Fields

	FieldName	Description	DataType	Length	Required	Version	Sample
Root
4.1	ReferenceNo	An unique identifier to indicate an order.	string	50	Yes	1.2	"Roy022501-3"
4.2	PONo	Your customer's Purchse Order Number, doesn't need to be unique.	string	50	No	1.2	"8957515451-3"
4.3	CustomerSONo	Your Sales Order Number, doesn't need to be unique.	string	50	No	1.2
4.4	BatchNo	Indicate a set of orders submitted to UNIS system in one batch. It supports searching by BatchNo to pull acknowledgments.	string	50	No	1.2
4.5	BOLNo	The bill of lading (BOL), can be provided by you. Or UNIS will generate its own BOL# when the shipment is ready to go.	string	50	No	1.2
4.6	ReferenceNo01	Indicates the shipment requiring a signature (empty means no signature is required).	string	50	No	1.2
4.7	ReferenceNo02	Indicates the shipment requiring a signature (empty means no signature is required).	string	50	No	1.2	"129459142"
4.8	ReferenceNo03	Indicates the shipment requiring a signature (empty means no signature is required).	string	50	No	1.2	"AUKINT0001"
4.9	ReferenceNo04	Indicates the shipment requiring a signature (empty means no signature is required).	string	50	No	1.2
4.1	ReferenceNo05	Indicates the shipment requiring a signature (empty means no signature is required).	string	50	No	1.2
4.11	OrderedDate	Order placed date	datetime		No	1.2	"20191224121008"
4.12	ScheduledDate	Scheduled shipping date	datetime		No	1.2	"20991231070000"
4.13	CanceledDate	Order canceled date	datetime		No	1.2
4.14	ShipNotBefore	Ship not before datetime	datetime		No	1.2
4.15	ShipNoLater	Ship not later than datetime	datetime		No	1.2
4.16	MABD	Must Arrive by Date	datetime		No	1.2	"20991231070000"
4.17	RoutedDate	Applies to LTL shipments only.	datetime		No	1.2
4.18	ReferenceDate01		datetime		No	1.2
4.19	ReferenceDate02		datetime		No	1.2
4.20	Address (opens in a new tab)		object		No	1.2
4.21	ShippingInfo (opens in a new tab)		object		Yes	1.2
4.22	OrderTotal (opens in a new tab)		object		No	1.2
4.23	OrderNotes (opens in a new tab)		object		No	1.2
4.24	Items (opens in a new tab)		object		Yes	1.2
4.25	CTN (opens in a new tab)	For Transload Order only. Provide Carton Level information if the UNIS operation team is to pick by specific CartonNo.	object		No	1.2
4.26	Status	Indicates creation of a new order. Supported Value: "Imported" to create a new order or update an existing order with status "Imported" or "Open".	string	20	Yes	1.3.1	"Imported"
4.27	IncoTerm	IncoTerm	string	50	No	1.3.1	"DDP"
4.28	RetailerName	Retailer	string	50	No	1.3.1
4.29	RetailerAuthorizationNumber	Retailer Authorization Number	string	50	No	1.3.1
4.30	BusinessType	Business Type	string	50	No	1.4	Available Options: B2B B2C Small Parcel
4.31	SubOrderType	Sub Order Type	string	50	No	1.4
4.32	PackNote	Packing Note	string	100	No	1.4
4.33	IsRush	Rush Order	bool		No	1.4	Options: true, false
4.34	DataChannel	Data Channel	string		No	1.4	Channel from which DN originates, e.g., AMAZON_FBA, WALMART
4.35	DataChannelAccount	Data Channel Account	string		No	1.4	If a channel has multiple accounts, set the account alias to target the specific account, e.g., Amazon Account1, Amazon Account2

Address Fields

	FieldName	Description	DataType	Length	Required	Version	Sample
Root
4.20.1	SoldToName	The sold-to party is the party that places the order and to whom sales and product prices are recorded against	string	50	No	1.2	"US FOODS"
4.20.2	SoldToAddress1	Sold-to party's address 1	string	50	No	1.2	"134 SHUMA DRIVE ADMINI BLDG"
4.20.3	SoldToAddress2	Sold-to party's address 2	string	50	No	1.2
4.20.4	SoldToCity	Sold-to party's city	string	50	No	1.2	"ALTOONA"
4.20.5	SoldToState	Sold-to party's state	string	50	No	1.2	"PA"
4.20.6	SoldToZipCode	Sold-to party's zip code	string	50	No	1.2	"16601"
4.20.7	SoldToCountry	Sold-to party's country	string	50	No	1.2
4.20.8	SoldToContact	Sold-to party's contact	string	50	No	1.2
4.20.9	SoldToPhone	Sold-to party's phone number	string	50	No	1.2
4.20.10	SoldToExtension	Sold-to party's phone extension	string	50	No	1.2
4.20.11	SoldToFax	Sold-to party's fax	string	50	No	1.2
4.20.12	SoldToEmail	Sold-to party's email address	string	50	No	1.2
4.20.13	ShipToName	The ship-to party is the party to whom the order is shipped.	string	50	Yes	1.2	"US FOODS"
4.20.14	ShipToAddress1	Ship-to party's address 1	string	50	Yes	1.2	"134 SHUMA DRIVE ADMINI BLDG"
4.20.15	ShipToAddress2	Ship-to party's address 2	string	50	No	1.2
4.20.16	ShipToCity	Ship-to party's city	string	50	Yes	1.2	"ALTOONA"
4.20.17	ShipToState	Ship-to party's state	string	50	Yes	1.2	"PA"
4.20.18	ShipToZipCode	Ship-to party's zip code	string	50	Yes	1.2	"16601"
4.20.19	ShipToCountry	Ship-to party's country	string	50	Yes	1.2	"US"
4.20.20	ShipToContact	Ship-to party's contact, will be saved as default address name	string	50	No	1.2
4.20.21	ShipToPhone	Ship-to party's phone number	string	15	No	1.2
4.20.22	ShipToExtension	Ship-to party's phone extension	string	15	No	1.2
4.20.23	ShipToFax	Ship-to party's fax	string	15	No	1.2
4.20.24	ShipToEmail	Ship-to party's email address	string	50	No	1.2
4.20.25	ShipToStoreNo	If ship to retailer store, you can put the StoreNo as indicator.	string	30	No	1.2
4.20.26	ShipToBatchCode	Apply to LTL shipments only. Issued by retailer.	string	15	No	1.2
4.20.27	ShipToHome	It is usually used to indicate the ship to address is Commercial or Residential (true means Residential, false or blank means Commercial).	boolean	-	No	1.2
4.20.28	ShipToOrganization	For Ship to company, etc.	string	50	No	1.4
4.20.29	StoreName	Apply to LTL order, ship through consolidation center.	string	50	No	1.2
4.20.30	StoreAddress1	Final Destination store's address	string	50	No	1.2
4.20.31	StoreAddress2	Final Destination store's address	string	50	No	1.2
4.20.32	StoreCity	Final Destination store's city	string	50	No	1.2
4.20.33	StoreState	Final Destination store's state	string	50	No	1.2
4.20.34	StoreZipCode	Final Destination store's Zipcode	string	50	No	1.2
4.20.35	StoreCountry	Final Destination store's Country	string	50	No	1.2
4.20.36	StoreContact	Final Destination store's Contact	string	50	No	1.2
4.20.37	StorePhone	Final Destination store's Phone	string	15	No	1.2
4.20.38	StoreExtension	Final Destination store's Extension	string	15	No	1.2
4.20.39	StoreFax	Final Destination store's Fax	string	15	No	1.2
4.20.40	StoreEmail	Final Destination store's Email	string	15	No	1.2
4.20.41	StoreStoreNo	Final Destination store's StoreNo	string	15	No	1.2
4.20.42	BillToName	The bill-to is the party to whom the freight bill is sent.	string	50	No	1.2
4.20.43	BillToAddress1	Bill-to party's address 1	string	50	No	1.2
4.20.44	BillToAddress2	Bill-to party's address 2	string	50	No	1.2
4.20.45	BillToCity	Bill-to party's city	string	50	No	1.2
4.20.46	BillToState	Bill-to party's state	string	50	No	1.2
4.20.47	BillToZipCode	Bill-to party's zip code	string	50	No	1.2
4.20.48	BillToCountry	Bill-to party's country	string	50	No	1.2
4.20.49	BillToContact	Bill-to party's contact	string	50	No	1.2
4.20.50	BillToPhone	Bill-to party's phone number	string	15	No	1.2
4.20.51	BillToExtension	Bill-to party's phone extension	string	15	No	1.2
4.20.52	BillToFax	Bill-to party's fax	string	15	No	1.2
4.20.53	BillToEmail	Bill-to party's email address	string	50	No	1.2
4.20.54	BillToStoreNo	Bill-to party's Store Number	string	30	No	1.2
4.20.55	BillToBatchCode	ignore	string	15	No	1.2
4.20.56	BillToHome	ignore	bit	1	No	1.2

ShippingInfo Fields

	FieldName	Description	DataType	Length	Required	Version	Sample
Root
4.21.1	FreightTerm	CC - Collect PP - Prepaid (by Seller) TP - Third Party Pay, If Freight Term is TP, the Shipping Account Number is required.	string	15	Yes	1.2	PP
4.21.2	ShipMethod	M - Truckload L - LTL U - Small Parcel (default value) W - Will Call NA - Unknown	string	3	Yes	1.2	U
4.21.3	DeliveryService	Carrier's standard service level. Supported value are: Saver, Ground (Default), Two Day, One Day, 3 days. Refer to attachment for details.	string	50	No	1.2
4.21.4	SCACCode	It is a privately controlled US code used to identify vessel operating common carriers (VOCC). It is typically two to four letters long. Apply to LTL only.	string	15	No	1.2
4.21.5	CarrierName	Carrier's standard service level. As for small parcel carriers, supported values are: FedEx, USPS, UPS, DHL, Endicia.	string	15	No	1.2
4.21.6	ShippingAccountNo	If Freight Term is TP, the Shipping Account Number is required.	string	15	No	1.2
4.21.7	ContainerSize	Apply to LTL shipments only.	string	100	No	1.2
4.21.8	SignatureType	Leave it blank if no signature needed Available: ADULT DIRECT INDIRECT	string	15	No	1.4

OrderTotal Fields

	FieldName	Description	DataType	Required	Version
Root
4.22.1	TotalWeight	Total Weight	Decimal	No	1.2
4.22.2	TotalCbft	Total Cubic Feet	Decimal	No	1.2

OrderNotes Fields

	FieldName	Description	DataType	Length	Required	Version	Sample
Root
4.23.1	Note	Notes for Warehouse Instructions	string	4000	No	1.2
4.23.2	BOLNote	Bill of Lading instructions, will be shown on the BOL, instruction section.	string	4000	No	1.2
4.23.3	LabelNote	Packing List Notes, will be shown on the Packing List Notes section.	string	250	No	1.2
4.23.4	MISC01	Customized field 01	string	100	No	1.2
4.23.5	MISC02	Customized field 02	string	100	No	1.2
4.23.6	MISC03	Customized field 03	string	100	No	1.2
4.23.7	MISC04	Customized field 04	string	100	No	1.2
4.23.8	MISC05	Customized field 05	string	100	No	1.2
4.23.9	MISC06	Customized field 06	string	100	No	1.2
4.23.10	MISC07	Customized field 07	string	100	No	1.2
4.23.11	MISC08	Customized field 08	string	100	No	1.2
4.23.12	MISC09	Customized field 09	string	100	No	1.2
4.23.13	MISC10	Customized field 10	string	100	No	1.2
4.23.14	OrderType		string	100	No	1.2	"940"
4.23.15	LabelCode	Apply to the order requiring retailer's Carton UCC or Pallet UCC labels.	string	100	No	1.2
4.23.16	ShippingInstructions	Will be shown on WISE order page.	string	1000	No	1.2	"E&O"
4.23.17	DeliveryInstructions	Will be shown on WISE order page.	string	1000	No	1.2

Items Fields

	FieldName	Description	DataType	Length	Required	Version	Sample
Root
4.24.1	LineNo	You can pass in a unique number for each ItemLine, it will be returned on the DC(Delivery Confirmation) calls.	int		No	1.2	"1"
4.24.2	SupplierID	A party that supplies goods. If you did not set multiple suppliers with UNIS, you can ignore this field.	string	15	No	1.2
4.24.3	ItemID	Your unique Item SKU#.	string	30	Yes	1.2	"5CB0Z21087"
4.24.4	BuyerItemID	Buyer's item ID. Usualy is retailer's model number or item number. If you don't have it, you can ignore.	string	30	No	1.2
4.24.5	LotNo	A lot number is an identification number assigned to a particular quantity or lot of material from a single manufacturer. Please only provide LotNo when you want UNIS operation team to pick by this particular LotNo.	string	30	No	1.2
4.24.6	OrderedQty	The ordered qty, must be based on the value on the UOM section.	int		Yes	1.2	1
4.24.7	UnitPrice	Unit sales price, if you don't require EDI810 from UNIS, you can ignore.	Decimal		No	1.2
4.24.8	PrePackQty	If your channels or retailers doesn't require for particular pack Qty, you can ignore.	int		No	1.2
4.24.9	PrePackDescription	If your channels or retailers doesn't require for particular pack description, you can ignore.	string	100	No	1.2
4.24.10	PoundPerPackage		Decimal		No	1.2
4.24.11	Length		Decimal		No	1.2
4.24.12	Width		Decimal		No	1.2
4.24.13	Height		Decimal		No	1.2
4.24.14	CustomerPallets	Customer pallet quantity	Decimal		No	1.2
4.24.15	PalletWeight		Decimal		No	1.2
4.24.16	ItemNote	Notes will be shown on the order page, itemline section.	string	100	No	1.2
4.24.17	UPCCode	UPC consists of 12 numeric digits that are uniquely assigned to each trade item.	string	100	No	1.2
4.24.18	PackageConfigure	If your channels or retailers doesn't require for particular Package Configure, you can ignore.	string	100	No	1.2
4.24.19	UOM	Supported Value: EA = Units/Each CS= Case	string	10	No	1.2
4.24.20	DTLMISC01	Customized field 01	string	100	No	1.2
4.24.21	DTLMISC02	Customized field 02	string	100	No	1.2
4.24.22	DTLMISC03	Customized field 03	string	100	No	1.2
4.24.23	DTLMISC04	Customized field 04	string	100	No	1.2
4.24.24	DTLMISC05	Customized field 05	string	100	No	1.2
4.24.25	DTLMISC06	Customized field 06	string	100	No	1.2
4.24.26	DTLMISC07	Customized field 07	string	100	No	1.2
4.24.27	DTLMISC08	Customized field 08	string	100	No	1.2
4.24.28	DTLMISC09	Customized field 09	string	100	No	1.2
4.24.29	OriginalItemProductNumber		string	100	No	1.2	"00HW022"
4.24.30	ReturnLabel	Indicates whether return label is required				1.2	"Y", "N"
4.24.31	DTLMISC10	Customized field 10	string	100	No	1.2
4.24.32	DTLMISC11	Customized field 11	string	100	No	1.2
4.24.33	DTLMISC12	Customized field 12	string	100	No	1.2
4.24.34	DTLMISC13	Customized field 13	string	100	No	1.2
4.24.35	DTLMISC14	Customized field 14	string	100	No	1.2
4.24.36	DTLMISC15	Customized field 15	string	100	No	1.2
4.24.37	DTLMISC16	Customized field 16	string	100	No	1.2
4.24.38	DTLMISC17	Customized field 17	string	100	No	1.2
4.24.39	DTLMISC18	Customized field 18	string	100	No	1.2
4.24.40	DTLMISC19	Customized field 19	string	100	No	1.2
4.24.41	DTLMISC20	Customized field 20	string	100	No	1.2
4.24.42	UnitPriceCurrency	Unit Price Currency, ISO 4217 Default: USD	string	10	No	1.2
4.24.43	GoodsType	Goods type which defined by customer	string	10	No	1.4
4.24.44	TitleID	TitleID which setup under Customer	string		No	1.4

CTN Fields

	FieldName	DataType	Length	Required	Version
Root
4.25.1	CartonNo	string	50	No	1.2
4.25.2	PoundPerCarton	Decimal		No	1.2

API Return

This section introduces the parameters which from DN import result.

	FieldName	Description	DataType	Length	Version	Sample
Root
1	CustomerID	Customer Id	string	15	1.2	"AUKINT0001"
2	PONo	PO Number	string	50	1.2
3	ReferenceNo	Reference Number	string	50	1.2	"1209129"
4	WISEPOID	WISE Order Id	string	50	1.2	"DN-94776"
5	Status	Result Status	string	30	1.2	"Warning"
6	Error	Error Message	string	1000	1.2

Example

Request

This example explains importing DN via API to #889 facility, the target customer is AUKINT001. More details about the order are listed in the body parameters.

  // Url 
  POST http://preview.logisticsteam.com/shared/bam/v1/public/edi/outbound/order
  
  // Body
  {
    "CompanyID": "LT",
    "CustomerID": "AUKINT0001",
    "FacilityID": "889",
    "POContent": {
      "PONo": "8957515451-3",
      "ReferenceNo": "Roy022501-3",
      "ReferenceNo02": "129459142",
      "ReferenceNo03": "AUKINT0001",
      "OrderedDate": "20191224121008",
      "CanceledDate": "20191224121008",
      "MABD": "20991231070000",
      "Address": {
        "SoldToName": "US FOODS",
        "SoldToAddress1": "134 SHUMA DRIVE ADMINI BLDG",
        "SoldToCity": "ALTOONA",
        "SoldToState": "PA",
        "SoldToZipCode": "16601",
        "SoldToCountry": "CA",
        "SoldToContact": "US00000001",
        "SoldToPhone": "8149402164",
        "SoldToEmail": "chris.storm@usfoods.com",
        "ShipToName": "US FOODS",
        "ShipToAddress1": "134 SHUMA DRIVE ADMINI BLDG",
        "ShipToCity": "ALTOONA",
        "ShipToState": "PA",
        "ShipToZipCode": "16601",
        "ShipToCountry": "US",
        "ShipToContact": "CHRISTOPHER STORM",
        "ShipToPhone": "8149402164",
        "ShipToEmail": "chris.storm@usfoods.com",
        "ShipToStoreNo": "US00000001"
      },
      "ShippingInfo": {
        "FreightTerm": "PP",
        "ShipMethod": "Small Parcel",
        "SCACCode": "FEDEX",
        "DeliveryService": "SBD,"
      },
      "OrderTotal": {},
      "OrderNotes": {
        "MISC01": "M",
        "MISC02": "POPT",
        "MISC03": "S1",
        "MISC05": "N",
        "MISC06": "FEDEX",
        "MISC07": "STST",
        "MISC08": "IG-60028602",
        "OrderType": "940",
        "ShippingInstructions": "E&O"
      },
      "Items": [
        {
          "LineNo": "1",
          "ItemID": "5CB0Z21087",
          "ItemNumber": "5CB0Z21087",
          "UOM": "EA",
          "OrderedQty": "1",
          "DTLMISC01": "000010",
          "DTLMISC02": "Roy02190901",
          "DTLMISC03": "4807729019,000010",
          "DTLMISC04": "Roy021907",
          "DTLMISC05": "1",
          "DTLMISC06": "U402",
          "DTLMISC07": "1021",
          "DTLMISC08": "H021,",
          "DTLMISC09": "20JT,",
          "DTLMISC10": "R02060201",
          "mergeItemByEDI": "1|01FR111|1",
          "OriginalItemProductNumber": "00HW022",
          "ReturnLabel": "N",
          "DTLMISC11": "1210193450",
          "DTLMISC12": "30001234"
        },
        {
          "LineNo": "2",
          "ItemID": "5CB0Z21087-1",
          "ItemNumber": "5CB0Z21087",
          "UOM": "EA",
          "OrderedQty": "1",
          "DTLMISC01": "000010",
          "DTLMISC02": "Roy02190901",
          "DTLMISC03": "4807729019,000010",
          "DTLMISC04": "Roy021907",
          "DTLMISC05": "1",
          "DTLMISC06": "U402",
          "DTLMISC07": "1021",
          "DTLMISC08": "H021,",
          "DTLMISC09": "20JT,",
          "DTLMISC10": "R02060201",
          "mergeItemByEDI": "1|01FR111|1",
          "OriginalItemProductNumber": "00HW022",
          "ReturnLabel": "N",
          "DTLMISC11": "1210193450",
          "DTLMISC12": "30001234"
        }
      ],
      "Status": "Imported",
      "RetailerName": ""
    }
  }

Response

  // Success return
  {
     "Orders": [{
        "CustomerId": "AUKINT0001",
        "PONo": "",
        "ReferenceNo": "1209129",
        "WISEPOID": "DN-94776",
        "Status": "Success",
        "Error": "...."
     }]
  }

// Failed return
  {
  	"Orders": [{
  		"Error": "....",
  		"Status": "Fail"
  	}]
  }

Outbound API DN Cancellation