Dispatch Item

Dispatch item provides access to the item level of the dispatch resource. This is currently a read only resource.

DispatchItem Properties

Property	Example	Description	Allowed in Order POST
id	"847CFD..."	Unique id for the order item	No
fk_dispatch	"B56919..."	Foreign key to the related dispatch	No
fk_orderItemRef	"FAC105..."	The foriegn key to the related order item	Yes mandatory
description	"line description"	A description for the line	Yes optional
dispatchQty	1	The quantity being dispatched for the line	Yes mandatory
cancelQty	0	The quantity being cancelled for the line	Yes optional

Dispatch Item Methods

GET	/api/dispatchitem?fk_dispatch=B569198A1370DE47B4B30E8761C01582

Returns all dispatch items for the specified dispatch.

Q. Why no POST option. A. All items must be sent as part of the dispatch message.

Example

Example of a returned dispatch item entity

{
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 1,
        "recordsFound": 1,
        "orderItem": [
            {
                "id": "847CFD2E5C17A34295288BEBC9331F2E",
                "fk_dispatch": "B569198A1370DE47B4B30E8761C01582",
                "fk_orderItemRef": "FAC10544B2ABCD45BCC6138FC20C3300",
                "description": "",
                "dispatchQty": 1,
                "cancelQty": 0
                "dispatchItem_dispatch": {
                    "id": "788F9E86F23B0A46B458983FB1B5AA38",
                    "fk_orderRef": "A0E87AE771BAC84DBA994FEC70537912",
                    "type": "Retail",
                    "dispatchDate": "2022-01-10T12:43:22",
                    "carrier": "UK48HR",
                    "trackingRef": "XX1234567",
                    "detail": {}
                }
            }
        ]
    }
}