Follow

Create External Merchant

Create a new external Merchant for specified agency. If a Merchant with the same ID already exists then it will be replaced by the new Merchant. 

 

Attributes 

Attribute

Value

Path

/v3/MAC/{0}/externalMerchants

Support Formats

JSON, XML

HTTP Method

POST

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        204 - No Content

·        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

POST /v3/MAC/3/externalMerchants HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Body 

{

    "id":"AAABBBZZZ",

    "systemType":10,

    "name":"Test Merchant",

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

    "addressLine1":"1a Queen St",

    "addressLine2":"CBD",

    "addressLine3":"Auckland",

    "emailAddress":"",

    "phoneNumber":"",

    "postCode":"",

    "websiteUrl":"",

    "description":"Great news!",

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

    "isHidden":"false"

}

 Notes:

  • {0} must be a valid organisation ID of the Merchant's Agency 

 

Successful Response

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

Type

Value

Header

HTTP/1.1 204 No Content

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache


Notes:
None

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.