POST api/Sendout

The entry point for sending out giftcards

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional 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": "bb6cc362-1086-47d8-b307-166f46718b8c",
  "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": "2024-12-03T18:54:24.5668+01: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": "2024-12-03T18:54:24.5668+01: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": "2024-12-03T18:54:24.5668+01:00",
    "token": "ddbef614-64a2-4ad6-963c-d708072c1ae0",
    "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>bb6cc362-1086-47d8-b307-166f46718b8c</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">ddbef614-64a2-4ad6-963c-d708072c1ae0</Token>
    <Expires>2024-12-03T18:54:24.5668+01: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>2024-12-03T18:54:24.5668+01: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>2024-12-03T18:54:24.5668+01:00</DeliveryDatetime>
      <DeliveryMethod>None</DeliveryMethod>
    </SendoutController.SendoutReceiverInfo>
  </Receiver>
</SendoutController.SendoutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

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.