POST api/Orders
Request Information
URI Parameters
None.
Body Parameters
PostOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderType | integer |
None. |
|
| TransactionType | integer |
None. |
|
| OrderStatus | integer |
None. |
|
| OrderDate | integer |
None. |
|
| DueDate | integer |
None. |
|
| RequiredDeliveryDate | integer |
None. |
|
| CustomerNo | integer |
None. |
|
| OurReference | string |
None. |
|
| YourReference | string |
None. |
|
| ExternalReference | string |
None. |
|
| PurchaseReference | string |
None. |
|
| CurrencyNo | integer |
None. |
|
| SellersEmployeeNo | integer |
None. |
|
| PaymentMethod | integer |
None. |
|
| PaymentTerms | integer |
None. |
|
| Information6 | string |
None. |
|
| Group1 | integer |
None. |
|
| TaxCode | integer |
None. |
|
| OrgUnit1 | integer |
None. |
|
| DepartmentNo | integer |
None. |
|
| ProjectNo | string |
None. |
|
| DeliveryAssociateNo | integer |
None. |
|
| DeliveryName | string |
None. |
|
| DeliveryAddress1 | string |
None. |
|
| DeliveryAddress2 | string |
None. |
|
| DeliveryAddress3 | string |
None. |
|
| DeliveryAddress4 | string |
None. |
|
| DeliveryPostalArea | string |
None. |
|
| DeliveryPostCode | string |
None. |
|
| DeliveryCountryNo | integer |
None. |
|
| DeliveryLanguageNo | integer |
None. |
|
| InvoiceCustomerNo | integer |
None. |
|
| Name | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| Address3 | string |
None. |
|
| Address4 | string |
None. |
|
| PostalArea | string |
None. |
|
| PostCode | string |
None. |
|
| CountryNo | integer |
None. |
|
| LanguageNo | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"orderType": 1,
"transactionType": 2,
"orderStatus": 3,
"orderDate": 4,
"dueDate": 5,
"requiredDeliveryDate": 6,
"customerNo": 7,
"ourReference": "sample string 8",
"yourReference": "sample string 9",
"externalReference": "sample string 10",
"purchaseReference": "sample string 11",
"currencyNo": 12,
"sellersEmployeeNo": 13,
"paymentMethod": 14,
"paymentTerms": 15,
"information6": "sample string 16",
"group1": 17,
"taxCode": 18,
"orgUnit1": 19,
"departmentNo": 20,
"projectNo": "sample string 21",
"deliveryAssociateNo": 22,
"deliveryName": "sample string 23",
"deliveryAddress1": "sample string 24",
"deliveryAddress2": "sample string 25",
"deliveryAddress3": "sample string 26",
"deliveryAddress4": "sample string 27",
"deliveryPostalArea": "sample string 28",
"deliveryPostCode": "sample string 29",
"deliveryCountryNo": 30,
"deliveryLanguageNo": 31,
"invoiceCustomerNo": 32,
"name": "sample string 33",
"address1": "sample string 34",
"address2": "sample string 35",
"address3": "sample string 36",
"address4": "sample string 37",
"postalArea": "sample string 38",
"postCode": "sample string 39",
"countryNo": 40,
"languageNo": 41
}
application/xml, text/xml
Sample:
<PostOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController.Request"> <Address1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 34</Address1> <Address2 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 35</Address2> <Address3 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 36</Address3> <Address4 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 37</Address4> <CountryNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">40</CountryNo> <CurrencyNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">12</CurrencyNo> <CustomerNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">7</CustomerNo> <DeliveryAddress1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 24</DeliveryAddress1> <DeliveryAddress2 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 25</DeliveryAddress2> <DeliveryAddress3 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 26</DeliveryAddress3> <DeliveryAddress4 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 27</DeliveryAddress4> <DeliveryAssociateNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">22</DeliveryAssociateNo> <DeliveryCountryNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">30</DeliveryCountryNo> <DeliveryLanguageNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">31</DeliveryLanguageNo> <DeliveryName xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 23</DeliveryName> <DeliveryPostCode xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 29</DeliveryPostCode> <DeliveryPostalArea xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 28</DeliveryPostalArea> <DepartmentNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">20</DepartmentNo> <DueDate xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">5</DueDate> <ExternalReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 10</ExternalReference> <Group1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">17</Group1> <Information6 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 16</Information6> <InvoiceCustomerNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">32</InvoiceCustomerNo> <LanguageNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">41</LanguageNo> <Name xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 33</Name> <OrderDate xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">4</OrderDate> <OrderStatus xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">3</OrderStatus> <OrderType xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">1</OrderType> <OrgUnit1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">19</OrgUnit1> <OurReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 8</OurReference> <PaymentMethod xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">14</PaymentMethod> <PaymentTerms xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">15</PaymentTerms> <PostCode xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 39</PostCode> <PostalArea xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 38</PostalArea> <ProjectNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 21</ProjectNo> <PurchaseReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 11</PurchaseReference> <RequiredDeliveryDate xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">6</RequiredDeliveryDate> <SellersEmployeeNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">13</SellersEmployeeNo> <TaxCode xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">18</TaxCode> <TransactionType xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">2</TransactionType> <YourReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 9</YourReference> </PostOrder>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Order| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderNo | integer |
None. |
|
| OrderType | integer |
None. |
|
| TransactionType | integer |
None. |
|
| OrderStatus | integer |
None. |
|
| OrderDate | integer |
None. |
|
| DueDate | integer |
None. |
|
| RequiredDeliveryDate | integer |
None. |
|
| CustomerNo | integer |
None. |
|
| OurReference | string |
None. |
|
| YourReference | string |
None. |
|
| ExternalReference | string |
None. |
|
| PurchaseReference | string |
None. |
|
| CurrencyNo | integer |
None. |
|
| SellersEmployeeNo | integer |
None. |
|
| PaymentMethod | integer |
None. |
|
| PaymentTerms | integer |
None. |
|
| Information6 | string |
None. |
|
| Group1 | integer |
None. |
|
| TaxCode | integer |
None. |
|
| OrgUnit1 | integer |
None. |
|
| DepartmentNo | integer |
None. |
|
| ProjectNo | string |
None. |
|
| DeliveryAssociateNo | integer |
None. |
|
| DeliveryName | string |
None. |
|
| DeliveryAddress1 | string |
None. |
|
| DeliveryAddress2 | string |
None. |
|
| DeliveryAddress3 | string |
None. |
|
| DeliveryAddress4 | string |
None. |
|
| DeliveryPostalArea | string |
None. |
|
| DeliveryPostCode | string |
None. |
|
| DeliveryCountryNo | integer |
None. |
|
| DeliveryLanguageNo | integer |
None. |
|
| InvoiceCustomerNo | integer |
None. |
|
| Name | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| Address3 | string |
None. |
|
| Address4 | string |
None. |
|
| PostalArea | string |
None. |
|
| PostCode | string |
None. |
|
| CountryNo | integer |
None. |
|
| LanguageNo | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"orderNo": 1,
"orderType": 2,
"transactionType": 3,
"orderStatus": 4,
"orderDate": 5,
"dueDate": 6,
"requiredDeliveryDate": 7,
"customerNo": 8,
"ourReference": "sample string 9",
"yourReference": "sample string 10",
"externalReference": "sample string 11",
"purchaseReference": "sample string 12",
"currencyNo": 13,
"sellersEmployeeNo": 14,
"paymentMethod": 15,
"paymentTerms": 16,
"information6": "sample string 17",
"group1": 18,
"taxCode": 19,
"orgUnit1": 20,
"departmentNo": 21,
"projectNo": "sample string 22",
"deliveryAssociateNo": 23,
"deliveryName": "sample string 24",
"deliveryAddress1": "sample string 25",
"deliveryAddress2": "sample string 26",
"deliveryAddress3": "sample string 27",
"deliveryAddress4": "sample string 28",
"deliveryPostalArea": "sample string 29",
"deliveryPostCode": "sample string 30",
"deliveryCountryNo": 31,
"deliveryLanguageNo": 32,
"invoiceCustomerNo": 33,
"name": "sample string 34",
"address1": "sample string 35",
"address2": "sample string 36",
"address3": "sample string 37",
"address4": "sample string 38",
"postalArea": "sample string 39",
"postCode": "sample string 40",
"countryNo": 41,
"languageNo": 42
}
application/xml, text/xml
Sample:
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController.Response"> <Address1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 35</Address1> <Address2 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 36</Address2> <Address3 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 37</Address3> <Address4 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 38</Address4> <CountryNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">41</CountryNo> <CurrencyNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">13</CurrencyNo> <CustomerNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">8</CustomerNo> <DeliveryAddress1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 25</DeliveryAddress1> <DeliveryAddress2 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 26</DeliveryAddress2> <DeliveryAddress3 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 27</DeliveryAddress3> <DeliveryAddress4 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 28</DeliveryAddress4> <DeliveryAssociateNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">23</DeliveryAssociateNo> <DeliveryCountryNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">31</DeliveryCountryNo> <DeliveryLanguageNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">32</DeliveryLanguageNo> <DeliveryName xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 24</DeliveryName> <DeliveryPostCode xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 30</DeliveryPostCode> <DeliveryPostalArea xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 29</DeliveryPostalArea> <DepartmentNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">21</DepartmentNo> <DueDate xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">6</DueDate> <ExternalReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 11</ExternalReference> <Group1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">18</Group1> <Information6 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 17</Information6> <InvoiceCustomerNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">33</InvoiceCustomerNo> <LanguageNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">42</LanguageNo> <Name xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 34</Name> <OrderDate xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">5</OrderDate> <OrderStatus xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">4</OrderStatus> <OrderType xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">2</OrderType> <OrgUnit1 xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">20</OrgUnit1> <OurReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 9</OurReference> <PaymentMethod xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">15</PaymentMethod> <PaymentTerms xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">16</PaymentTerms> <PostCode xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 40</PostCode> <PostalArea xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 39</PostalArea> <ProjectNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 22</ProjectNo> <PurchaseReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 12</PurchaseReference> <RequiredDeliveryDate xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">7</RequiredDeliveryDate> <SellersEmployeeNo xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">14</SellersEmployeeNo> <TaxCode xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">19</TaxCode> <TransactionType xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">3</TransactionType> <YourReference xmlns="http://schemas.datacontract.org/2004/07/VismaBusinessWebAPI.Models.WebAPI.Controllers.OrdersController">sample string 10</YourReference> <OrderNo>1</OrderNo> </Order>