ProcessShipment
This function is used for creating and updating shipments. It may also be used for canceling shipments that have not yet been handled.
Tags: ProcessShipment, Shipment, ShipmentHeader, ShipmentContainer, ShipmentContainerItem, ShipmentInOrder, ShipmentConsignee, ShipmentConsignor, ShipmentDestination, ShipmentAddress, Supplier, ShipmentPayment, ShipmentFunctions, ShipmentContainerOwner, ContainerType, ShipmentContainerItemStatus, AddressClass, ProcessShipmentResponse, FileResultClass
Request XML
POST /xxx/Service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/ProcessShipment"
<?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>
<ProcessShipment xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<Shipment>
<ShipmentHeader>
<ShipmentOperation>Create or CreateOrUpdate or Remove</ShipmentOperation>
<ShipmentIdentification>WayBill or TransporterOrderNumberAndShipmentOrderNumber or TransporterOrderNumberAndRoute or TransporterOrderNumber or ShipmentOrderNumber or ShipmentId or ShipmentOrderNumberAndDeliveryDate or TripOrderNumberAndConsigneeFullNameAndAddress</ShipmentIdentification>
<ShipmentFunctions>
<PickUpRouteFromDeliveryPlan>boolean</PickUpRouteFromDeliveryPlan>
<PickUpTimeWindowFromDeliveryPlan>boolean</PickUpTimeWindowFromDeliveryPlan>
<PickUpDeliveryDateFromDeliveryPlan>boolean</PickUpDeliveryDateFromDeliveryPlan>
<PickUpFromLocationFromDeliveryPlan>boolean</PickUpFromLocationFromDeliveryPlan>
<ExcludNonWorkDaysFromDeliveryPlan>boolean</ExcludNonWorkDaysFromDeliveryPlan>
<PickUpDeliveryInstruction>boolean</PickUpDeliveryInstruction>
</ShipmentFunctions>
<WayBill>long</WayBill>
<ConsignorReference>string</ConsignorReference>
<ConsigneeReference>string</ConsigneeReference>
<ConsignorCustomerNumber>string</ConsignorCustomerNumber>
<ConsigneeCustomerNumber>string</ConsigneeCustomerNumber>
<OtherCustomerNumber>string</OtherCustomerNumber>
<TransporterOrderNumber>string</TransporterOrderNumber>
<ShipmentOrderNumber>string</ShipmentOrderNumber>
<VesselName>string</VesselName>
<ShipmentComment>string</ShipmentComment>
<ArrivalTime>string</ArrivalTime>
<RegistrationNumber>string</RegistrationNumber>
<Route>string</Route>
<DeliveryInstruction>string</DeliveryInstruction>
<WarehouseComment>string</WarehouseComment>
<DestinationComment>string</DestinationComment>
<GoodsCategoryCode>string</GoodsCategoryCode>
<ShipmentTypeCode>string</ShipmentTypeCode>
<ShipmentId>int</ShipmentId>
<ShipmentStatusId>int</ShipmentStatusId>
<InDate>dateTime</InDate>
<DeliveryDate>dateTime</DeliveryDate>
<ArrivalDate>dateTime</ArrivalDate>
<ArrivalTimeFromSeconds>int</ArrivalTimeFromSeconds>
<ArrivalTimeToSeconds>int</ArrivalTimeToSeconds>
<ShippedTime>dateTime</ShippedTime>
<ContactPerson>string</ContactPerson>
<ShipmentContainerOwner>
<ShipmentContainerOwnerOperation>Find or CreateOrUpdate</ShipmentContainerOwnerOperation>
<Code>string</Code>
<Name>string</Name>
<Comment>string</Comment>
</ShipmentContainerOwner>
<PickUpDate>dateTime</PickUpDate>
<PickUpReference>string</PickUpReference>
<ExportReference>string</ExportReference>
<TripOrderNumber>string</TripOrderNumber>
</ShipmentHeader>
<ShipmentContainers>
<ShipmentContainer>
<ContainerTypeCode>string</ContainerTypeCode>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<LoadMeters>decimal</LoadMeters>
<NumberOfPackages>int</NumberOfPackages>
<GoodsMark>string</GoodsMark>
<GoodsCategory>string</GoodsCategory>
<OrderId>int</OrderId>
<ContainerId>int</ContainerId>
</ShipmentContainer>
<ShipmentContainer>
<ContainerTypeCode>string</ContainerTypeCode>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<LoadMeters>decimal</LoadMeters>
<NumberOfPackages>int</NumberOfPackages>
<GoodsMark>string</GoodsMark>
<GoodsCategory>string</GoodsCategory>
<OrderId>int</OrderId>
<ContainerId>int</ContainerId>
</ShipmentContainer>
</ShipmentContainers>
<ShipmentContainerItems>
<ShipmentContainerItem>
<ContainerType>
<Code>string</Code>
<Name>string</Name>
<IsContainer>boolean</IsContainer>
<IsTrailer>boolean</IsTrailer>
</ContainerType>
<ShipmentContainerItemStatus>
<Code>string</Code>
</ShipmentContainerItemStatus>
<ShipmentContainerItems>object of type ArrayOfShipmentContainerItem</ShipmentContainerItems>
<ShipmentContainerItemId>int</ShipmentContainerItemId>
<LabelId>string</LabelId>
<Comment>string</Comment>
<OwnerCode>string</OwnerCode>
<GoodsCategoryCode>string</GoodsCategoryCode>
<ShipmentPalletItemComment>string</ShipmentPalletItemComment>
<InOrderId>int</InOrderId>
<ShipmentContainerOwner>
<ShipmentContainerOwnerOperation>Find or CreateOrUpdate</ShipmentContainerOwnerOperation>
<Code>string</Code>
<Name>string</Name>
<Comment>string</Comment>
</ShipmentContainerOwner>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<NumberOfItems>decimal</NumberOfItems>
<SecondNumberOfItems>decimal</SecondNumberOfItems>
<PalletItemSerial>string</PalletItemSerial>
<PalletIndex>int</PalletIndex>
</ShipmentContainerItem>
<ShipmentContainerItem>
<ContainerType>
<Code>string</Code>
<Name>string</Name>
<IsContainer>boolean</IsContainer>
<IsTrailer>boolean</IsTrailer>
</ContainerType>
<ShipmentContainerItemStatus>
<Code>string</Code>
</ShipmentContainerItemStatus>
<ShipmentContainerItems>object of type ArrayOfShipmentContainerItem</ShipmentContainerItems>
<ShipmentContainerItemId>int</ShipmentContainerItemId>
<LabelId>string</LabelId>
<Comment>string</Comment>
<OwnerCode>string</OwnerCode>
<GoodsCategoryCode>string</GoodsCategoryCode>
<ShipmentPalletItemComment>string</ShipmentPalletItemComment>
<InOrderId>int</InOrderId>
<ShipmentContainerOwner>
<ShipmentContainerOwnerOperation>Find or CreateOrUpdate</ShipmentContainerOwnerOperation>
<Code>string</Code>
<Name>string</Name>
<Comment>string</Comment>
</ShipmentContainerOwner>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<NumberOfItems>decimal</NumberOfItems>
<SecondNumberOfItems>decimal</SecondNumberOfItems>
<PalletItemSerial>string</PalletItemSerial>
<PalletIndex>int</PalletIndex>
</ShipmentContainerItem>
</ShipmentContainerItems>
<ShipmentInOrders>
<ShipmentInOrder>
<OverwriteExistingShipmentOnInOrder>boolean</OverwriteExistingShipmentOnInOrder>
<InOrderIdentification>ExternalOrderCode or GoodsOwnerOrderNumber or SystemId or GoodsOwnerReference or GoodsOwnerInOrderId</InOrderIdentification>
<InOrderId>int</InOrderId>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<GoodsOwnerReference>string</GoodsOwnerReference>
<GoodsOwnerInOrderId>string</GoodsOwnerInOrderId>
</ShipmentInOrder>
<ShipmentInOrder>
<OverwriteExistingShipmentOnInOrder>boolean</OverwriteExistingShipmentOnInOrder>
<InOrderIdentification>ExternalOrderCode or GoodsOwnerOrderNumber or SystemId or GoodsOwnerReference or GoodsOwnerInOrderId</InOrderIdentification>
<InOrderId>int</InOrderId>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<GoodsOwnerReference>string</GoodsOwnerReference>
<GoodsOwnerInOrderId>string</GoodsOwnerInOrderId>
</ShipmentInOrder>
</ShipmentInOrders>
<Consignee>
<ShipmentAddressIdentification>None or Address_PostCode or Name or AddressAndSequenceNumber or FullNameAndAddress or CustomerNumber</ShipmentAddressIdentification>
<ShipmentAddressOperation>Create or FindOrCreate or Find</ShipmentAddressOperation>
<CustomerNumber>string</CustomerNumber>
<CustomerNumberPallets>string</CustomerNumberPallets>
<Id>int</Id>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<IsEuCountry>boolean</IsEuCountry>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Remark>string</Remark>
<Email>string</Email>
<DeliveryInstruction>string</DeliveryInstruction>
<NotifyByEmail>boolean</NotifyByEmail>
<NotifyBySms>boolean</NotifyBySms>
<NotifyByTelephone>boolean</NotifyByTelephone>
<AddressId>int</AddressId>
</Consignee>
<Consignor>
<ShipmentAddressIdentification>None or Address_PostCode or Name or AddressAndSequenceNumber or FullNameAndAddress or CustomerNumber</ShipmentAddressIdentification>
<ShipmentAddressOperation>Create or FindOrCreate or Find</ShipmentAddressOperation>
<CustomerNumber>string</CustomerNumber>
<CustomerNumberPallets>string</CustomerNumberPallets>
<Id>int</Id>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<IsEuCountry>boolean</IsEuCountry>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Remark>string</Remark>
<Email>string</Email>
<DeliveryInstruction>string</DeliveryInstruction>
<NotifyByEmail>boolean</NotifyByEmail>
<NotifyBySms>boolean</NotifyBySms>
<NotifyByTelephone>boolean</NotifyByTelephone>
<AddressId>int</AddressId>
</Consignor>
<Destination>
<ShipmentAddressIdentification>None or Address_PostCode or Name or AddressAndSequenceNumber or FullNameAndAddress or CustomerNumber</ShipmentAddressIdentification>
<ShipmentAddressOperation>Create or FindOrCreate or Find</ShipmentAddressOperation>
<CustomerNumber>string</CustomerNumber>
<CustomerNumberPallets>string</CustomerNumberPallets>
<Id>int</Id>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<IsEuCountry>boolean</IsEuCountry>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Remark>string</Remark>
<Email>string</Email>
<DeliveryInstruction>string</DeliveryInstruction>
<NotifyByEmail>boolean</NotifyByEmail>
<NotifyBySms>boolean</NotifyBySms>
<NotifyByTelephone>boolean</NotifyByTelephone>
<AddressId>int</AddressId>
</Destination>
<ShipmentAddresses>
<ShipmentAddress>
<ShipmentAddressIdentification>None or Address_PostCode or Name or AddressAndSequenceNumber or FullNameAndAddress or CustomerNumber</ShipmentAddressIdentification>
<ShipmentAddressOperation>Create or FindOrCreate or Find</ShipmentAddressOperation>
<AddressSequenceNumber>int</AddressSequenceNumber>
<Id>int</Id>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<IsEuCountry>boolean</IsEuCountry>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Remark>string</Remark>
<Email>string</Email>
<DeliveryInstruction>string</DeliveryInstruction>
<NotifyByEmail>boolean</NotifyByEmail>
<NotifyBySms>boolean</NotifyBySms>
<NotifyByTelephone>boolean</NotifyByTelephone>
<AddressId>int</AddressId>
</ShipmentAddress>
<ShipmentAddress>
<ShipmentAddressIdentification>None or Address_PostCode or Name or AddressAndSequenceNumber or FullNameAndAddress or CustomerNumber</ShipmentAddressIdentification>
<ShipmentAddressOperation>Create or FindOrCreate or Find</ShipmentAddressOperation>
<AddressSequenceNumber>int</AddressSequenceNumber>
<Id>int</Id>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<CountryCode>string</CountryCode>
<IsEuCountry>boolean</IsEuCountry>
<TelePhone>string</TelePhone>
<MobilePhone>string</MobilePhone>
<Remark>string</Remark>
<Email>string</Email>
<DeliveryInstruction>string</DeliveryInstruction>
<NotifyByEmail>boolean</NotifyByEmail>
<NotifyBySms>boolean</NotifyBySms>
<NotifyByTelephone>boolean</NotifyByTelephone>
<AddressId>int</AddressId>
</ShipmentAddress>
</ShipmentAddresses>
<ShipmentSupplier>
<SupplierIdentificationType>SupplierNumber or SupplierName or FullNameAndAdress</SupplierIdentificationType>
<SupplierOperation>CreateOrUpdate or Find or CreateOrFind</SupplierOperation>
<SupplierNumber>string</SupplierNumber>
<SupplierName>string</SupplierName>
<Address>
<Name>string</Name>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<TelePhone>string</TelePhone>
<Remark>string</Remark>
<Email>string</Email>
<MobilePhone>string</MobilePhone>
<IsEuCountry>boolean</IsEuCountry>
<CountryStateCode>string</CountryStateCode>
<CountryCode>string</CountryCode>
<DeliveryInstruction>string</DeliveryInstruction>
<IsVisible>boolean</IsVisible>
<NotifyBySMS>boolean</NotifyBySMS>
<NotifyByEmail>boolean</NotifyByEmail>
<NotifyByTelephone>boolean</NotifyByTelephone>
</Address>
<comment>string</comment>
<ManufacturersIdentificationCode>string</ManufacturersIdentificationCode>
</ShipmentSupplier>
<ShipmentPayment>
<ShipmentContractIdentification>TransporterCode or TransporterCodeAndTransporterServiceCode</ShipmentContractIdentification>
<ShipmentPaymentType>Collect or Prepaid or ThirdParty or UnKnown</ShipmentPaymentType>
<TransporterCode>string</TransporterCode>
<TransporterServiceCode>string</TransporterServiceCode>
<TransporterContractComment>string</TransporterContractComment>
<CustomerNumber>string</CustomerNumber>
</ShipmentPayment>
</Shipment>
</ProcessShipment>
</soap:Body>
</soap:Envelope>
Request specification
| ProcessShipment |
| GoodsOwnerCode |
string(400) |
Req. |
The name/code of your client |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| Shipment |
Shipment |
Req. |
|
| Shipment |
| ShipmentHeader |
ShipmentHeader |
Req. |
General information about the shipment |
| ShipmentContainers |
ShipmentContainer[] |
|
Containing elements of ShipmentContainer. |
| ShipmentContainerItems |
ShipmentContainerItem[] |
|
Containing elements of ShipmentContainerItem. Defines the pallet items on the shipment |
| ShipmentInOrders |
ShipmentInOrder[] |
|
Containing elements of ShipmentInOrder. |
| Consignee |
ShipmentConsignee |
|
The consignee (receiver) of the shipment. Element of ShipmentConsignee. |
| Consignor |
ShipmentConsignor |
|
The consignor (sender) of the shipment. Element of ShipmentConsignor. |
| Destination |
ShipmentDestination |
|
The destination address of the shipment. Element of ShipmentDestination. |
| ShipmentAddresses |
ShipmentAddress[] |
|
Additional addresses connected to the shipment. Containing elements of ShipmentAddress. |
| ShipmentSupplier |
Supplier |
|
The supplier connected to the shipment. Element of Supplier. |
| ShipmentPayment |
ShipmentPayment |
|
Payment and transporter contract information for the shipment. Element of ShipmentPayment. |
| ShipmentContainer |
| ContainerTypeCode |
string |
|
|
| Weight |
decimal |
|
|
| Volume |
decimal |
|
|
| LoadMeters |
decimal |
|
|
| NumberOfPackages |
int |
|
|
| GoodsMark |
string |
|
|
| GoodsCategory |
string |
|
|
| OrderId |
int |
|
|
| ContainerId |
int |
|
|
| ShipmentContainerItem |
| ContainerType |
ContainerType |
|
An element of type ContainerType. |
| ShipmentContainerItemStatus |
ShipmentContainerItemStatus |
|
An element of type ShipmentContainerItemStatus. |
| ShipmentContainerItems |
ShipmentContainerItem[] |
|
|
| ShipmentContainerItemId |
int |
|
|
| LabelId |
string |
|
|
| Comment |
string |
|
|
| OwnerCode |
string |
|
|
| GoodsCategoryCode |
string |
|
|
| ShipmentPalletItemComment |
string |
|
|
| InOrderId |
int |
|
|
| ShipmentContainerOwner |
ShipmentContainerOwner |
|
An element of type ShipmentContainerOwner. |
| Weight |
decimal |
|
|
| Volume |
decimal |
|
|
| Length |
decimal |
|
|
| Width |
decimal |
|
|
| Height |
decimal |
|
|
| NumberOfItems |
decimal |
|
|
| SecondNumberOfItems |
decimal |
|
|
| PalletItemSerial |
string |
|
|
| PalletIndex |
int |
|
|
| ShipmentInOrder |
| OverwriteExistingShipmentOnInOrder |
boolean |
|
Allow this request to overwrite any existing connection to another shipment on this in order. Default is False.
|
| InOrderIdentification |
enum |
|
Defines what you want to identify the inorder by (what is public). Default is GoodsOwnerOrderNumber. - ExternalOrderCode (deprecated, don't use) - GoodsOwnerOrderNumber - SystemId - GoodsOwnerInOrderId - GoodsOwnerReference
|
| InOrderId |
int |
|
Ongoing WMS internal id (SystemId). Required if InOrderIdentification = SystemId |
| GoodsOwnerOrderNumber |
string(50) |
|
Order number. Required if InOrderIdentification = GoodsOwnerOrderNumber |
| GoodsOwnerReference |
string(100) |
|
Goods owner reference. Required if InOrderIdentification = GoodsOwnerReference |
| GoodsOwnerInOrderId |
string(40) |
|
External order id. Required if InOrderIdentification = GoodsOwnerInOrderId |
| ShipmentConsignee |
| ShipmentAddressIdentification |
enum |
|
An element of type ShipmentAddressIdentification. |
| ShipmentAddressOperation |
enum |
|
An element of type ShipmentAddressOperation. |
| CustomerNumber |
string |
|
|
| CustomerNumberPallets |
string |
|
|
| Id |
int |
|
|
| Name |
string |
|
|
| Address |
string |
|
|
| Address2 |
string |
|
|
| Address3 |
string |
|
|
| PostCode |
string |
|
|
| City |
string |
|
|
| CountryCode |
string |
|
|
| IsEuCountry |
boolean |
|
|
| TelePhone |
string |
|
|
| MobilePhone |
string |
|
|
| Remark |
string |
|
|
| Email |
string |
|
|
| DeliveryInstruction |
string |
|
|
| NotifyByEmail |
boolean |
|
|
| NotifyBySms |
boolean |
|
|
| NotifyByTelephone |
boolean |
|
|
| AddressId |
int |
|
|
| ShipmentConsignor |
| ShipmentAddressIdentification |
enum |
|
An element of type ShipmentAddressIdentification. |
| ShipmentAddressOperation |
enum |
|
An element of type ShipmentAddressOperation. |
| CustomerNumber |
string |
|
|
| CustomerNumberPallets |
string |
|
|
| Id |
int |
|
|
| Name |
string |
|
|
| Address |
string |
|
|
| Address2 |
string |
|
|
| Address3 |
string |
|
|
| PostCode |
string |
|
|
| City |
string |
|
|
| CountryCode |
string |
|
|
| IsEuCountry |
boolean |
|
|
| TelePhone |
string |
|
|
| MobilePhone |
string |
|
|
| Remark |
string |
|
|
| Email |
string |
|
|
| DeliveryInstruction |
string |
|
|
| NotifyByEmail |
boolean |
|
|
| NotifyBySms |
boolean |
|
|
| NotifyByTelephone |
boolean |
|
|
| AddressId |
int |
|
|
| ShipmentDestination |
| ShipmentAddressIdentification |
enum |
|
An element of type ShipmentAddressIdentification. |
| ShipmentAddressOperation |
enum |
|
An element of type ShipmentAddressOperation. |
| CustomerNumber |
string |
|
|
| CustomerNumberPallets |
string |
|
|
| Id |
int |
|
|
| Name |
string |
|
|
| Address |
string |
|
|
| Address2 |
string |
|
|
| Address3 |
string |
|
|
| PostCode |
string |
|
|
| City |
string |
|
|
| CountryCode |
string |
|
|
| IsEuCountry |
boolean |
|
|
| TelePhone |
string |
|
|
| MobilePhone |
string |
|
|
| Remark |
string |
|
|
| Email |
string |
|
|
| DeliveryInstruction |
string |
|
|
| NotifyByEmail |
boolean |
|
|
| NotifyBySms |
boolean |
|
|
| NotifyByTelephone |
boolean |
|
|
| AddressId |
int |
|
|
| ShipmentAddress |
| ShipmentAddressIdentification |
enum |
|
An element of type ShipmentAddressIdentification. |
| ShipmentAddressOperation |
enum |
|
An element of type ShipmentAddressOperation. |
| AddressSequenceNumber |
int |
|
|
| Id |
int |
|
|
| Name |
string |
|
|
| Address |
string |
|
|
| Address2 |
string |
|
|
| Address3 |
string |
|
|
| PostCode |
string |
|
|
| City |
string |
|
|
| CountryCode |
string |
|
|
| IsEuCountry |
boolean |
|
|
| TelePhone |
string |
|
|
| MobilePhone |
string |
|
|
| Remark |
string |
|
|
| Email |
string |
|
|
| DeliveryInstruction |
string |
|
|
| NotifyByEmail |
boolean |
|
|
| NotifyBySms |
boolean |
|
|
| NotifyByTelephone |
boolean |
|
|
| AddressId |
int |
|
|
| Supplier |
| SupplierIdentificationType |
enum |
Req. |
Defines what you identify the supplier by: - SupplierNumber - SupplierName - FullNameAndAdress |
| SupplierOperation |
enum |
Req. |
Defines the operation: - CreateOrUpdate - Find - CreateOrFind |
| SupplierNumber |
string(200) |
|
Supplier number. Required if SupplierIdentificationType = SupplierNumber or SupplierOperation = CreateOrUpdate |
| SupplierName |
string(200) |
|
Supplier name. Required if SupplierIdentificationType = SupplierName or SupplierOperation = CreateOrUpdate |
| Address |
AddressClass |
|
Address of the supplier. Required if SupplierIdentificationType = FullNameAndAdress |
| comment |
string(800) |
|
Comment about the supplier |
| ManufacturersIdentificationCode |
string(50) |
|
Manufacturers identification code (also know as MID code, used by United States customs). |
| ShipmentPayment |
| ShipmentContractIdentification |
enum |
|
An element of type ShipmentContractIdentification. |
| ShipmentPaymentType |
enum |
|
An element of type ShipmentPaymentType. |
| TransporterCode |
string |
|
|
| TransporterServiceCode |
string |
|
|
| TransporterContractComment |
string |
|
|
| CustomerNumber |
string |
|
|
| ShipmentFunctions |
| PickUpRouteFromDeliveryPlan |
boolean |
|
|
| PickUpTimeWindowFromDeliveryPlan |
boolean |
|
|
| PickUpDeliveryDateFromDeliveryPlan |
boolean |
|
|
| PickUpFromLocationFromDeliveryPlan |
boolean |
|
|
| ExcludNonWorkDaysFromDeliveryPlan |
boolean |
|
|
| PickUpDeliveryInstruction |
boolean |
|
|
| ShipmentContainerOwner |
| ShipmentContainerOwnerOperation |
enum |
|
An element of type ShipmentContainerOwnerOperation. |
| Code |
string |
|
|
| Name |
string |
|
|
| Comment |
string |
|
|
| ContainerType |
| Code |
string |
|
|
| Name |
string |
|
|
| IsContainer |
boolean |
|
|
| IsTrailer |
boolean |
|
|
| ShipmentContainerItemStatus |
| Code |
string |
|
|
| AddressClass |
| Name |
string(200) |
|
Name |
| Address |
string(200) |
|
Address line 1 |
| Address2 |
string(200) |
|
Address line 2 |
| Address3 |
string(200) |
|
Address line 3 |
| PostCode |
string(50) |
|
Post code/zip |
| City |
string(200) |
|
City |
| TelePhone |
string(50) |
|
Telephone number (non cellular) |
| Remark |
string(800) |
|
Remark/comment |
| Email |
string(300) |
|
Email address |
| MobilePhone |
string(50) |
|
Mobile phone number (cellular) |
| IsEuCountry |
boolean |
|
True if country is within EU |
| CountryStateCode |
string(50) |
|
The two-letter ISO 3166-2 abbreviation of the state. Mainly used for United States and Canada. See ISO 3166-2:US for United States and ISO 3166-2:CA for Canada. |
| CountryCode |
string(2) |
|
The two-letter ISO 3166-1 alpha-2 code of the country. |
| DeliveryInstruction |
string(300) |
|
Delivery instruction |
| IsVisible |
boolean |
|
False if the address shouldn't show in the system, e.g. be re-used for manual order |
| NotifyBySMS |
boolean |
|
True if the customer should be notified by the transporter through SMS |
| NotifyByEmail |
boolean |
|
True if the customer should be notified by the transporter through email |
| NotifyByTelephone |
boolean |
|
True if the customer should be notified by the transporter through phone call |
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>
<ProcessShipmentResponse xmlns="http://ongoingsystems.se/WSI">
<ProcessShipmentResult>
<ErrorMessage>string</ErrorMessage>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<OrderId>int</OrderId>
<InOrderId>int</InOrderId>
<ArticleDefId>int</ArticleDefId>
<Success>boolean</Success>
<Message>string</Message>
<ShipmentId>int</ShipmentId>
</ProcessShipmentResult>
</ProcessShipmentResponse>
</soap:Body>
</soap:Envelope>
Response specification
| ProcessShipmentResponse |
| ProcessShipmentResult |
FileResultClass |
|
| FileResultClass |
| ErrorMessage |
string |
Error message |
| GoodsOwnerOrderNumber |
string(50) |
|
| OrderId |
int |
|
| InOrderId |
int |
|
| ArticleDefId |
int |
|
| Success |
boolean |
True if success |
| Message |
string |
Process message |
| ShipmentId |
int |
|