ProcessInOrder
This function is used for creating and updating inorders. It can also be used for canceling inorders that have not yet been handled.
Note: this function expects that an article will never appear on two or more distinct order lines on the same order. Please see this article if your integration requires several order lines with the same article.
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/ProcessInOrder"
<?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>
<ProcessInOrder xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<co>
<InOrderInfo>
<InOrderIdentification>ExternalOrderCode or GoodsOwnerOrderNumber or SystemId or GoodsOwnerReference</InOrderIdentification>
<InOrderOperation>Create or CreateOrUpdate or Remove</InOrderOperation>
<InOrderId>int</InOrderId>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<SupplierOrderNumber>string</SupplierOrderNumber>
<BatchNumber>string</BatchNumber>
<GoodsOwnerReference>string</GoodsOwnerReference>
<ReferenceNumber>string</ReferenceNumber>
<WayOfDelivery>string</WayOfDelivery>
<OrderRemark>string</OrderRemark>
<InDate>dateTime</InDate>
<OrderDate>dateTime</OrderDate>
<BatchDate>dateTime</BatchDate>
<Container>string</Container>
<OrderStatusCreated>int</OrderStatusCreated>
<OrderStatusUpdated>int</OrderStatusUpdated>
<WayOfDeliveryType>
<WayOfDeliveryTypeOperation>CreateOrUpdate or CreateOrFind or Find</WayOfDeliveryTypeOperation>
<WayOfDeliveryTypeIdentification>Code or Name</WayOfDeliveryTypeIdentification>
<Code>string</Code>
<Name>string</Name>
</WayOfDeliveryType>
<InOrderType>
<InOrderTypeOperation>Find or CreateOrFind</InOrderTypeOperation>
<InOrderTypeIdentification>InOrderTypeCode or InOrderTypeName</InOrderTypeIdentification>
<InOrderTypeCode>string</InOrderTypeCode>
<InOrderTypeName>string</InOrderTypeName>
</InOrderType>
<InOrderIsReturnType>boolean</InOrderIsReturnType>
<InvoiceNumber>string</InvoiceNumber>
<TermsOfDeliveryType>
<TermsOfDeliveryTypeOperation>CreateOrUpdate or Find</TermsOfDeliveryTypeOperation>
<TermsOfDeliveryTypeIdentification>Code or Name</TermsOfDeliveryTypeIdentification>
<Code>string</Code>
<Name>string</Name>
</TermsOfDeliveryType>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<FreeText3>string</FreeText3>
<FreeText4>string</FreeText4>
<FreeText5>string</FreeText5>
<Warehouse>
<InOrderWarehouseIdentification>WarehouseName or WarehouseCode or WarehouseId</InOrderWarehouseIdentification>
<InOrderWarehouseOperation>Find</InOrderWarehouseOperation>
<WarehouseName>string</WarehouseName>
<WarehouseCode>string</WarehouseCode>
<WarehouseId>int</WarehouseId>
</Warehouse>
<CustomsDeclaredDate>dateTime</CustomsDeclaredDate>
<InOrderFreeDecimal1>decimal</InOrderFreeDecimal1>
<InOrderFreeDecimal2>decimal</InOrderFreeDecimal2>
<InOrderFreeBool1>boolean</InOrderFreeBool1>
<InOrderFreeBool2>boolean</InOrderFreeBool2>
<AdvisedDate>dateTime</AdvisedDate>
<TermsOfDeliveryTypeLocation>string</TermsOfDeliveryTypeLocation>
<InOrderClasses>
<Operation>FindOrCreate or Find</Operation>
<Identification>Code</Identification>
<Classes>
<Class>
<Name>string</Name>
<Code>string</Code>
<Comment>string</Comment>
</Class>
<Class>
<Name>string</Name>
<Code>string</Code>
<Comment>string</Comment>
</Class>
</Classes>
</InOrderClasses>
</InOrderInfo>
<InOrderCustomer>
<InOrderCustomerIdentification>CustomerNumber or FullNameAndAdress</InOrderCustomerIdentification>
<InOrderCustomerOperation>Find or CreateOrUpdate or FindOrCreate</InOrderCustomerOperation>
<CustomerNumber>string</CustomerNumber>
<Name>string</Name>
<AddressName>string</AddressName>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
<TelePhone>string</TelePhone>
<AddressEmail>string</AddressEmail>
<MobilePhone>string</MobilePhone>
<CountryCode>string</CountryCode>
</InOrderCustomer>
<InOrderSupplier>
<InOrderSupplierIdentificationType>SupplierNumber or FullNameAndAdress or SupplierName</InOrderSupplierIdentificationType>
<InOrderSupplierOperation>CreateOrUpdate or Find</InOrderSupplierOperation>
<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>
<SupplierGroup>
<SupplierGroupOperation>FindOrCreate or Clear</SupplierGroupOperation>
<SupplierGroupCode>string</SupplierGroupCode>
<SupplierGroupName>string</SupplierGroupName>
</SupplierGroup>
</InOrderSupplier>
<Seller>
<Operation>CreateOrFind or Find</Operation>
<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>
<SupplierGroup>
<SupplierGroupOperation>FindOrCreate or Clear</SupplierGroupOperation>
<SupplierGroupCode>string</SupplierGroupCode>
<SupplierGroupName>string</SupplierGroupName>
</SupplierGroup>
</Seller>
<InOrderTextLines>
<InOrderTextLine>
<RowNumber>string</RowNumber>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
</InOrderTextLine>
<InOrderTextLine>
<RowNumber>string</RowNumber>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
</InOrderTextLine>
</InOrderTextLines>
<GoodsOwner>
<GoodsOwnerIdentification>SystemId or GoodsOwnerCode</GoodsOwnerIdentification>
<GoodsOwnerCode>string</GoodsOwnerCode>
<GoodsOwnerId>int</GoodsOwnerId>
<FinancialCode>string</FinancialCode>
<GoodsLocationCode>string</GoodsLocationCode>
<CountryCode>string</CountryCode>
<GoodsOwnerAddressName>string</GoodsOwnerAddressName>
<Address>string</Address>
<Address2>string</Address2>
<Address3>string</Address3>
<PostCode>string</PostCode>
<City>string</City>
</GoodsOwner>
<CommunicationInfo>
<FromSystemName>string</FromSystemName>
<ToSystemName>string</ToSystemName>
<MessageId>string</MessageId>
</CommunicationInfo>
<InOrderLines>
<InOrderLine>
<OrderLineIdentification>ExternalOrderLineCode or ArticleNumber or ArticleName or ExternalOrderLineId or SystemId</OrderLineIdentification>
<ArticleIdentification>SystemId or ArticleNumber or ProductCode or ArticleName</ArticleIdentification>
<OrderLineSystemId>int</OrderLineSystemId>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<ExternalOrderLineId>string</ExternalOrderLineId>
<InvoiceNumber>string</InvoiceNumber>
<Indate>dateTime</Indate>
<OrderLineComment>string</OrderLineComment>
<ArticleSystemId>int</ArticleSystemId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
<ArticleCode>string</ArticleCode>
<CurrencyCode>string</CurrencyCode>
<NumberOfItems>decimal</NumberOfItems>
<RowPrice>decimal</RowPrice>
<SupplierNumberOfItems>decimal</SupplierNumberOfItems>
<RowBatchNo>string</RowBatchNo>
<Items xsi:nil="true" />
<ProductCode>string</ProductCode>
<ArticleDef xsi:nil="true" />
<InOrderLineFreeDecimal1>decimal</InOrderLineFreeDecimal1>
<InOrderLineFreeDateTime1>dateTime</InOrderLineFreeDateTime1>
<InOrderLineType>
<InOrderLineTypeIdentificationType>InOrderLineTypeName or InOrderLineTypeCode</InOrderLineTypeIdentificationType>
<InOrderLineTypeOperation>CreateOrUpdate or CreateOrFind or Find</InOrderLineTypeOperation>
<InOrderLineTypeCode>string</InOrderLineTypeCode>
<InOrderLineTypeName>string</InOrderLineTypeName>
</InOrderLineType>
<InOrderLineWeight>decimal</InOrderLineWeight>
<InOrderLineArticleItemStatus>
<InOrderLineArticleItemStatusIdentification>ArticleItemStatusId or ArticleItemStatusCode</InOrderLineArticleItemStatusIdentification>
<ArticleItemStatusId>int</ArticleItemStatusId>
<ArticleItemStatusCode>string</ArticleItemStatusCode>
</InOrderLineArticleItemStatus>
<InOrderLineSerial>string</InOrderLineSerial>
<InOrderLineExpirydate>dateTime</InOrderLineExpirydate>
<InOrderLineProductionDate>dateTime</InOrderLineProductionDate>
<InOrderLineFreeText1>string</InOrderLineFreeText1>
<InOrderLineFreeText2>string</InOrderLineFreeText2>
<InOrderLineReturnCause>
<ReturnCauseOperation>Find or FindOrCreate or SetUnknown</ReturnCauseOperation>
<ReturnCauseCode>string</ReturnCauseCode>
<ReturnCauseName>string</ReturnCauseName>
</InOrderLineReturnCause>
<InOrderTextLines>
<InOrderTextLine>
<RowNumber>string</RowNumber>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
</InOrderTextLine>
<InOrderTextLine>
<RowNumber>string</RowNumber>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
</InOrderTextLine>
</InOrderTextLines>
</InOrderLine>
<InOrderLine>
<OrderLineIdentification>ExternalOrderLineCode or ArticleNumber or ArticleName or ExternalOrderLineId or SystemId</OrderLineIdentification>
<ArticleIdentification>SystemId or ArticleNumber or ProductCode or ArticleName</ArticleIdentification>
<OrderLineSystemId>int</OrderLineSystemId>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<ExternalOrderLineId>string</ExternalOrderLineId>
<InvoiceNumber>string</InvoiceNumber>
<Indate>dateTime</Indate>
<OrderLineComment>string</OrderLineComment>
<ArticleSystemId>int</ArticleSystemId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
<ArticleCode>string</ArticleCode>
<CurrencyCode>string</CurrencyCode>
<NumberOfItems>decimal</NumberOfItems>
<RowPrice>decimal</RowPrice>
<SupplierNumberOfItems>decimal</SupplierNumberOfItems>
<RowBatchNo>string</RowBatchNo>
<Items xsi:nil="true" />
<ProductCode>string</ProductCode>
<ArticleDef xsi:nil="true" />
<InOrderLineFreeDecimal1>decimal</InOrderLineFreeDecimal1>
<InOrderLineFreeDateTime1>dateTime</InOrderLineFreeDateTime1>
<InOrderLineType>
<InOrderLineTypeIdentificationType>InOrderLineTypeName or InOrderLineTypeCode</InOrderLineTypeIdentificationType>
<InOrderLineTypeOperation>CreateOrUpdate or CreateOrFind or Find</InOrderLineTypeOperation>
<InOrderLineTypeCode>string</InOrderLineTypeCode>
<InOrderLineTypeName>string</InOrderLineTypeName>
</InOrderLineType>
<InOrderLineWeight>decimal</InOrderLineWeight>
<InOrderLineArticleItemStatus>
<InOrderLineArticleItemStatusIdentification>ArticleItemStatusId or ArticleItemStatusCode</InOrderLineArticleItemStatusIdentification>
<ArticleItemStatusId>int</ArticleItemStatusId>
<ArticleItemStatusCode>string</ArticleItemStatusCode>
</InOrderLineArticleItemStatus>
<InOrderLineSerial>string</InOrderLineSerial>
<InOrderLineExpirydate>dateTime</InOrderLineExpirydate>
<InOrderLineProductionDate>dateTime</InOrderLineProductionDate>
<InOrderLineFreeText1>string</InOrderLineFreeText1>
<InOrderLineFreeText2>string</InOrderLineFreeText2>
<InOrderLineReturnCause>
<ReturnCauseOperation>Find or FindOrCreate or SetUnknown</ReturnCauseOperation>
<ReturnCauseCode>string</ReturnCauseCode>
<ReturnCauseName>string</ReturnCauseName>
</InOrderLineReturnCause>
<InOrderTextLines>
<InOrderTextLine>
<RowNumber>string</RowNumber>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
</InOrderTextLine>
<InOrderTextLine>
<RowNumber>string</RowNumber>
<Comment>string</Comment>
<NumberOfItems>decimal</NumberOfItems>
</InOrderTextLine>
</InOrderTextLines>
</InOrderLine>
</InOrderLines>
<Tracking>
<InOrderTracking>
<Url>string</Url>
<WayBill>string</WayBill>
</InOrderTracking>
<InOrderTracking>
<Url>string</Url>
<WayBill>string</WayBill>
</InOrderTracking>
</Tracking>
</co>
</ProcessInOrder>
</soap:Body>
</soap:Envelope>
Request specification
ProcessInOrder | |||
---|---|---|---|
GoodsOwnerCode | string(400) | Req. | The name/code of your client |
UserName | string(50) | Req. | Your username |
Password | string(50) | Req. | Your password |
co | InOrder | Req. | The InOrder object |
InOrder | |||
---|---|---|---|
InOrderInfo | InOrderInfoClass | Req. | Defines inorder head information |
InOrderCustomer | InOrderCustomer | Defines a customer associated with the inorder | |
InOrderSupplier | InOrderSupplier | Defines a supplier associated with the inorder | |
Seller | InOrderSeller | Defines a seller associated with the inorder. Primarily used by a bonded warehouse. | |
InOrderTextLines | InOrderTextLine[] | Containing elements of InOrderTextLine. | |
GoodsOwner | GoodsOwner | Omit | Only for internal purposes, don't use |
CommunicationInfo | CommunicationInfo | Omit | Deprecated, don't use |
InOrderLines | InOrderLine[] | Req. | Containing elements of InOrderLine. Defines articles and amount advised |
Tracking | InOrderTracking[] | List of ReturnInOrderTracking. These are the tracking numbers and tracking URLs for the return inorder. |
InOrderInfoClass | |||
---|---|---|---|
InOrderIdentification | enum | Req. | Defines what you want to identify the inorder by (what is public). Most integrations will use GoodsOwnerOrderNumber. - ExternalOrderCode (deprecated, don't use) - GoodsOwnerOrderNumber - SystemId - GoodsOwnerReference |
InOrderOperation | enum | Req. | Defines the operation: - CreateOrUpdate - Create - Remove Note 1: the recommended operation is CreateOrUpdate. Note 2: if you use Create, then you run the risk of creating duplicate inorders. See this page for more info. |
InOrderId | int | Ongoing WMS internal id (SystemId). Required if InOrderIdentification = SystemId | |
GoodsOwnerOrderNumber | string(50) | Order number. Required if InOrderIdentification = GoodsOwnerOrderNumber | |
SupplierOrderNumber | string(50) | Supplier order number | |
BatchNumber | string(50) | Inorder batch | |
GoodsOwnerReference | string(100) | Goods owner reference | |
ReferenceNumber | string(50) | Reference number | |
WayOfDelivery | string(50) | Way of delivery | |
OrderRemark | string(1000) | Remark/comment about the order | |
InDate | dateTime | Expected date of arrival to warehouse. If left empty, the system will use today's date | |
OrderDate | dateTime | Date when the order was placed | |
BatchDate | dateTime | Deprecated, don't use | |
Container | string(50) | Container number | |
OrderStatusCreated | int | Status the inorder should get when created | |
OrderStatusUpdated | int | Status the inorder should get when updated | |
WayOfDeliveryType | WayOfDeliveryType | Enables a way of delivery type with code and name | |
InOrderType | InOrderType | Enables defining a type for the order | |
InOrderIsReturnType | boolean | True if the inorder represents a return | |
InvoiceNumber | string(100) | Invoice number of inorder | |
TermsOfDeliveryType | TermsOfDeliveryType | Enables a terms of delivery type with code and name | |
FreeText1 | string(300) | Free text 1 | |
FreeText2 | string(50) | Free text 2 | |
FreeText3 | string(50) | Free text 3 | |
FreeText4 | string(50) | Free text 4 | |
FreeText5 | string(50) | Free text 5 | |
Warehouse | InOrderWarehouse | Identifies which warehouse the inorder is supposed to go to | |
CustomsDeclaredDate | dateTime | Date when inorder was declared to customs | |
InOrderFreeDecimal1 | decimal | Free decimal 1 | |
InOrderFreeDecimal2 | decimal | Free decimal 2 | |
InOrderFreeBool1 | boolean | Free bool 1 | |
InOrderFreeBool2 | boolean | Free bool 2 | |
AdvisedDate | dateTime | Date when the inorder was advised | |
TermsOfDeliveryTypeLocation | string(100) | TermsOfDeliveryType Location | |
InOrderClasses | InOrderClasses | An object of type InOrderClasses, which specifies which classes this inorder belongs to. |
InOrderCustomer | |||
---|---|---|---|
InOrderCustomerIdentification | enum | Req. | Defines what you want to identify the customer by. We recommend that you use FullNameAndAddress or CustomerNumber. - CustomerNumber Required if InOrderCustomerIdentification = CustomerNumber - FullNameAndAdress |
InOrderCustomerOperation | enum | Defines the operation - Find - CreateOrUpdate |
|
CustomerNumber | string(50) | Customer number. Required if InOrderCustomerIdentification = CustomerNumber | |
Name | string(200) | Name of the customer | |
AddressName | string(200) | Name of the address | |
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) | |
AddressEmail | string(300) | Email address | |
MobilePhone | string(50) | Mobile phone number (cellular) | |
CountryCode | string(2) | The two-letter ISO 3166-1 alpha-2 code of the country. |
InOrderSupplier | |||
---|---|---|---|
InOrderSupplierIdentificationType | enum | Req. | Obsolete. The supplier will always be searched for by all fields supplied including address. If some fields are not supplied empty fields will be used for searching. |
InOrderSupplierOperation | enum | Req. | Defines the operation - CreateOrUpdate - Find |
SupplierNumber | string(200) | Supplier number. Required if InOrderSupplierIdentificationType = SupplierNumber or SupplierOperation = CreateOrUpdate | |
SupplierName | string(200) | Supplier name. Required if InOrderSupplierIdentificationType = SupplierName or SupplierOperation = CreateOrUpdate | |
Address | AddressClass | Address of the supplier. Required if SupplierIdentificationType = FullNameAndAdress | |
SupplierGroup | SupplierGroup | Supplier group, enable grouping of suppliers |
InOrderSeller | |||
---|---|---|---|
Operation | enum | Req. | Defines the operation - CreateOrFind - Find |
SupplierNumber | string(200) | Supplier number. Required if InOrderSupplierIdentificationType = SupplierNumber or SupplierOperation = CreateOrUpdate | |
SupplierName | string(200) | Supplier name. Required if InOrderSupplierIdentificationType = SupplierName or SupplierOperation = CreateOrUpdate | |
Address | AddressClass | Address of the supplier. Required if SupplierIdentificationType = FullNameAndAdress | |
SupplierGroup | SupplierGroup | Supplier group, enable grouping of suppliers |
InOrderTextLine | |||
---|---|---|---|
RowNumber | string(50) | Req. | Text line row number |
Comment | string(300) | Req. | Comment/order line text |
NumberOfItems | decimal | Number of items |
GoodsOwner | |||
---|---|---|---|
GoodsOwnerIdentification | enum | Must always be fixed string "SystemId" | |
GoodsOwnerCode | string(400) | The name/code of the client | |
GoodsOwnerId | int | Ongoing WMS internal id of the client | |
FinancialCode | string(50) | Financial code of the client | |
GoodsLocationCode | string(50) | Goods location code | |
CountryCode | string(2) | The two-letter ISO 3166-1 alpha-2 code of the country. | |
GoodsOwnerAddressName | string(200) | Address 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 |
InOrderLine | |||
---|---|---|---|
OrderLineIdentification | enum | Req. | Defines what you want to identify the inorder line by - ExternalOrderLineCode - ArticleNumber - ArticleName - ExternalOrderLineId - SystemId Most integrations use ArticleNumber or ExternalOrderLineCode. We also have a separate article with more information about order line identification. |
ArticleIdentification | enum | Req. | Defines what you want to identify the article by - ArticleNumber - SystemId - ProductCode - ArticleName Most integrationse use ArticleNumber. |
OrderLineSystemId | int | Ongoing WMS internal inorder line id. Required if OrderLineIdentification = SystemId | |
ExternalOrderLineCode | string(40) | External inorder line code. Insert row number of your system if needed. Preferred over ExternalOrderLineId Required if OrderLineIdentification = ExternalOrderLineCode | |
ExternalOrderLineId | string(30) | External inorder line id. Insert inorder line id of your system if needed. Not preferred. Use only ExternalOrderLineCode if you don't need two id fields. Required if OrderLineIdentification = ExternalOrderLineId | |
InvoiceNumber | string(100) | Invoice number of the inorder line | |
Indate | dateTime | Expected date of arrival to the warehouse | |
OrderLineComment | string(150) | Inorder line comment | |
ArticleSystemId | int | Ongoing WMS internal article id. Required if ArticleIdentification = SystemId | |
ArticleNumber | string(100) | Article number. Required if ArticleIdentification = ArticleNumber | |
ArticleName | string(200) | Article name. Required if ArticleIdentification = ArticleName | |
ArticleCode | string(200) | Omit | Deprecated, don't use |
CurrencyCode | string(20) | Currency code of the order line, in ISO 4217. E.g. SEK, NOK or EUR | |
NumberOfItems | decimal | Req. | Number of advised items on this inorder line |
RowPrice | decimal | Price of the inorder line | |
SupplierNumberOfItems | decimal | Supplier number of items | |
RowBatchNo | string(100) | Batch no of this inorder line | |
Items | InOrderLineArticleItem[] | Containing elements of InOrderLineArticleItem. Enabling advising specific article items with detailed info | |
ProductCode | string(200) | Article product code. Required if ArticleIdentification = ProductCode | |
ArticleDef | ArticleDefinition | An ArticleDefinition. This field allows you to send in various article data (such as weight, country of origin, etc) together with the inorder. Note: article data you send in this object will overwrite any the article data which might already exist in the system. |
|
InOrderLineFreeDecimal1 | decimal | Free decimal value 1 | |
InOrderLineFreeDateTime1 | dateTime | Free datetime value 1 | |
InOrderLineType | InOrderLineType | An object of type InOrderLineType, which defines what kind of line this is. | |
InOrderLineWeight | decimal | The weight of the inorder line. Note that this is a non-standard field which is not generally used. Please speak to Ongoing WMS if you want to use it. | |
InOrderLineArticleItemStatus | InOrderLineArticleItemStatus | An object of type InOrderLineArticleItemStatus, which defines the item status of the items which the warehouse will receive on this line. | |
InOrderLineSerial | string(128) | Serial no of this inorder line | |
InOrderLineExpirydate | dateTime | Expiry date of this inorder line | |
InOrderLineProductionDate | dateTime | Production date of this inorder line | |
InOrderLineFreeText1 | string(200) | Free text field. This field can for example be displayed on a delivery note. | |
InOrderLineFreeText2 | string(200) | Free text field. This field can for example be displayed on a delivery note. | |
InOrderLineReturnCause | ReturnCause | Return cause. Should only be used in the purchase order header has InOrderIsReturnType = true. | |
InOrderTextLines | InOrderTextLine[] | Containing elements of InOrderTextLine. |
InOrderTracking | |||
---|---|---|---|
Url | string(300) | The tracking URL for the inorder. | |
WayBill | string(50) | The tracking number for the inorder. |
WayOfDeliveryType | |||
---|---|---|---|
WayOfDeliveryTypeOperation | enum | Req. | Defines the operation - CreateOrUpdate - Find |
WayOfDeliveryTypeIdentification | enum | Req. | Defines what you want to identify the type by - Code - Name |
Code | string(50) | Way of delivery type code. Required if WayOfDeliveryTypeIdentification = Code | |
Name | string(100) | Way of delivery type name. Required if WayOfDeliveryTypeIdentification = Name |
InOrderType | |||
---|---|---|---|
InOrderTypeOperation | enum | Defines the operation - Find - CreateOrFind |
|
InOrderTypeIdentification | enum | Defines what you want to identify the type by - InOrderTypeCode - InOrderTypeName |
|
InOrderTypeCode | string(50) | Inorder type code. Required if OrderTypeIdentification = InOrderTypeCode | |
InOrderTypeName | string(50) | Inorder type name. Required if OrderTypeIdentification = InOrderTypeName |
TermsOfDeliveryType | |||
---|---|---|---|
TermsOfDeliveryTypeOperation | enum | Req. | Defines the operation - CreateOrUpdate - Find |
TermsOfDeliveryTypeIdentification | enum | Req. | Defines what you want to identify the type by - Code - Name |
Code | string(50) | Terms of delivery type code. Required if TermsOfDeliveryTypeIdentification = Code | |
Name | string(100) | Terms of delivery type name. Required if TermsOfDeliveryTypeIdentification = Name |
InOrderWarehouse | |||
---|---|---|---|
InOrderWarehouseIdentification | enum | Req. | Defines what you want to identify the warehouse by: - WarehouseCode - WarehouseName - WarehouseId |
InOrderWarehouseOperation | enum | Req. | Must be fixed string "Find" |
WarehouseName | string(200) | Warehouse name. Required if InOrderWarehouseIdentification = WarehouseName | |
WarehouseCode | string(50) | Warehouse code. Required if InOrderWarehouseIdentification = WarehouseCode | |
WarehouseId | int | Warehouse id. Required if InOrderWarehouseIdentification = WarehouseName |
InOrderClasses | |||
---|---|---|---|
Operation | enum | Req. | Defines the operation for each class: - Find - FindOrCreate Most integrations will use FindOrCreate |
Identification | enum | Req. | Defines what you want to identify each class. Currently there is only one type of valid identification: - Code - identifies the class using the code |
Classes | InOrderClass[] | Req. | A list of Class objects, each object representing one inorder class. |
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 | |
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 |
SupplierGroup | |||
---|---|---|---|
SupplierGroupOperation | enum | Req. | Defines the operation: - FindOrCreate - Clear |
SupplierGroupCode | string(50) | Req. | Supplier group code. Used for identification. |
SupplierGroupName | string(100) | Supplier group name. Used when creating new supplier group, disregarded otherwise. |
InOrderLineArticleItem | |||
---|---|---|---|
SavedArticleItemId | int | ||
OrderLineId | int | ||
Serial | string(128) | Serial no of item | |
ContainerNo | string(50) | Container no of item | |
Volume | decimal | Volume of item, in m3 | |
Weight | decimal | Weight of item, in kg | |
Length | decimal | Length of item, in m | |
Width | decimal | Width of item, in m | |
Height | decimal | Height of item, in m | |
SecondNumberOfItems | decimal | Alternative quantity | |
InOrderLineArticleItemStatus | InOrderLineArticleItemStatus | Article item status | |
Batch | string(50) | Batch no of item | |
ExpiryDate | dateTime | Expiry date of item | |
NumberOfItems | decimal | Number of items that this article item represents | |
Comment | string(400) | Comment | |
ArticleItemPrice | decimal | ||
ProductionDate | dateTime | Production date of item | |
PalletItem | InOrderLineArticleItemPalletItem | Object of type InOrderLineArticleItemPalletItem, representing the pallet item that this item is stored on. | |
ArticleItemClasses | InOrderLineArticleItemClass[] | ||
InOrderLineArticleItemIdentification | enum | An element of type InOrderLineArticleItemIdentification. | |
FreeText1 | string | Free text | |
InOrderLineArticleItemCategory | InOrderLineArticleItemCategory | Article item category |
InOrderLineType | |||
---|---|---|---|
InOrderLineTypeIdentificationType | enum | Req. | Defines what you want to identify the inorder line type by: - InOrderLineTypeName - InOrderLineTypeCode Most integrations use InOrderLineTypeCode |
InOrderLineTypeOperation | enum | Req. | Defines the operation (how the system should deal with the inorder line type if it has not already been created earlier): - CreateOrUpdate - Find Most integrations use CreateOrUpdate |
InOrderLineTypeCode | string | The code of the inorder line type | |
InOrderLineTypeName | string | The name of the inorder line type |
InOrderLineArticleItemStatus | |||
---|---|---|---|
InOrderLineArticleItemStatusIdentification | enum | Req. | Defines what you want to identify the article item status by - ArticleItemStatusId - ArticleItemStatusCode |
ArticleItemStatusId | int | Article item status id. Required if InOrderLineArticleItemStatusIdentification = ArticleItemStatusId | |
ArticleItemStatusCode | string(50) | Article item status code. Required if InOrderLineArticleItemStatusIdentification = ArticleItemStatusCode |
ReturnCause | |||
---|---|---|---|
ReturnCauseOperation | enum | Req. | What operation to perform when finding the return cause. - Find - FindOrCreate - SetUnknown |
ReturnCauseCode | string | Req. | The code of the return cause. |
ReturnCauseName | string | Req. | The name of the return cause. |
InOrderClass | |||
---|---|---|---|
Name | string(200) | The name of the class. | |
Code | string(200) | The code of the class. | |
Comment | string(500) | Comment. |
InOrderLineArticleItemPalletItem | |||
---|---|---|---|
Identification | enum | Req. | Defines what you want to identify the pallet item by. |
LabelId | string(30) | The label of the pallet item. | |
Weight | decimal | The weight of the pallet item. | |
Volume | decimal | The volume of the pallet item. | |
PalletType | InOrderLineArticleItemPalletType | Object of type InOrderLineArticleItemPalletType, representing the pallet type. | |
Handling | InOrderLineArticleItemPalletItemHandling | An element of type InOrderLineArticleItemPalletItemHandling. | |
TareWeight | decimal | The tare weight of the pallet item. | |
Length | decimal | The length of the pallet item. | |
Width | decimal | The width of the pallet item. | |
Height | decimal | The height of the pallet item. | |
ParentPalletItem | InOrderLineArticleItemPalletItemParent | An element of type InOrderLineArticleItemPalletItemParent. |
InOrderLineArticleItemClass | |||
---|---|---|---|
Identification | enum | Req. | Defines what you want to identify the article item class by. Must be Code. |
Code | string(100) | Code of article item class | |
Name | string(200) | Name of article item class | |
Id | int | Ongoing WMS internal id of the article item class |
InOrderLineArticleItemCategory | |||
---|---|---|---|
InOrderLineArticleItemCategoryIdentification | enum | Req. | Defines what you want to identify the article item status by - ArticleItemCategoryId - ArticleItemCategoryCode |
ArticleItemCategoryId | int | Article item category id. Required if InOrderLineArticleItemCategoryIdentification = ArticleItemCategoryId | |
ArticleItemCategoryCode | string(50) | Article item category code. Required if InOrderLineArticleItemCategoryIdentification = ArticleItemCategoryCode | |
ArticleItemCategoryName | string(50) | Article item category name. |
InOrderLineArticleItemPalletType | |||
---|---|---|---|
Identification | enum | Req. | Defines what you want to identify the pallet type by. Must be Code or Id. |
Id | int | The id of the pallet type. Required if Identification = Id | |
Code | string(50) | The pallet type code. Required if Identification = Code |
InOrderLineArticleItemPalletItemHandling | |||
---|---|---|---|
SetAsInOrderPalletItem | boolean |
InOrderLineArticleItemPalletItemParent | |||
---|---|---|---|
Identification | enum | Req. | Defines what you want to identify the pallet item by. |
LabelId | string(30) | The label of the pallet item. | |
Weight | decimal | The weight of the pallet item. | |
Volume | decimal | The volume of the pallet item. | |
PalletType | InOrderLineArticleItemPalletType | Object of type InOrderLineArticleItemPalletType, representing the pallet type. | |
TareWeight | decimal | The tare weight of the pallet item. | |
Length | decimal | The length of the pallet item. | |
Width | decimal | The width of the pallet item. | |
Height | decimal | The height of the pallet item. |
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>
<ProcessInOrderResponse xmlns="http://ongoingsystems.se/WSI">
<ProcessInOrderResult>
<ErrorMessage>string</ErrorMessage>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<OrderId>int</OrderId>
<InOrderId>int</InOrderId>
<ArticleDefId>int</ArticleDefId>
<Success>boolean</Success>
<Message>string</Message>
<ShipmentId>int</ShipmentId>
</ProcessInOrderResult>
</ProcessInOrderResponse>
</soap:Body>
</soap:Envelope>
Response specification
ProcessInOrderResponse | ||
---|---|---|
ProcessInOrderResult | 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 |