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 16, 2025

main
1.0.0
Compare

API structure has changed

19 structure changes including:
4 Breaking changes
19 Modifications
Modified 19 Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string
      Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to DELETE (same operationId)
    Breaking
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
DELETE /2024-09/merchants/{merchant}
  • Path
  • merchant path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
GET /2024-09/channels/amazon
  • Query
  • merchant_id query parameter Modified
    • Type went from integer to string(uuid)
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
GET /2024-09/channels/amazon/{amazon_channel}
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
GET /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to GET (same operationId)
    Breaking
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
GET /2024-09/merchants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
GET /2024-09/merchants/{merchant}
  • Path
  • merchant path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
GET /2024-09/users/current
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
GET /2024-09/users/merchant-memberships
  • Query
  • merchant_id query parameter Modified
    • Type went from integer to string(uuid)
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
PATCH /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
POST /2024-09/channels/amazon
  • Body
  • application/json content type Modified
    • merchant_id property Modified
      • Type went from integer to string(uuid)
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
POST /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to POST (same operationId)
    Breaking
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
POST /2024-09/merchants
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string(uuid)
            Breaking
POST /2024-09/users/merchant-memberships/invite
  • Body
  • application/json content type Modified
    • merchant_id property Modified
      • Type went from integer to string(uuid)
        Breaking
POST /2024-09/users/merchant-memberships/remove
  • Body
  • application/json content type Modified
    • merchant_id, user_id properties Modified
      • Type went from integer to string(uuid)
        Breaking
PUT /2024-09/channels/amazon/{amazon_channel}
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string
      Breaking
PUT /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to PUT (same operationId)
    Breaking
  • Path
  • amazon_channel path parameter Modified
    • Type went from integer to string(uuid)
      Breaking
PUT /2024-09/merchants/{merchant}
  • Path
  • merchant path parameter Modified
    • Type went from integer to string(uuid)
      Breaking