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.
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 or PalletTypeName</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 | string(50) | Req. | Your username |
Password | string(50) | Req. | Your password |
Operation | CreateOrderPalletItemOperation | Req. | The operation object |
CreateOrderPalletItemOperation | |||
---|---|---|---|
OrderId | int | Req. | The order id of the order to connect the pallet item to. |
PalletType | CreateOrderPalletItemPalletTypeOperation | Req. | An element of type CreateOrderPalletItemPalletTypeOperation. |
LabelId | string(30) | The pallet item label. Usually SSCC or some other kind of serial number. | |
Serial | string(100) | Secondary serial number. It is usually preferred to use LabelId. | |
Comment | string(300) | An optional comment. | |
Weight | decimal | The weight of the pallet item in kilograms (Kg). | |
Volume | decimal | The volume of the pallet item in qubic meters (m3). | |
Length | decimal | The Length of the pallet item in meters (m). | |
Width | decimal | The Width of the pallet item in meters (m). | |
Height | decimal | The Height of the pallet item in meters (m). | |
LoadMeters | decimal | The load meters of the pallet item | |
ParentPalletItemId | int | 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 | enum | Req. | Determines if the pallet item is used as a transport administration pallet item that contains package number for shipping purposes: - None - Return - Deliver |
CreateOrderPalletItemPalletTypeOperation | |||
---|---|---|---|
PalletTypeCode | string | ||
PalletTypeName | string | ||
PalletTypeId | int | ||
Identification | enum | An element of type CreateOrderPalletItemPalletTypeIdentification. |
Response XML
<?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
CreateOrderPalletItemResponse | ||
---|---|---|
CreateOrderPalletItemResult | CreateOrderPalletItemResult |
CreateOrderPalletItemResult | ||
---|---|---|
Errors | CreateOrderPalletItemError[] | A list of CreateOrderPalletItemError objects |
Success | boolean | True if successful, false otherwise. |
CreatedPalletItem | CreatedPalletItem | An element of type CreatedPalletItem. |
CreateOrderPalletItemError | ||
---|---|---|
Message | string | Message explaining the error. |
ErrorType | enum | 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 |