GET api/OfferLocations/ByMerchantLocationId/{merchantLocationId}

Get OfferLocations by merchantLocationId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
merchantLocationId

Id for the MerchantLocation

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of OfferLocations

OfferLocation
NameDescriptionTypeAdditional information
Id

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

globally unique identifier

None.

OfferId

Guid OfferId for OfferLocation. [NULLABLE]

globally unique identifier

None.

MerchantLocationId

Guid MerchantLocationId for OfferLocation. [NULLABLE]

globally unique identifier

None.

Deleted

Indicates whether the OfferLocation has been deleted or not. Set to false on Create by system. Set to true on delete by system. [REQUIRED]

boolean

None.

Offer

Gets the Offer using OfferId.

Offer

None.

MerchantLocation

Gets the MerchantLocation using MerchantLocationId.

MerchantLocation

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "93d43a90-1382-4d95-be14-9da092587fb0",
  "OfferId": "f9ac97e3-dd43-4135-8eac-12e79009a5b7",
  "MerchantLocationId": "b5b8d6e9-c23f-4303-8f89-c604a3486914",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "08c60ef4-8b0f-478f-870f-672b5554b27c",
    "MerchantId": "32239b10-b6e8-4565-8f8c-c2b90c7b8581",
    "AppId": "ab972583-c1c0-4b20-8ce8-81975461e6af",
    "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:10:44.3425029+00:00",
    "EndDate": "2018-12-12T05:10:44.3425029+00:00",
    "ExpiryDate": "2018-12-12T05:10:44.3425029+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T05:10:44.3425029+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "9286a583-4543-472d-804a-d1d5c931084d",
      "PlanId": "da784a7b-c925-48e0-969d-5273c1ae5cea",
      "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:10:44.3425029+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T05:10:44.3425029+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": "efc333a5-4a58-48b0-b477-962f379768b8",
        "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": "6efbfd39-92bf-461e-ada6-60bcb457645e",
          "MerchantId": "0e0e646c-06e9-4eb9-98da-7dcb57c5c7dc",
          "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": "4b7469ca-92b0-4725-825f-59ae7ec5201a",
      "MerchantId": "134d7c7e-6b75-40d2-8415-b2625514cb4c",
      "KeyId": "f6503333-bba7-4a6d-86d6-8d80c2218d34",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T05:10:44.3425029+00:00",
      "Modified": "2018-12-12T05:10:44.3425029+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "893aa655-dcbd-4957-8af8-5a3e0fcc70b4",
        "MerchantId": "b61172f0-9108-4f06-9641-d72965645e38",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T05:10:44.3425029+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "eb986b9a-a27c-4876-b544-2ea735545e9b",
        "FromConsumerId": "b0e5948f-bcf7-4cd3-a09a-6e1018ae6f89",
        "ToConsumerId": "bd770824-524b-410e-a05f-0568ba5dd4fe",
        "OfferId": "50df5843-0371-4cff-b519-7660af6f9755",
        "Redeemed": true,
        "Timestamp": "2018-12-12T05:10:44.3425029+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T05:10:44.3425029+00:00",
        "MerchantLocationId": "73c38c8c-0e1e-48cb-b4fd-ad82299932d6",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "f7bcea2d-79a2-48aa-b54e-45cac8554f2b",
          "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"
      }
    ]
  },
  "MerchantLocation": {
    "$ref": "7"
  }
}

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 'FaceOffers.Entities.Consumer' 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 'FaceOffers.Entities.Consumer' contains cycles and cannot be serialized if reference tracking is disabled.