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": "449898e9-b52b-4f2a-b75e-624d5b6dc274",
  "OfferId": "4210dbaf-7719-4245-bc33-8b540b502104",
  "MerchantLocationId": "a7a8cd7c-ab85-4ca3-af07-e40516573fa6",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "e7260430-fd15-42ad-a1c7-0902e2e11de5",
    "MerchantId": "6cf9dc01-f53a-4a77-b02b-c7d79b2981c3",
    "AppId": "ef543696-7003-4130-8726-c64a72f0afbf",
    "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": "2019-03-21T01:36:41.8615674+00:00",
    "EndDate": "2019-03-21T01:36:41.8615674+00:00",
    "ExpiryDate": "2019-03-21T01:36:41.8615674+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2019-03-21T01:36:41.8615674+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "55aba17e-f6e9-4671-bc9f-fd6fbbd5da81",
      "PlanId": "e871eece-5941-4889-8e87-e0078b0b2874",
      "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": "2019-03-21T01:36:41.8615674+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2019-03-21T01:36:41.8615674+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": "af224d94-c3d2-4aba-9cb8-9078a57ee7a2",
        "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": "e942a4a4-7599-481c-ba54-022437b109d6",
          "MerchantId": "5f5b88dc-0681-4dee-b095-0c036d4568a5",
          "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": "78da687e-dd10-4ef1-a36a-e7697a6d2298",
      "MerchantId": "c8bd0ec1-e2b2-4b93-a0e9-58cd82c23d27",
      "KeyId": "6c90b88f-40ef-4c3e-991b-5b07c42ae907",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2019-03-21T01:36:41.8615674+00:00",
      "Modified": "2019-03-21T01:36:41.8615674+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "6f48a838-a6f5-4a42-ad23-c93665cfa5c6",
        "MerchantId": "85f8f1fe-a275-4e61-8dad-982dcf843247",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2019-03-21T01:36:41.8615674+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "4d6a8fde-65e6-4665-b372-48bf60096114",
        "FromConsumerId": "7c75169f-b1fe-4180-a2d5-d167af406b23",
        "ToConsumerId": "f371c4ec-5f9c-486d-9d00-be37c16c67c4",
        "OfferId": "7e52ce9a-1cf4-4878-9a89-c460b7b64399",
        "Redeemed": true,
        "Timestamp": "2019-03-21T01:36:41.8615674+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2019-03-21T01:36:41.8615674+00:00",
        "MerchantLocationId": "4c9888d3-815a-46a5-aded-a7ac3d55160c",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "f3612d24-18cc-498b-b59e-911aca7ec3c1",
          "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.