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

Changelog

Last update:
Compare
14 structure changes including:
4 Breaking changes
10 Additions
4 Modifications
Modified 4 Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to DELETE (same operationId)
    Breaking
GET /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to GET (same operationId)
    Breaking
POST /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to POST (same operationId)
    Breaking
PUT /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to PUT (same operationId)
    Breaking
Added 10
DELETE /2024-09/sourcing-opportunities/{sourcing_opportunity}
DELETE /2024-09/suppliers/{supplier}
GET /2024-09/sourcing-opportunities
GET /2024-09/sourcing-opportunities/{sourcing_opportunity}
GET /2024-09/suppliers
GET /2024-09/suppliers/{supplier}
POST /2024-09/sourcing-opportunities
POST /2024-09/suppliers
PUT /2024-09/sourcing-opportunities/{sourcing_opportunity}
PUT /2024-09/suppliers/{supplier}
11 structure changes including:
4 Breaking changes
7 Additions
4 Modifications
Modified 4 Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to DELETE (same operationId)
    Breaking
GET /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to GET (same operationId)
    Breaking
POST /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to POST (same operationId)
    Breaking
PUT /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Verb went from PATCH to PUT (same operationId)
    Breaking
Added 7
DELETE /2024-09/products/{product}
GET /2024-09/products
GET /2024-09/products/{product}
GET /2024-09/products/{product}/images
POST /2024-09/products
POST /2024-09/products/{product}/images
PUT /2024-09/products/{product}
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
21 structure changes including:
21 Breaking changes
21 Modifications
Modified 21 Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel} to /2024-09/channels/amazon/{amazon_channel} (same operationId)
    Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} (same operationId)
    Breaking
  • Verb went from PATCH to DELETE (same operationId)
    Breaking
DELETE /2024-09/merchants/{merchant}
  • Path went from /api/2024-09/merchants/{merchant} to /2024-09/merchants/{merchant} (same operationId)
    Breaking
GET /2024-09/channels/amazon
  • Path went from /api/2024-09/channels/amazon to /2024-09/channels/amazon (same operationId)
    Breaking
GET /2024-09/channels/amazon/{amazon_channel}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel} to /2024-09/channels/amazon/{amazon_channel} (same operationId)
    Breaking
GET /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} (same operationId)
    Breaking
  • Verb went from PATCH to GET (same operationId)
    Breaking
GET /2024-09/channels/amazon/{amazon_channel}/get-auth-url
  • Path went from /api/2024-09/channels/amazon/{amazon_channel}/get-auth-url to /2024-09/channels/amazon/{amazon_channel}/get-auth-url (same operationId)
    Breaking
GET /2024-09/merchants
  • Path went from /api/2024-09/merchants to /2024-09/merchants (same operationId)
    Breaking
GET /2024-09/merchants/{merchant}
  • Path went from /api/2024-09/merchants/{merchant} to /2024-09/merchants/{merchant} (same operationId)
    Breaking
GET /2024-09/users/current
  • Path went from /api/2024-09/users/current to /2024-09/users/current (same operationId)
    Breaking
GET /2024-09/users/merchant-memberships
  • Path went from /api/2024-09/users/merchant-memberships to /2024-09/users/merchant-memberships (same operationId)
    Breaking
PATCH /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} (same operationId)
    Breaking
POST /2024-09/channels/amazon
  • Path went from /api/2024-09/channels/amazon to /2024-09/channels/amazon (same operationId)
    Breaking
POST /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} (same operationId)
    Breaking
  • Verb went from PATCH to POST (same operationId)
    Breaking
POST /2024-09/merchants
  • Path went from /api/2024-09/merchants to /2024-09/merchants (same operationId)
    Breaking
POST /2024-09/users/merchant-memberships/invite
  • Path went from /api/2024-09/users/merchant-memberships/invite to /2024-09/users/merchant-memberships/invite (same operationId)
    Breaking
POST /2024-09/users/merchant-memberships/remove
  • Path went from /api/2024-09/users/merchant-memberships/remove to /2024-09/users/merchant-memberships/remove (same operationId)
    Breaking
PUT /2024-09/channels/amazon/{amazon_channel}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel} to /2024-09/channels/amazon/{amazon_channel} (same operationId)
    Breaking
PUT /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Path went from /api/2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} (same operationId)
    Breaking
  • Verb went from PATCH to PUT (same operationId)
    Breaking
PUT /2024-09/merchants/{merchant}
  • Path went from /api/2024-09/merchants/{merchant} to /2024-09/merchants/{merchant} (same operationId)
    Breaking
PUT /2024-09/users/current
  • Path went from /api/2024-09/users/current to /2024-09/users/current (same operationId)
    Breaking
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
8 structure changes including:
1 Breaking change
7 Additions
1 Removal
Removed 1 Breaking
POST /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 7
DELETE /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
GET /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
GET /api/2024-09/channel/amazon/{amazon_channel}/get-auth-url
PATCH /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
POST /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
POST /channel/amazon/oauth/redirect
PUT /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
45 structure changes including:
22 Breaking changes
23 Additions
22 Removals
Removed 22 Breaking
DELETE /api/channel/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/merchant/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/user/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/channel/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/channels
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/logout
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/merchant/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/merchant/{id}/{type}/channels
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/merchants
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/profile
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/user/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/amazon/call
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/channel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/login
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/merchant
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/user
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/user/{id}/channels
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/channel/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/merchant/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/profile
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/user/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 23
DELETE /api/2024-09/channel/amazon/{amazon_channel}
DELETE /api/2024-09/merchant/{merchant_id}
DELETE /api/2024-09/user/{user_id}
GET /api/2024-09/channel/amazon/{amazon_channel}
GET /api/2024-09/logout
GET /api/2024-09/merchant/{merchant_id}
GET /api/2024-09/merchant/{merchant_id}/channels/{channel_type}
GET /api/2024-09/merchants/managed
GET /api/2024-09/merchants/owned
GET /api/2024-09/profile
GET /api/2024-09/user/{user_id}
GET /api/2024-09/users
POST /api/2024-09/channel/amazon
POST /api/2024-09/channel/amazon/{amazon_channel}/call/{url}
POST /api/2024-09/login
POST /api/2024-09/merchant
POST /api/2024-09/merchant/{merchant_id}/assign-manager
POST /api/2024-09/merchant/{merchant_id}/dismiss-manager
POST /api/2024-09/user
PUT /api/2024-09/channel/amazon/{amazon_channel}
PUT /api/2024-09/merchant/{merchant_id}
PUT /api/2024-09/profile
PUT /api/2024-09/user/{user_id}