REST API Reference

/ws/merchants/

Methods: GET, POST

GET

Retrieves a list of your merchants.

Example GET Response

      [
        {
          "MerchRef":"W410095",
          "BrokerKey":"30",
          "MerchName":"Bob's Bakery",
          "MerchCorpName":null,
          "MerchContact":"Bob",
          "MerchPhone":"555-555-5555",
          "MerchFax":"",
          "MerchEmail":"bob@example.com",
          "MerchAddr1":"123 Anywhere St.",
          "MerchAddr2":"",
          "MerchCity":"Tulsa",
          "MerchState":"OK",
          "MerchZip":"60450",
          "MerchCountry":"US",
          "DealerKey":null,
          "LastOrder":"2011-06-14",
          "TotOrders":"45",
          "CurrOrders":"2",
          "Quotes":"3"
        },
        {
          "MerchRef":"W410096",
          "BrokerKey":"30",
          "MerchName":"Sally's Salon",
          "MerchCorpName":null,
          "MerchContact":"Sally",
          "MerchPhone":"555-555-5555",
          "MerchFax":"",
          "MerchEmail":"sally@example.com",
          "MerchAddr1":"321 Anywhere St.",
          "MerchAddr2":"",
          "MerchCity":"San Jose",
          "MerchState":"CA",
          "MerchZip":"90832",
          "MerchCountry":"US",
          "DealerKey":null,
          "LastOrder":"2011-06-29",
          "TotOrders":"5",
          "CurrOrders":"2",
          "Quotes":"1"
        }
      ]
    

POST

Acts upon the resource using the action parameter in the URI query string.

Parameter	Type	Description
action	string	One of the following actions: create
MerchantID	string	Used in conjunction with the create action.

Example POST Request

      POST /ws/merchants?action=create&MerchantID=3483