POST api/Orders

Creates a new order

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
OfferID		globally unique identifier	None.
CustomerID		globally unique identifier	None.
Status		OrderStatus	None.
NumberOfItems	Number of items ordered	integer	None.
Notes		string	None.

Request Formats

application/json, text/json

Sample:

{
  "OfferID": "5249acab-4cec-4a4c-bd83-72d92e8a24dd",
  "CustomerID": "8c5982bb-57ba-4212-9338-0bfd6aaff5c9",
  "Status": "Pending",
  "NumberOfItems": 3,
  "Notes": "sample string 4"
}

application/xml, text/xml

Sample:

<OrderValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels">
  <CustomerID>8c5982bb-57ba-4212-9338-0bfd6aaff5c9</CustomerID>
  <Notes>sample string 4</Notes>
  <NumberOfItems>3</NumberOfItems>
  <OfferID>5249acab-4cec-4a4c-bd83-72d92e8a24dd</OfferID>
  <Status>Pending</Status>
</OrderValues>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OfferID"

5249acab-4cec-4a4c-bd83-72d92e8a24dd
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerID"

8c5982bb-57ba-4212-9338-0bfd6aaff5c9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

Pending
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NumberOfItems"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

OrderDetail

Name	Type	Additional information
OrderID	globally unique identifier	None.
Number	integer	None.
Offer	OfferPreview	None.
Customer	CustomerPreview	None.
CreatedUser	UserPreview	None.
Date	date	None.
Status	OrderStatus	None.
NumberOfItems	integer	None.
Amount	decimal number	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderID": "2d0e361f-51f4-4a09-81b0-6f9d32dd6b7a",
  "Number": 2,
  "Offer": {
    "OfferID": "f7c789e3-37bc-42a9-aca7-153caaaaddd6",
    "Title": "sample string 2",
    "GrossAmount": 3.1,
    "SalesAmount": 4.1,
    "DiscountPercent": 5.1,
    "Supplier": {
      "SupplierID": "6bd90f0f-0c8e-4347-8d84-e3937f2b5aa8",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "IsBackendSupplier": true,
      "LogoBlobUrl": "sample string 5"
    },
    "Category": {
      "CategoryID": "57977165-8b2f-4068-acef-bb9df3d32515",
      "ParentName": "sample string 2",
      "Name": "sample string 3"
    },
    "Status": "InActive",
    "HeaderText": "sample string 6",
    "IsProductionIncluded": true,
    "ItemsAvailable": 8,
    "Image1BlobUrl": "sample string 9",
    "ValidFrom": "2026-06-28T15:42:49.0811241Z",
    "ValidTo": "2026-06-28T15:42:49.0811241Z",
    "IsPrivate": true,
    "IsFeatured": true
  },
  "Customer": {
    "CustomerID": "98e49c07-f1ba-4eb7-b3c3-c8b4feb3a02f",
    "ParentName": "sample string 2",
    "Name": "sample string 3",
    "Status": "InActive",
    "Address": "sample string 4",
    "City": "sample string 5",
    "PostalCode": "sample string 6",
    "Country": "sample string 7",
    "IsBackendCustomer": true,
    "LogoBlobUrl": "sample string 9"
  },
  "CreatedUser": {
    "UserID": "d8b37392-3b59-4aed-ae10-ed1a31d25448",
    "FullName": "sample string 2",
    "Type": "Operator",
    "Role": "User",
    "EmailAddress": "sample string 3",
    "PhoneNumber": "sample string 4",
    "LinkedObjectName": "sample string 5",
    "LinkedObjectID": "sample string 6",
    "Status": "InActive",
    "IsSubscribed": true
  },
  "Date": "2026-06-28T15:42:49.0811241Z",
  "Status": "Pending",
  "NumberOfItems": 4,
  "Amount": 5.1,
  "Notes": "sample string 6",
  "CreatedAt": "2026-06-28T15:42:49.0811241Z",
  "CreatedBy": "sample string 8",
  "ModifiedAt": "2026-06-28T15:42:49.0811241Z",
  "ModifiedBy": "sample string 10"
}

application/xml, text/xml

Sample:

<OrderDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdStore.Api.ViewModels">
  <Amount>5.1</Amount>
  <CreatedAt>2026-06-28T15:42:49.0811241+00:00</CreatedAt>
  <CreatedBy>sample string 8</CreatedBy>
  <CreatedUser>
    <EmailAddress>sample string 3</EmailAddress>
    <FullName>sample string 2</FullName>
    <IsSubscribed>true</IsSubscribed>
    <LinkedObjectID>sample string 6</LinkedObjectID>
    <LinkedObjectName>sample string 5</LinkedObjectName>
    <PhoneNumber>sample string 4</PhoneNumber>
    <Role>User</Role>
    <Status>InActive</Status>
    <Type>Operator</Type>
    <UserID>d8b37392-3b59-4aed-ae10-ed1a31d25448</UserID>
  </CreatedUser>
  <Customer>
    <Address>sample string 4</Address>
    <City>sample string 5</City>
    <Country>sample string 7</Country>
    <CustomerID>98e49c07-f1ba-4eb7-b3c3-c8b4feb3a02f</CustomerID>
    <IsBackendCustomer>true</IsBackendCustomer>
    <LogoBlobUrl>sample string 9</LogoBlobUrl>
    <Name>sample string 3</Name>
    <ParentName>sample string 2</ParentName>
    <PostalCode>sample string 6</PostalCode>
    <Status>InActive</Status>
  </Customer>
  <Date>2026-06-28T15:42:49.0811241+00:00</Date>
  <ModifiedAt>2026-06-28T15:42:49.0811241+00:00</ModifiedAt>
  <ModifiedBy>sample string 10</ModifiedBy>
  <Notes>sample string 6</Notes>
  <Number>2</Number>
  <NumberOfItems>4</NumberOfItems>
  <Offer>
    <Category>
      <CategoryID>57977165-8b2f-4068-acef-bb9df3d32515</CategoryID>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
    </Category>
    <DiscountPercent>5.1</DiscountPercent>
    <GrossAmount>3.1</GrossAmount>
    <HeaderText>sample string 6</HeaderText>
    <Image1BlobUrl>sample string 9</Image1BlobUrl>
    <IsFeatured>true</IsFeatured>
    <IsPrivate>true</IsPrivate>
    <IsProductionIncluded>true</IsProductionIncluded>
    <ItemsAvailable>8</ItemsAvailable>
    <OfferID>f7c789e3-37bc-42a9-aca7-153caaaaddd6</OfferID>
    <SalesAmount>4.1</SalesAmount>
    <Status>InActive</Status>
    <Supplier>
      <IsBackendSupplier>true</IsBackendSupplier>
      <LogoBlobUrl>sample string 5</LogoBlobUrl>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <Status>InActive</Status>
      <SupplierID>6bd90f0f-0c8e-4347-8d84-e3937f2b5aa8</SupplierID>
    </Supplier>
    <Title>sample string 2</Title>
    <ValidFrom>2026-06-28T15:42:49.0811241+00:00</ValidFrom>
    <ValidTo>2026-06-28T15:42:49.0811241+00:00</ValidTo>
  </Offer>
  <OrderID>2d0e361f-51f4-4a09-81b0-6f9d32dd6b7a</OrderID>
  <Status>Pending</Status>
</OrderDetail>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderID"

2d0e361f-51f4-4a09-81b0-6f9d32dd6b7a
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Number"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.OfferID"

f7c789e3-37bc-42a9-aca7-153caaaaddd6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Title"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.GrossAmount"

3,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.SalesAmount"

4,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.DiscountPercent"

5,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Supplier.SupplierID"

6bd90f0f-0c8e-4347-8d84-e3937f2b5aa8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Supplier.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Supplier.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Supplier.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Supplier.IsBackendSupplier"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Supplier.LogoBlobUrl"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Category.CategoryID"

57977165-8b2f-4068-acef-bb9df3d32515
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Category.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Category.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.HeaderText"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.IsProductionIncluded"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.ItemsAvailable"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.Image1BlobUrl"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.ValidFrom"

2026-06-28T15:42:49.0811241+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.ValidTo"

2026-06-28T15:42:49.0811241+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.IsPrivate"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Offer.IsFeatured"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.CustomerID"

98e49c07-f1ba-4eb7-b3c3-c8b4feb3a02f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.City"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.PostalCode"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.Country"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.IsBackendCustomer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Customer.LogoBlobUrl"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.UserID"

d8b37392-3b59-4aed-ae10-ed1a31d25448
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.FullName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.Type"

Operator
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.Role"

User
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.EmailAddress"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.PhoneNumber"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.LinkedObjectName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.LinkedObjectID"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedUser.IsSubscribed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Date"

2026-06-28T15:42:49.0811241+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

Pending
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NumberOfItems"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Amount"

5,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2026-06-28T15:42:49.0811241+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2026-06-28T15:42:49.0811241+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e--