POST api/v1/{companyId}/order

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		string	Required

Body Parameters

OrderModel

Name	Type	Additional information
OrderId	string	None.
VismaOrderId	integer	None.
CustomerId	integer	None.
RequisitionId	string	None.
YourReference	string	None.
OrderComment	string	None.
InvoiceAddress	Address	None.
DeliveryAddress	Address	None.
Lines	Collection of OrderLineModel	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": "sample string 1",
  "VismaOrderId": 1,
  "CustomerId": 2,
  "RequisitionId": "sample string 3",
  "YourReference": "sample string 4",
  "OrderComment": "sample string 5",
  "InvoiceAddress": {
    "AddressId": 1,
    "Name": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "PostCode": "sample string 5",
    "PostalArea": "sample string 6",
    "CountryName": "sample string 7",
    "CountryIso": "sample string 8"
  },
  "DeliveryAddress": {
    "AddressId": 1,
    "Name": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "PostCode": "sample string 5",
    "PostalArea": "sample string 6",
    "CountryName": "sample string 7",
    "CountryIso": "sample string 8"
  },
  "Lines": [
    {
      "VismaLineId": 1,
      "ProductId": "sample string 1",
      "Description": "sample string 2",
      "Price": 1.0,
      "Quantity": 1.0
    },
    {
      "VismaLineId": 1,
      "ProductId": "sample string 1",
      "Description": "sample string 2",
      "Price": 1.0,
      "Quantity": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<OrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TreeOfPets.LitiumIntegration.Api.Models">
  <CustomerId>2</CustomerId>
  <DeliveryAddress>
    <AddressId>1</AddressId>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <CountryIso>sample string 8</CountryIso>
    <CountryName>sample string 7</CountryName>
    <Name>sample string 2</Name>
    <PostCode>sample string 5</PostCode>
    <PostalArea>sample string 6</PostalArea>
  </DeliveryAddress>
  <InvoiceAddress>
    <AddressId>1</AddressId>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <CountryIso>sample string 8</CountryIso>
    <CountryName>sample string 7</CountryName>
    <Name>sample string 2</Name>
    <PostCode>sample string 5</PostCode>
    <PostalArea>sample string 6</PostalArea>
  </InvoiceAddress>
  <Lines>
    <OrderLineModel>
      <Description>sample string 2</Description>
      <Price>1</Price>
      <ProductId>sample string 1</ProductId>
      <Quantity>1</Quantity>
      <VismaLineId>1</VismaLineId>
    </OrderLineModel>
    <OrderLineModel>
      <Description>sample string 2</Description>
      <Price>1</Price>
      <ProductId>sample string 1</ProductId>
      <Quantity>1</Quantity>
      <VismaLineId>1</VismaLineId>
    </OrderLineModel>
  </Lines>
  <OrderComment>sample string 5</OrderComment>
  <OrderId>sample string 1</OrderId>
  <RequisitionId>sample string 3</RequisitionId>
  <VismaOrderId>1</VismaOrderId>
  <YourReference>sample string 4</YourReference>
</OrderModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderModel'.

Response Information

Resource Description

OrderModel

Name	Type	Additional information
OrderId	string	None.
VismaOrderId	integer	None.
CustomerId	integer	None.
RequisitionId	string	None.
YourReference	string	None.
OrderComment	string	None.
InvoiceAddress	Address	None.
DeliveryAddress	Address	None.
Lines	Collection of OrderLineModel	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": "sample string 1",
  "VismaOrderId": 1,
  "CustomerId": 2,
  "RequisitionId": "sample string 3",
  "YourReference": "sample string 4",
  "OrderComment": "sample string 5",
  "InvoiceAddress": {
    "AddressId": 1,
    "Name": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "PostCode": "sample string 5",
    "PostalArea": "sample string 6",
    "CountryName": "sample string 7",
    "CountryIso": "sample string 8"
  },
  "DeliveryAddress": {
    "AddressId": 1,
    "Name": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "PostCode": "sample string 5",
    "PostalArea": "sample string 6",
    "CountryName": "sample string 7",
    "CountryIso": "sample string 8"
  },
  "Lines": [
    {
      "VismaLineId": 1,
      "ProductId": "sample string 1",
      "Description": "sample string 2",
      "Price": 1.0,
      "Quantity": 1.0
    },
    {
      "VismaLineId": 1,
      "ProductId": "sample string 1",
      "Description": "sample string 2",
      "Price": 1.0,
      "Quantity": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<OrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TreeOfPets.LitiumIntegration.Api.Models">
  <CustomerId>2</CustomerId>
  <DeliveryAddress>
    <AddressId>1</AddressId>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <CountryIso>sample string 8</CountryIso>
    <CountryName>sample string 7</CountryName>
    <Name>sample string 2</Name>
    <PostCode>sample string 5</PostCode>
    <PostalArea>sample string 6</PostalArea>
  </DeliveryAddress>
  <InvoiceAddress>
    <AddressId>1</AddressId>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <CountryIso>sample string 8</CountryIso>
    <CountryName>sample string 7</CountryName>
    <Name>sample string 2</Name>
    <PostCode>sample string 5</PostCode>
    <PostalArea>sample string 6</PostalArea>
  </InvoiceAddress>
  <Lines>
    <OrderLineModel>
      <Description>sample string 2</Description>
      <Price>1</Price>
      <ProductId>sample string 1</ProductId>
      <Quantity>1</Quantity>
      <VismaLineId>1</VismaLineId>
    </OrderLineModel>
    <OrderLineModel>
      <Description>sample string 2</Description>
      <Price>1</Price>
      <ProductId>sample string 1</ProductId>
      <Quantity>1</Quantity>
      <VismaLineId>1</VismaLineId>
    </OrderLineModel>
  </Lines>
  <OrderComment>sample string 5</OrderComment>
  <OrderId>sample string 1</OrderId>
  <RequisitionId>sample string 3</RequisitionId>
  <VismaOrderId>1</VismaOrderId>
  <YourReference>sample string 4</YourReference>
</OrderModel>