| POST | /dealers/order | Places a new order with the specified items. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports _2Service.Webservices.ServiceModel.Dealers
Imports _2Service.Webservices.ServiceModel
Namespace Global
Namespace _2Service.Webservices.ServiceModel
Public Partial Class OperationResult
'''<Summary>
'''Specifies if the operation was successful.
'''</Summary>
<ApiMember(Description:="Specifies if the operation was successful.", ParameterType:="model")>
Public Overridable Property IsSuccessful As Boolean
'''<Summary>
'''States error message in case of unsuccessful operation.
'''</Summary>
<ApiMember(Description:="States error message in case of unsuccessful operation.", ParameterType:="model")>
Public Overridable Property ErrorMessage As String
End Class
Public Partial Class OperationResult(Of T)
Inherits OperationResult
'''<Summary>
'''Result value
'''</Summary>
<ApiMember(Description:="Result value", ParameterType:="model")>
Public Overridable Property Result As PartResults
End Class
End Namespace
Namespace _2Service.Webservices.ServiceModel.Dealers
Public Partial Class AuthenticatedRequest
'''<Summary>
'''Session token received from successful authentication.
'''</Summary>
<ApiMember(Description:="Session token received from successful authentication.", IsRequired:=true, ParameterType:="query")>
Public Overridable Property SessionToken As String
End Class
Public Partial Class NewOrderAddress
Implements IAddress
'''<Summary>
'''Company name.
'''</Summary>
<ApiMember(Description:="Company name.", ParameterType:="body")>
Public Overridable Property CompanyName As String Implements IAddress.CompanyName
'''<Summary>
'''First name.
'''</Summary>
<ApiMember(Description:="First name.", ParameterType:="body")>
Public Overridable Property FirstName As String Implements IAddress.FirstName
'''<Summary>
'''Last name.
'''</Summary>
<ApiMember(Description:="Last name.", ParameterType:="body")>
Public Overridable Property LastName As String Implements IAddress.LastName
'''<Summary>
'''Street name.
'''</Summary>
<ApiMember(Description:="Street name.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property StreetName As String Implements IAddress.StreetName
'''<Summary>
'''House number.
'''</Summary>
<ApiMember(Description:="House number.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property HouseNumber As String Implements IAddress.HouseNumber
'''<Summary>
'''House number addition.
'''</Summary>
<ApiMember(Description:="House number addition.", ParameterType:="body")>
Public Overridable Property HouseNumberAddition As String Implements IAddress.HouseNumberAddition
'''<Summary>
'''Postal code.
'''</Summary>
<ApiMember(Description:="Postal code.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property PostalCode As String Implements IAddress.PostalCode
'''<Summary>
'''City.
'''</Summary>
<ApiMember(Description:="City.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property City As String Implements IAddress.City
'''<Summary>
'''Country code.
'''</Summary>
<ApiMember(Description:="Country code.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property CountryCode As String Implements IAddress.CountryCode
'''<Summary>
'''Telephone number.
'''</Summary>
<ApiMember(Description:="Telephone number.", ParameterType:="body")>
Public Overridable Property TelephoneNumber As String Implements IAddress.TelephoneNumber
End Class
Public Partial Class NewOrderItem
'''<Summary>
'''Unique ID for the part.
'''</Summary>
<ApiMember(Description:="Unique ID for the part.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property PartId As Integer
'''<Summary>
'''Quantity to order.
'''</Summary>
<ApiMember(Description:="Quantity to order.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property Quantity As Integer
'''<Summary>
'''Custom reference.
'''</Summary>
<ApiMember(Description:="Custom reference.", ParameterType:="body")>
Public Overridable Property Reference As String
End Class
Public Partial Class NewOrderItemList
Inherits List(Of NewOrderItem)
End Class
Public Partial Class NewOrderResponse
Inherits OperationResult(Of NewOrderResult)
End Class
Public Partial Class NewOrderResult
'''<Summary>
'''Number for the order that has been placed.
'''</Summary>
<ApiMember(Description:="Number for the order that has been placed.", ParameterType:="model")>
Public Overridable Property OrderNumber As String
End Class
Public Partial Class PartInfoResult
'''<Summary>
'''Unique ID for the part.
'''</Summary>
<ApiMember(Description:="Unique ID for the part.")>
Public Overridable Property Id As Integer
'''<Summary>
'''Part number.
'''</Summary>
<ApiMember(Description:="Part number.")>
Public Overridable Property PartNumber As String
'''<Summary>
'''Description of the part.
'''</Summary>
<ApiMember(Description:="Description of the part.")>
Public Overridable Property Description As String
'''<Summary>
'''Part manufacturer.
'''</Summary>
<ApiMember(Description:="Part manufacturer.")>
Public Overridable Property Manufacturer As String
'''<Summary>
'''Determines if the part can be ordered.
'''</Summary>
<ApiMember(Description:="Determines if the part can be ordered.")>
Public Overridable Property CanBeOrdered As Boolean
'''<Summary>
'''Textual representation of the status of the part.
'''</Summary>
<ApiMember(Description:="Textual representation of the status of the part.")>
Public Overridable Property StatusText As String
'''<Summary>
'''Available stock to order.
'''</Summary>
<ApiMember(Description:="Available stock to order.")>
Public Overridable Property AvailableStockQuantity As Integer
'''<Summary>
'''Average days needed for delivery.
'''</Summary>
<ApiMember(Description:="Average days needed for delivery.")>
Public Overridable Property AverageDeliveryInDays As Integer?
'''<Summary>
'''Price of a single unit, excluding VAT.
'''</Summary>
<ApiMember(Description:="Price of a single unit, excluding VAT.")>
Public Overridable Property UnitPrice As Decimal?
'''<Summary>
'''EAN number.
'''</Summary>
<ApiMember(Description:="EAN number.")>
Public Overridable Property EanNumber As String
'''<Summary>
'''Images
'''</Summary>
<ApiMember(Description:="Images")>
Public Overridable Property Images As List(Of PartInfoResultImage)
'''<Summary>
'''Secondary article numbers
'''</Summary>
<ApiMember(Description:="Secondary article numbers")>
Public Overridable Property SecondaryArticleNumbers As List(Of String)
'''<Summary>
'''Replacement article numbers
'''</Summary>
<ApiMember(Description:="Replacement article numbers")>
Public Overridable Property ReplacementArticleNumbers As List(Of String)
'''<Summary>
'''Stock quantities
'''</Summary>
<ApiMember(Description:="Stock quantities")>
Public Overridable Property StockQuantities As List(Of PartStockQuantity)
End Class
Public Partial Class PartInfoResultImage
'''<Summary>
'''Image number
'''</Summary>
<ApiMember(Description:="Image number")>
Public Overridable Property ImageNumber As Integer
'''<Summary>
'''Image URL
'''</Summary>
<ApiMember(Description:="Image URL")>
Public Overridable Property ImageUrl As String
End Class
Public Partial Class PartResults
'''<Summary>
'''Total number of parts available.
'''</Summary>
<ApiMember(Description:="Total number of parts available.")>
Public Overridable Property TotalNumberOfParts As Integer
'''<Summary>
'''Indication if there are more parts to retrieve.
'''</Summary>
<ApiMember(Description:="Indication if there are more parts to retrieve.")>
Public Overridable Property HasMoreRecords As Boolean
'''<Summary>
'''Part records.
'''</Summary>
<ApiMember(Description:="Part records.")>
Public Overridable Property Parts As List(Of PartInfoResult)
End Class
Public Partial Class PartStockQuantity
'''<Summary>
'''Location ID
'''</Summary>
<ApiMember(Description:="Location ID")>
Public Overridable Property LocationId As Integer
'''<Summary>
'''Location code
'''</Summary>
<ApiMember(Description:="Location code")>
Public Overridable Property LocationCode As String
'''<Summary>
'''Stock quantity in location
'''</Summary>
<ApiMember(Description:="Stock quantity in location")>
Public Overridable Property StockQuantity As Integer
End Class
Public Partial Class PostNewOrder
Inherits AuthenticatedRequest
'''<Summary>
'''Items to order.
'''</Summary>
<ApiMember(Description:="Items to order.", IsRequired:=true, ParameterType:="body")>
Public Overridable Property Items As NewOrderItemList
'''<Summary>
'''Dropshipment indication.
'''</Summary>
<ApiMember(Description:="Dropshipment indication.", ParameterType:="body")>
Public Overridable Property UseDropshipment As Boolean?
'''<Summary>
'''Delivery address.
'''</Summary>
<ApiMember(Description:="Delivery address.", ParameterType:="body")>
Public Overridable Property DeliveryAddress As NewOrderAddress
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /dealers/order HTTP/1.1
Host: services.acct.2service.nl
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Items":[{"PartId":0,"Quantity":0,"Reference":"String"}],"UseDropshipment":false,"DeliveryAddress":{"CompanyName":"String","FirstName":"String","LastName":"String","StreetName":"String","HouseNumber":"String","HouseNumberAddition":"String","PostalCode":"String","City":"String","CountryCode":"String","TelephoneNumber":"String"},"SessionToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Result":{"OrderNumber":"String"},"IsSuccessful":false,"ErrorMessage":"String"}