Ship Doc

Ship Doc Object

Ship Doc is a transaction involved in the sales cycle.    Like all transactions it is comprised of a Doc portion (Ship Doc) and one or more Line Items (ShipDocLineItem).  ShipDocLineItem may optionally include one or mode Details.    

• End Point
• Properties - Ship Doc
• Properties - Ship Doc Line Item
• Properties - Ship Doc Line Item Details
• Json Sample

End Point

/shipdoc

GET, POST, PUT,  DELETE

GET and DELETE requests expect parameter docNo of type Int32.

Properties - Ship Doc

Properties - Ship Doc Line Item

Properties - Ship Doc Line Item - Details

The Details node is comprised of Line Item Details.   If you have used the Form Designer,  you know that you can add details to show the Bins and Lot or Serial No data for inventoried items.   Only inventoried items comprising of Part and Assembly items need Details.   Details for non-inventoried items will be ignored.     You only need to include Details if you want to specifically identify the bins and / or lot and serial numbers being included,  otherwise you can omit the Details section and Order Time will automatically fill the ship doc line item with available inventory ¹.   If you include Details for one Ship Doc Line item then you must do so for all inventoried Ship Doc Line Items and visa versa.  You cannot have some inventoried Ship Doc Line Items with Details and some without.   

Line Item Details are comprised of an Array of FillBinBase.     FillBinBase can morph into either FillBin or DocFillLotOrSerial.  DocFillLotOrSerial is used when the item has TrackLotOrSerial set to true and FillBin is used otherwise. 

Json Sample

{
    "CustomerRef": {
        "Id": 32
    },
    "ShipToRef": {
        "Id": 1
    },
    "Date": "2018-11-05T00:00:00",
    "LineItems": [
        {
            "$type": "AOLib7.ShipDocLineItem, AOLib7",
            "ItemRef": {
                "Id": 30
            },
            "LineNo": 1,
            "Quantity": 2,
            "LinkedInfo": {
                "LineNo": 1,
                "PromiseDate": "2018-11-14T00:00:00",
                "DocNo": 18,
                "TranType": 7
            },
            "Details": [
                {
                    "$type": "AOLib7.FillBin, AOLib7",
                   
		    "ItemRef": {
			"Id": 30
		    },
                    "BinRef": {
                        "Id": 8,
                        "Name": "Floor"
                    },
                    "Quantity": 2
                    
                }
                ],
            "CustomFields": []
        },
        {
            "$type": "AOLib7.ShipDocLineItem, AOLib7",
            "Id": 33,
            "ItemRef": {
                "Id": 37
            },
            "Quantity": 1,
            "LinkedInfo": {
                "LineNo": 2,
                "PromiseDate": "2018-11-14T00:00:00",
                "DocNo": 18,
                "TranType": 7
            }, 
            "Details": [
               
                {
                    "$type": "AOLib7.DocFillLotOrSerial, AOLib7",
		    "ItemRef": {
                	"Id": 37
            	     },
                    "BinRef": {
                        "Id": 8,
                        "Name": "Floor"
                    },
                    "Quantity": 1,
                    "LotOrSerialNo": "1253215235"
                }
                ]
           
        }
    ],
    "StatusRef": {
        "Id": 0,
        "Name": "Shipped"
    },
     "LocationRef": {
        "Id": 10,
        "Name": "HQ"
    }
}

Top

^{1 - When Details are not included Order Time will attempt to fill the sales order using its business rules and Company Preferences.}