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": "8630ac6b-77a8-45d7-a48d-91fdccfa8725",
  "OfferId": "faf47be3-40a6-473a-97f9-b377ccb2b8ed",
  "MerchantLocationId": "da233c0a-bd60-4f64-a1cb-eaef6d28929b",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "f2163ab1-2751-4269-a58e-8537be2a5d28",
    "MerchantId": "9ff12b9e-255d-4118-b122-f0a504f6d0fe",
    "AppId": "9950de9f-9198-4ad9-9aab-0e5cfa332a04",
    "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-06-19T03:18:45.1417905+00:00",
    "EndDate": "2018-06-19T03:18:45.1417905+00:00",
    "ExpiryDate": "2018-06-19T03:18:45.1417905+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-06-19T03:18:45.1417905+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "c2e2a55c-9a82-497d-91f8-e16b6599cd95",
      "PlanId": "d6b83518-e473-4982-8523-3c36d34a511b",
      "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-06-19T03:18:45.1417905+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-06-19T03:18:45.1417905+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": "ceb4c9e5-0df9-4a72-930b-71948a96c627",
        "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": "dfa61215-1638-46c3-93cc-d40b5a15e2f5",
          "MerchantId": "527c02a0-748a-4970-b5d2-5100cc6184b0",
          "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,
          "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": "10d51f1a-20e8-4df9-8b0e-8f804cb16c68",
      "MerchantId": "0aeaabde-77a8-4814-ba46-cb7ebe399c52",
      "KeyId": "419cdec6-c76e-4691-ad02-f6faed8ad39f",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-06-19T03:18:45.1417905+00:00",
      "Modified": "2018-06-19T03:18:45.1417905+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "80224922-421c-424f-a5f5-99f9e7369796",
        "MerchantId": "39a892b8-fafc-4b9b-a467-73aa1243885e",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-06-19T03:18:45.1417905+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "a5a4bc6d-881e-4a92-9751-1ae8dbca8fcf",
        "FromConsumerId": "12a86a98-7079-434c-bda5-c258bca02ad0",
        "ToConsumerId": "319c088a-5241-48f0-b371-99f0857349d5",
        "OfferId": "a871dc7a-7d28-499a-ba8b-9ef6315a9b50",
        "Redeemed": true,
        "Timestamp": "2018-06-19T03:18:45.1417905+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-06-19T03:18:45.1417905+00:00",
        "MerchantLocationId": "e89a5c70-ac0d-487e-a737-7f9ca80381e6",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "2061cbc6-aeac-47c6-b2c9-b678acb44b3f",
          "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.