POST api/Sendout

The entry point for sending out giftcards

Request Information

URI Parameters

None.

Body Parameters

SendoutRequest
NameDescriptionTypeAdditional information
AuthToken

Your unique partner identification token

globally unique identifier

Required

Buyer

All the information about the buyer

SendoutBuyerInfo

Required

Receiver

A list of all the receivers

Collection of SendoutReceiverInfo

Required

Product

The product to send out to the receivers

SendoutProductInfo

Required

Request Formats

application/json, text/json

Sample:
{
  "authToken": "df70bb05-4f98-4f5b-951e-585f0245e2d3",
  "buyer": {
    "name": "sample string 1",
    "companyName": "sample string 2",
    "email": "sample string 3",
    "number": 1,
    "refID": "sample string 4",
    "transactionID": "sample string 5",
    "ip": "sample string 6"
  },
  "receiver": [
    {
      "deliveryMethod": 0,
      "deliveryDatetime": "2018-09-21T19:04:34.6432316+02:00",
      "nameOrCompanyName": "sample string 1",
      "careOfOrAttention": "sample string 2",
      "email": "sample string 3",
      "number": 1,
      "address": "sample string 4",
      "messengerID": "sample string 5",
      "zipcode": "sample string 6",
      "city": "sample string 7",
      "message": "sample string 8"
    },
    {
      "deliveryMethod": 0,
      "deliveryDatetime": "2018-09-21T19:04:34.6432316+02:00",
      "nameOrCompanyName": "sample string 1",
      "careOfOrAttention": "sample string 2",
      "email": "sample string 3",
      "number": 1,
      "address": "sample string 4",
      "messengerID": "sample string 5",
      "zipcode": "sample string 6",
      "city": "sample string 7",
      "message": "sample string 8"
    }
  ],
  "product": {
    "expires": "2018-09-21T19:04:34.6432316+02:00",
    "token": "4b777bdd-6408-45c2-b7d4-f760ad9840b1",
    "generateGiftcard": true,
    "generatedGiftcardValue": 1,
    "deliveryForm": 0
  }
}

application/xml, text/xml

Sample:
<SendoutController.SendoutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Controllers">
  <AuthToken>df70bb05-4f98-4f5b-951e-585f0245e2d3</AuthToken>
  <Buyer>
    <CompanyName xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 2</CompanyName>
    <Email xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 3</Email>
    <IP xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 6</IP>
    <Name xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 1</Name>
    <Number xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">1</Number>
    <RefID xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 4</RefID>
    <TransactionID xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 5</TransactionID>
  </Buyer>
  <Product>
    <DeliveryForm xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">DelegatedCoupon</DeliveryForm>
    <GenerateGiftcard xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">true</GenerateGiftcard>
    <GeneratedGiftcardValue xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">1</GeneratedGiftcardValue>
    <Token xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">4b777bdd-6408-45c2-b7d4-f760ad9840b1</Token>
    <Expires>2018-09-21T19:04:34.6432316+02:00</Expires>
  </Product>
  <Receiver>
    <SendoutController.SendoutReceiverInfo>
      <Address xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 4</Address>
      <CareOfOrAttention xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 2</CareOfOrAttention>
      <City xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 7</City>
      <DeliveryDatetime i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models" />
      <Email xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 3</Email>
      <Message xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 8</Message>
      <MessengerID xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 5</MessengerID>
      <NameOrCompanyName xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 1</NameOrCompanyName>
      <Number xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">1</Number>
      <Zipcode xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 6</Zipcode>
      <DeliveryDatetime>2018-09-21T19:04:34.6432316+02:00</DeliveryDatetime>
      <DeliveryMethod>None</DeliveryMethod>
    </SendoutController.SendoutReceiverInfo>
    <SendoutController.SendoutReceiverInfo>
      <Address xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 4</Address>
      <CareOfOrAttention xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 2</CareOfOrAttention>
      <City xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 7</City>
      <DeliveryDatetime i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models" />
      <Email xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 3</Email>
      <Message xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 8</Message>
      <MessengerID xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 5</MessengerID>
      <NameOrCompanyName xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 1</NameOrCompanyName>
      <Number xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">1</Number>
      <Zipcode xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 6</Zipcode>
      <DeliveryDatetime>2018-09-21T19:04:34.6432316+02:00</DeliveryDatetime>
      <DeliveryMethod>None</DeliveryMethod>
    </SendoutController.SendoutReceiverInfo>
  </Receiver>
</SendoutController.SendoutRequest>

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 'SendoutRequest'.

Response Information

Resource Description

Object containing all the information of buyer, product and receivers.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.