POST api/me/orders

Places an order for an exising customer, requires authentication

Request Information

URI Parameters

None.

Body Parameters

Order details and optional customer details

UpdatedCustomerOrderDTO
NameDescriptionTypeAdditional information
UserID

ID of the Webb-SMS User placing the order

integer

None.

UserReference

ID of the iP.1 User placing the order

globally unique identifier

None.

Customer

Updated customer details, if an update is desired

UpdateCustomerDTO

None.

Invoice

Whether the order will be paid by invoice

boolean

None.

Items

Items in the order

Collection of OrderItemDTO

Required

Request Formats

application/json, text/json

Sample:
{
  "UserID": 1,
  "UserReference": "e5cbff24-bfb8-4e31-96f0-2dcf6d87c0f5",
  "Customer": {
    "ID": 1,
    "OrgNr": "sample string 2",
    "VAT": "sample string 3",
    "Name": "sample string 4",
    "Address1": "sample string 5",
    "Address2": "sample string 6",
    "ZIP": "sample string 7",
    "City": "sample string 8",
    "CountryID": 9,
    "InvoiceReference": "sample string 10",
    "InvoiceEmail": "sample string 11"
  },
  "Invoice": true,
  "Items": [
    {
      "ProductID": 1,
      "Amount": 1.0,
      "Level": 1,
      "Auto": true
    },
    {
      "ProductID": 1,
      "Amount": 1.0,
      "Level": 1,
      "Auto": true
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Order details

OrderDTO
NameDescriptionTypeAdditional information
ID

Order ID

integer

None.

CustomerID

ID of ordering customer

integer

None.

AccountID

ID of receiving account

string

None.

UserID

ID of responsible Webb-SMS User

integer

None.

UserReference

ID of responsible iP.1 User

globally unique identifier

None.

Processed

Whether the order has been processed

boolean

None.

CreatedDate

When the order was placed

date

None.

ModifiedDate

When order details were last updated

date

None.

Items

Items in the order

Collection of OrderItemDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "CustomerID": 2,
  "AccountID": "sample string 3",
  "UserID": 4,
  "UserReference": "1365a8da-90ab-4372-b2d2-ed41eacc0983",
  "Processed": true,
  "CreatedDate": "2020-09-04T04:01:30.580739+00:00",
  "ModifiedDate": "2020-09-04T04:01:30.580739+00:00",
  "Items": [
    {
      "ProductID": 1,
      "Amount": 1.0,
      "Level": 1,
      "Auto": true
    },
    {
      "ProductID": 1,
      "Amount": 1.0,
      "Level": 1,
      "Auto": true
    }
  ]
}