GET api/UniqueOffers/ByBarcodeId/{barcodeId}

Get UniqueOffer by BarcodeId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
barcodeId

BarcodeId for the UniqueOffer

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a UniqueOffer

UniqueOffer
NameDescriptionTypeAdditional information
Id

GUID Id for UniqueOffer. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

OfferId

The OfferId for the Offer. [NULLABLE]

globally unique identifier

None.

ConsumerId

The ConsumerId for the Consumer. [NULLABLE]

globally unique identifier

None.

BarcodeId

The BarcodeId for the Barcode. [NULLABLE]

globally unique identifier

None.

Discount

The OfferReward Reward. [NULL]

string

String length: inclusive between 0 and 255

ShareDiscount

The OfferReward Reward once the share reward has been earned. [NULL]

string

None.

RedeemDiscount

The OfferReward Reward once the redemption reward has been earned. [NULL]

string

String length: inclusive between 0 and 255

Timestamp

Indicates when the UniqueOffer was created. [NULLABLE]

date

None.

Offer

Gets the Offer using OfferId.

Offer

None.

Consumer

Gets the Consumer using ConsumerId.

Consumer

None.

Barcode

Gets the Bardcode using BarcodeId.

Barcode

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "1a76e5c6-0155-4f37-8b11-24b17b9197ac",
  "OfferId": "8815dcd9-661e-44a2-b8ff-9a8207d2869c",
  "ConsumerId": "1206bc10-26ff-426f-98d5-f2ea970105dd",
  "BarcodeId": "39a4b907-4ed3-4dd0-b1d9-11764ff46c74",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-12-12T05:46:34.327566+00:00",
  "Offer": {
    "$id": "2",
    "Id": "9d93403d-ef04-4a55-bfda-3e0215be56bf",
    "MerchantId": "6dba871a-9cdf-4217-9851-8fca0bf6604f",
    "AppId": "8f449edf-5c85-4b18-80af-00147b674a89",
    "Type": 0,
    "Reward": "sample string 4",
    "IsRewardBased": true,
    "Name": "sample string 5",
    "Description": "sample string 6",
    "TermsConditions": "sample string 7",
    "Tags": "sample string 8",
    "StartDate": "2018-12-12T05:46:34.327566+00:00",
    "EndDate": "2018-12-12T05:46:34.327566+00:00",
    "ExpiryDate": "2018-12-12T05:46:34.327566+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T05:46:34.327566+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "8e3f6d65-6871-4c50-bbb9-452f624b9940",
      "PlanId": "1549e4e2-d40d-4ff1-97af-538091a14b12",
      "StripeToken": "sample string 2",
      "StripeCustomerId": "sample string 3",
      "CompanyName": "sample string 4",
      "UserId": "sample string 5",
      "Active": true,
      "Deleted": true,
      "TimeZone": "sample string 8",
      "User": {
        "$id": "4",
        "Id": "sample string 1",
        "Email": "sample string 2",
        "EmailConfirmed": true,
        "UserName": "sample string 10",
        "FirstName": "sample string 11",
        "LastName": "sample string 12",
        "Address1": "sample string 13",
        "Address2": "sample string 14",
        "City": "sample string 15",
        "State": "sample string 16",
        "Country": "sample string 17",
        "ZipCode": "sample string 18",
        "DateRegistered": "2018-12-12T05:46:34.327566+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T05:46:34.327566+00:00",
        "TermsConditions": true,
        "MobileNumber": "sample string 21",
        "ProfileImage": "sample string 22",
        "FullName": "sample string 12, sample string 11",
        "Roles": [
          {
            "$id": "5",
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Users": [
              {
                "$ref": "4"
              },
              {
                "$ref": "4"
              }
            ]
          },
          {
            "$ref": "5"
          }
        ]
      },
      "Plan": {
        "$id": "6",
        "Id": "926fad62-9d49-4843-96db-a18b4f00df7e",
        "PlanName": "sample string 2",
        "Description": "sample string 3",
        "LimitedApps": true,
        "AppLimit": 1,
        "LimitedLocations": true,
        "LocationLimit": 1,
        "LimitedOffers": true,
        "OfferLimit": 1,
        "Amount": 1,
        "WithCall": true,
        "SortNo": 8,
        "Billable": true
      },
      "MerchantLocations": [
        {
          "$id": "7",
          "Id": "811bb980-5e31-48dd-b7f9-88450dc4e6b8",
          "MerchantId": "6d3e0ac5-5f8b-47a1-a3cd-e12c3c2b5fd1",
          "Active": true,
          "Name": "sample string 4",
          "Address1": "sample string 5",
          "Address2": "sample string 6",
          "City": "sample string 7",
          "State": "sample string 8",
          "ZipCode": "sample string 9",
          "PhoneNumber": "sample string 10",
          "Deleted": true,
          "Main": true,
          "Latitude": 1.1,
          "Longitude": 1.1,
          "GeoLocation": null,
          "GeoSpot": true,
          "StoreLocationId": "sample string 14",
          "Merchant": {
            "$ref": "3"
          },
          "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
        },
        {
          "$ref": "7"
        }
      ]
    },
    "App": {
      "$id": "8",
      "Id": "c4623567-726d-4c1f-b993-2f26b32ea282",
      "MerchantId": "8de5d154-bdc2-4a69-9a2b-4cb2180f2441",
      "KeyId": "f924e0d4-b17f-49e1-936e-4fab76c883b7",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T05:46:34.327566+00:00",
      "Modified": "2018-12-12T05:46:34.327566+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "a3f1cc0d-a358-4a4b-b9f5-f501c5f2e6b3",
        "MerchantId": "a045084d-777d-4386-961e-b1034bac632d",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T05:46:34.327566+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "af0532ad-2ba8-40f9-8196-c9ec0064560a",
        "FromConsumerId": "0a8746b6-0359-441f-8867-27e1783c72aa",
        "ToConsumerId": "eb3b7212-f54f-4bbe-968d-a2aedc1a8042",
        "OfferId": "706a44fa-a465-4d81-bd1e-3486bf6275c5",
        "Redeemed": true,
        "Timestamp": "2018-12-12T05:46:34.327566+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T05:46:34.327566+00:00",
        "MerchantLocationId": "948df9aa-988f-41a8-8227-d3f6e7c641ae",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "f462fff8-3fe1-4553-9fbc-03488d28f8f4",
          "Gender": "sample string 2",
          "Address1": "sample string 3",
          "Address2": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "ZipCode": "sample string 7",
          "Image": "sample string 8",
          "Deleted": true
        },
        "Consumer1": {
          "$ref": "11"
        },
        "Offer": {
          "$ref": "2"
        }
      },
      {
        "$ref": "10"
      }
    ]
  },
  "Consumer": {
    "$ref": "11"
  },
  "Barcode": {
    "$id": "12",
    "Id": "65fc02fd-c0c3-47bf-87b9-cc6c0f96c5ee",
    "Type": 1,
    "Code": "sample string 2",
    "Deleted": true
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.UniqueOffer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.UniqueOffer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.