Change Updates

Do not miss any MerchantHQ API changes, ever again

Subscribe to the MerchantHQ API changelog to be up to date on recent changes.

RSS
MerchantHQ API

Jan 13, 2025

main
1.0.0
Compare

API structure has changed

47 structure changes including:
29 Breaking changes
18 Additions
3 Modifications
26 Removals
Modified 3 Breaking
PUT /api/2024-09/merchants/{merchant}
  • Path went from /api/2024-09/merchant/{merchant_id} to /api/2024-09/merchants/{merchant} (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • name property Modified
      • Property is now required
        Breaking
  • Path
  • merchant_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • merchant path parameter Added
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
POST /api/2024-09/merchants
  • Path went from /api/2024-09/merchant to /api/2024-09/merchants (same operationId)
    Breaking
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201 response Added
DELETE /api/2024-09/merchants/{merchant}
  • Path went from /api/2024-09/merchant/{merchant_id} to /api/2024-09/merchants/{merchant} (same operationId)
    Breaking
  • Path
  • merchant_id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • merchant path parameter Added
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
Removed 26 Breaking
GET /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/channel/amazon/{amazon_channel}/get-auth-url
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/logout
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/merchant/{merchant_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/merchant/{merchant_id}/channels/{channel_type}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/merchants/managed
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/merchants/owned
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/profile
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/user/{user_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/2024-09/channel/amazon
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/2024-09/login
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/2024-09/merchant/{merchant_id}/assign-manager
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/2024-09/merchant/{merchant_id}/dismiss-manager
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/2024-09/user
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /channel/amazon/oauth/redirect
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/2024-09/channel/amazon/{amazon_channel}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/2024-09/profile
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/2024-09/user/{user_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/2024-09/channel/amazon/{amazon_channel}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/2024-09/user/{user_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/2024-09/channel/amazon/{amazon_channel}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 18
DELETE /api/2024-09/channels/amazon/{amazon_channel}
DELETE /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
GET /api/2024-09/channels/amazon
GET /api/2024-09/channels/amazon/{amazon_channel}
GET /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
GET /api/2024-09/channels/amazon/{amazon_channel}/get-auth-url
GET /api/2024-09/merchants
GET /api/2024-09/merchants/{merchant}
GET /api/2024-09/users/current
GET /api/2024-09/users/merchant-memberships
PATCH /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
POST /api/2024-09/channels/amazon
POST /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
POST /api/2024-09/users/merchant-memberships/invite
POST /api/2024-09/users/merchant-memberships/remove
PUT /api/2024-09/channels/amazon/{amazon_channel}
PUT /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
PUT /api/2024-09/users/current