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": "f5349c14-13a4-4c4e-b4ec-2053c383c540",
  "OfferId": "85a7ebc1-31d9-4ff7-85c2-4ab31c79a4d6",
  "MerchantLocationId": "53c3f9c2-dc6b-4004-96da-43670b3e0334",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "30279f59-5dbc-46b8-8d17-52268c41c2b1",
    "MerchantId": "399481e8-c4c9-4a2b-8e16-614fb2daef32",
    "AppId": "043301f1-cbe2-4709-809c-ac6eb86a270b",
    "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-09-20T02:02:52.0519656+00:00",
    "EndDate": "2018-09-20T02:02:52.0519656+00:00",
    "ExpiryDate": "2018-09-20T02:02:52.0519656+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-20T02:02:52.0519656+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "24978d40-6b5f-4586-a74e-8063603c738d",
      "PlanId": "05a42b90-40ee-4e67-b72c-c0e7459db547",
      "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-09-20T02:02:52.0519656+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-20T02:02:52.0519656+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": "a8ef5969-dea8-43cf-9ab1-50c98fecb24f",
        "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": "57ab7318-429e-415c-adca-72f037bba8fa",
          "MerchantId": "6daa00fe-4d21-4257-9f51-fb4fdae876c5",
          "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,
          "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": "58ea8535-cf8c-44c4-9be4-d63b82726227",
      "MerchantId": "963228f8-0888-4537-94b1-73f18aa445a1",
      "KeyId": "c665fadb-1d5d-4794-afa6-eb179ceaf5e1",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-20T02:02:52.0519656+00:00",
      "Modified": "2018-09-20T02:02:52.0519656+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "c115bab1-6cb3-4af8-be10-72b0614f8d00",
        "MerchantId": "d8a017d0-160e-42bd-b65e-7d2858b580bb",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-20T02:02:52.0519656+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "43e4ffd2-1379-4cff-8bef-8d6a06867ca1",
        "FromConsumerId": "469d64dd-40f9-4c6b-9527-5b01ccb8afd3",
        "ToConsumerId": "e5a3b0dd-17e2-4267-a79e-c515bbf08305",
        "OfferId": "762226ed-3589-46bc-8ecd-22be80c665cf",
        "Redeemed": true,
        "Timestamp": "2018-09-20T02:02:52.0519656+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-20T02:02:52.0519656+00:00",
        "MerchantLocationId": "d4118b9b-e89b-442e-8e47-f35cef9d437d",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "908487de-7edd-4350-9fd0-cafe25624224",
          "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.