Follow

List External Merchants

Returns a list of Merchants which exist for a given Agency and system type. This is used where the master source of Merchants is a 3rd party API and an import tool needs a list of Merchants which have been created by the import. Technically an External Merchant is a combination of a 'Merchant' and a 'CrossReference_Merchant'. The ID of the Merchant is ignored and replaced with the external ID from the cross reference record.

 

Attributes 

Attribute

Value

Path

/v3/MAC/{0}/externalMerchants

Support Formats

JSON, XML

HTTP Method

GET

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        200 - OK

·        400 - Bad Request

·        500 - Internal Server Error 

 

Request

The following table contains the details of a typical HTTP request for this service:

Type

Value

Header

GET /v3/MAC/3/externalMerchants?systemType=10 HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Query
Param 

?systemType=(SystemType)

 

 Notes:

  1. The system type is a numeric value to identify the external system. e.g. Facebook may equal 1, Twitter = 2, etc.

 

Successful Response

The following table contains the details of a typical successful HTTP request for this service.

Type

Value

Header

HTTP/1.1 200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Body

[

  {

    "id": "AAABBBZZZ",

    "systemType": null,

    "name": "Test Merchant 1",

    "companyRegistrationNumber": "123-321-12",

    "addressLine1": "1a Queen St",

    "addressLine2": "CBD",

    "addressLine3": "Auckland",

    "emailAddress": "",

    "phoneNumber": "",

    "postCode": "",

    "websiteUrl": "",

    "parentOrganisationId": 3,

    "organisationId": 12,

    "ExtendedData": "Custom JSON data goes here.",

    "Description": "Great news!",

    "isHidden": false

  },

  {

    "id": "AAABBBZZZ1",

    "systemType": null,

    "name": "Test Merchant 2",

    "companyRegistrationNumber": "123-321-12",

    "addressLine1": "2a Queen St",

    "addressLine2": "CBD",

    "addressLine3": "Auckland",

    "emailAddress": "",

    "phoneNumber": "",

    "postCode": "",

    "websiteUrl": "",

    "parentOrganisationId": 3,

    "organisationId": 13,

    "ExtendedData": null,

    "Description": null,

    "isHidden": true

  }

]


Notes:

  • {0} must be a valid organisation ID of the Merchant's Agency
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.