POST merchants/{merchantId}/orders

Request Information

URI Parameters

Name	Description	Type	Additional information
merchantId		integer	Required

Body Parameters

Collection of Order

Name	Type	Additional information
CouponConfiguration	integer	None.
Buyer	Person	None.
Recipient	Person	None.
PersonalMessage	string	None.
DeliveryMethod	integer	Range: inclusive between 1 and 6
DeliveryDate	date	None.
NumOfCoupons	integer	Range: inclusive between 1 and 99
EnvelopId	integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "CouponConfiguration": 1,
    "Buyer": {
      "Firstname": "sample string 1",
      "Infix": "sample string 2",
      "Lastname": "sample string 3",
      "Emailaddress": "sample string 4",
      "Telephonenumber": "sample string 5",
      "Newsletter": true,
      "Postaddress": "sample string 7",
      "Postcode": "sample string 8",
      "City": "sample string 9"
    },
    "Recipient": {
      "Firstname": "sample string 1",
      "Infix": "sample string 2",
      "Lastname": "sample string 3",
      "Emailaddress": "sample string 4",
      "Telephonenumber": "sample string 5",
      "Newsletter": true,
      "Postaddress": "sample string 7",
      "Postcode": "sample string 8",
      "City": "sample string 9"
    },
    "PersonalMessage": "sample string 2",
    "DeliveryMethod": 3,
    "DeliveryDate": "2025-12-06T07:18:37.6821141+01:00",
    "NumOfCoupons": 5,
    "EnvelopId": 6
  },
  {
    "CouponConfiguration": 1,
    "Buyer": {
      "Firstname": "sample string 1",
      "Infix": "sample string 2",
      "Lastname": "sample string 3",
      "Emailaddress": "sample string 4",
      "Telephonenumber": "sample string 5",
      "Newsletter": true,
      "Postaddress": "sample string 7",
      "Postcode": "sample string 8",
      "City": "sample string 9"
    },
    "Recipient": {
      "Firstname": "sample string 1",
      "Infix": "sample string 2",
      "Lastname": "sample string 3",
      "Emailaddress": "sample string 4",
      "Telephonenumber": "sample string 5",
      "Newsletter": true,
      "Postaddress": "sample string 7",
      "Postcode": "sample string 8",
      "City": "sample string 9"
    },
    "PersonalMessage": "sample string 2",
    "DeliveryMethod": 3,
    "DeliveryDate": "2025-12-06T07:18:37.6821141+01:00",
    "NumOfCoupons": 5,
    "EnvelopId": 6
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiTestKBO.Models">
  <Order>
    <Buyer>
      <City>sample string 9</City>
      <Emailaddress>sample string 4</Emailaddress>
      <Firstname>sample string 1</Firstname>
      <Infix>sample string 2</Infix>
      <Lastname>sample string 3</Lastname>
      <Newsletter>true</Newsletter>
      <Postaddress>sample string 7</Postaddress>
      <Postcode>sample string 8</Postcode>
      <Telephonenumber>sample string 5</Telephonenumber>
    </Buyer>
    <CouponConfiguration>1</CouponConfiguration>
    <DeliveryDate>2025-12-06T07:18:37.6821141+01:00</DeliveryDate>
    <DeliveryMethod>3</DeliveryMethod>
    <EnvelopId>6</EnvelopId>
    <NumOfCoupons>5</NumOfCoupons>
    <PersonalMessage>sample string 2</PersonalMessage>
    <Recipient>
      <City>sample string 9</City>
      <Emailaddress>sample string 4</Emailaddress>
      <Firstname>sample string 1</Firstname>
      <Infix>sample string 2</Infix>
      <Lastname>sample string 3</Lastname>
      <Newsletter>true</Newsletter>
      <Postaddress>sample string 7</Postaddress>
      <Postcode>sample string 8</Postcode>
      <Telephonenumber>sample string 5</Telephonenumber>
    </Recipient>
  </Order>
  <Order>
    <Buyer>
      <City>sample string 9</City>
      <Emailaddress>sample string 4</Emailaddress>
      <Firstname>sample string 1</Firstname>
      <Infix>sample string 2</Infix>
      <Lastname>sample string 3</Lastname>
      <Newsletter>true</Newsletter>
      <Postaddress>sample string 7</Postaddress>
      <Postcode>sample string 8</Postcode>
      <Telephonenumber>sample string 5</Telephonenumber>
    </Buyer>
    <CouponConfiguration>1</CouponConfiguration>
    <DeliveryDate>2025-12-06T07:18:37.6821141+01:00</DeliveryDate>
    <DeliveryMethod>3</DeliveryMethod>
    <EnvelopId>6</EnvelopId>
    <NumOfCoupons>5</NumOfCoupons>
    <PersonalMessage>sample string 2</PersonalMessage>
    <Recipient>
      <City>sample string 9</City>
      <Emailaddress>sample string 4</Emailaddress>
      <Firstname>sample string 1</Firstname>
      <Infix>sample string 2</Infix>
      <Lastname>sample string 3</Lastname>
      <Newsletter>true</Newsletter>
      <Postaddress>sample string 7</Postaddress>
      <Postcode>sample string 8</Postcode>
      <Telephonenumber>sample string 5</Telephonenumber>
    </Recipient>
  </Order>
</ArrayOfOrder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.