PUT api/Merchants

Request Information

URI Parameters

None.

Body Parameters

Merchant
NameDescriptionTypeAdditional information
Id

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

globally unique identifier

None.

PlanId

GUID PlanId for Merchant. [NULL]

globally unique identifier

None.

StripeToken

The Stripe Token. Generated by Portal. Used for billing. [NULL]

string

None.

StripeCustomerId

The Stripe CustomerId. Generated by Portal. Used for billing [NULL]

string

None.

CompanyName

The name of the company. [NULL]

string

None.

UserId

The UserId for the Merchant. [NULL]

string

String length: inclusive between 0 and 128

Active

Indicates whether the Merchant account is active or not. [REQUIRED]

boolean

None.

Deleted

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

boolean

None.

TimeZone

Time zone of the Merchant. Example: "Central Standard Time" [NULL]

string

String length: inclusive between 0 and 50

User

Gets the User for the Merchant using UserId.

User

None.

Plan

Get the Plan for the Merchant using the PlanId.

Plan

None.

MerchantLocations

Collection of MerchantLocation

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "ac17968c-ba18-40ff-ac2e-dbf99eee4107",
  "PlanId": "54683834-c829-435d-8e26-66f28015c56e",
  "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": "2",
    "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-21T20:28:28.1525192+00:00",
    "RegistrationCompleted": true,
    "LastLogin": "2018-09-21T20:28:28.1525192+00:00",
    "TermsConditions": true,
    "MobileNumber": "sample string 21",
    "ProfileImage": "sample string 22",
    "FullName": "sample string 12, sample string 11",
    "Roles": [
      {
        "$id": "3",
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Users": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ]
      },
      {
        "$ref": "3"
      }
    ]
  },
  "Plan": {
    "$id": "4",
    "Id": "b0f15f92-cd80-4d20-8fa3-112e2bbcc155",
    "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": "5",
      "Id": "c75c3662-dfbe-4f90-90e1-6bf9fef56196",
      "MerchantId": "d1d64747-7eff-4262-987a-ee1172daf8db",
      "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": "1"
      },
      "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
    },
    {
      "$ref": "5"
    }
  ]
}

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

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Merchant'.

Response Information

Resource Description

MerchantViewModel
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

PlanId

globally unique identifier

None.

CompanyName

string

None.

UserId

string

None.

Active

boolean

None.

TimeZone

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "4ef543e8-0853-4f73-a10e-f04a3669c791",
  "PlanId": "c0bdd500-76e2-4c93-813d-2bad85618b66",
  "CompanyName": "sample string 2",
  "UserId": "sample string 3",
  "Active": true,
  "TimeZone": "sample string 5"
}

application/xml, text/xml

Sample:
<MerchantViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FaceOffers.Api.Models">
  <Active>true</Active>
  <CompanyName>sample string 2</CompanyName>
  <Id>4ef543e8-0853-4f73-a10e-f04a3669c791</Id>
  <PlanId>c0bdd500-76e2-4c93-813d-2bad85618b66</PlanId>
  <TimeZone>sample string 5</TimeZone>
  <UserId>sample string 3</UserId>
</MerchantViewModel>