Ongoing Warehouse logo

Ongoing Warehouse Developer

CreateOrderPalletItem

This function allows you to create pallet items on orders.

This might be used in combination with the Pack operation when packing an order or to add package numbers to an order with the purpose of shipment tracking.

Tags: CreateOrderPalletItem, Operation, CreateOrderPalletItemResult, CreateOrderPalletItemError, CreatedPalletItem

Request XML

POST /xxx/automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/CreateOrderPalletItem"

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <CreateOrderPalletItem xmlns="http://ongoingsystems.se/Automation">
            <UserName>string</UserName>
            <Password>string</Password>
            <Operation>
                <OrderId>int</OrderId>
                <PalletType>
                    <PalletTypeCode>string</PalletTypeCode>
                    <PalletTypeName>string</PalletTypeName>
                    <PalletTypeId>int</PalletTypeId>
                    <Identification>PalletTypeId or PalletTypeCode</Identification>
                </PalletType>
                <LabelId>string</LabelId>
                <Serial>string</Serial>
                <Comment>string</Comment>
                <Weight>decimal</Weight>
                <Volume>decimal</Volume>
                <Length>decimal</Length>
                <Width>decimal</Width>
                <Height>decimal</Height>
                <LoadMeters>decimal</LoadMeters>
                <ParentPalletItemId>int</ParentPalletItemId>
                <TransportAdministrationType>None or Return or Delivery</TransportAdministrationType>
            </Operation>
        </CreateOrderPalletItem>
    </soap:Body>
</soap:Envelope>
+

Request specification

CreateOrderPalletItem
UserName str(50) Req. Your username
Password str(50) Req. Your password
Operation object Req. An element of type Operation.
Operation
OrderId int Req. The order id of the order to connect the pallet item to.
PalletType object Req. An element of type PalletType.
LabelId str(30) Optional The pallet item label. Usually SSCC or some other kind of serial number.
Serial str(100) Optional Secondary serial number. It is usually preferred to use LabelId.
Comment str(300) Optional An optional comment.
Weight decimal Optional The weight of the pallet item in kilograms (Kg).
Volume decimal Optional The volume of the pallet item in qubic meters (m3).
Length decimal Optional The Length of the pallet item in meters (m).
Width decimal Optional The Width of the pallet item in meters (m).
Height decimal Optional The Height of the pallet item in meters (m).
LoadMeters decimal Optional The load meters of the pallet item
ParentPalletItemId int Optional The pallet item id of the parent of this pallet item. Can be used for e.g. packages that is being placed on a pallet.
TransportAdministrationType str Req. Determines if the pallet item is used as a transport administration pallet item that contains package number for shipping purposes:
- None
- Return
- Deliver

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <CreateOrderPalletItemResponse xmlns="http://ongoingsystems.se/Automation">
            <CreateOrderPalletItemResult>
                <Errors>
                    <CreateOrderPalletItemError>
                        <Message>string</Message>
                        <ErrorType>UnknownError or LogonError or GoodsOwnerIsDeleted or OrderIdDoesNotExist or PalletTypeNotFound or ParentPalletItemIdDoesNotExist</ErrorType>
                    </CreateOrderPalletItemError>
                    <CreateOrderPalletItemError>
                        <Message>string</Message>
                        <ErrorType>UnknownError or LogonError or GoodsOwnerIsDeleted or OrderIdDoesNotExist or PalletTypeNotFound or ParentPalletItemIdDoesNotExist</ErrorType>
                    </CreateOrderPalletItemError>
                </Errors>
                <Success>boolean</Success>
                <CreatedPalletItem>
                    <PalletItemId>int</PalletItemId>
                    <LabelId>string</LabelId>
                    <Serial>string</Serial>
                </CreatedPalletItem>
            </CreateOrderPalletItemResult>
        </CreateOrderPalletItemResponse>
    </soap:Body>
</soap:Envelope>
+

Response specification

CreateOrderPalletItemResult
Errors object A list of CreateOrderPalletItemError objects
Success bool True if successful, false otherwise.
CreatedPalletItem object An object of type CreatedPalletItem
CreateOrderPalletItemError
Message str(*) Message explaining the error.
ErrorType string The type of error: - UnknownError - LogonError - GoodsOwnerIsDeleted - OrderIdDoesNotExist - PalletTypeNotFound - ParentPalletItemIdDoesNotExist
CreatedPalletItem
PalletItemId int The internal id of the created pallet item.
LabelId string The label of the created pallet item. Usually SSCC or some other kind of serial number.
Serial string The serial of the pallet item. Usually used as a secondary serial after LabelId