Merchant Setup

Publish or unpublish merchant in public directory

Publish (or refresh) the merchant's listing in the public directory. No request body needed to publish — call again after updating tokens/settings. Send { "listed": false } to unpublish (delist); the company and its tokens stay intact, only the public entry is removed. Partner-provisioned merchants (created with an externalId) must pass domain verification before they can publish — an unverified one is rejected with 403.

post/v1/merchants/{id}/directory

Request

  • Base URL: https://api.insumermodel.com
  • URL: https://api.insumermodel.com/v1/merchants/{id}/directory
  • Auth: API key in header X-API-Key

Path parameters

idstring required

Merchant ID

Request body

listedboolean

Set to false to unpublish (delist) the merchant. Omit to publish/refresh.

Response

Published, or unpublished when listed=false

oktrue

Example response

{
  "meta": {
    "version": "1.0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.