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
1 structure change including:
1 Modification
Modified 1
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}/current-offers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
5 structure changes including:
5 Modifications
Modified 5
GET /2024-09/marketplaces/catalog-items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_image_url, thumbnail_image_url properties Added
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_image_url, thumbnail_image_url properties Added
GET /2024-09/products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_image_url, thumbnail_image_url properties Added
GET /2024-09/products/{product}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • main_image_url, thumbnail_image_url properties Added
POST /2024-09/products
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • main_image_url, thumbnail_image_url properties Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /2024-09/suppliers/{supplier}/scraping-attempts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • found_opportunities_count property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • found_items_count property Added
16 structure changes including:
7 Breaking changes
7 Additions
2 Modifications
7 Removals
Modified 2 Breaking
GET /2024-09/forecasting/opportunity-forecasts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • sourcing_opportunity_cost_id property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • supplier_item_cost_id property Added
  • Query
  • sourcing_opportunity_cost_id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • supplier_item_cost_id query parameter Added
POST /2024-09/forecasting/opportunity-forecasts/calculate
  • Body
  • application/json content type Modified
    • sourcing_opportunity_cost_id property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • supplier_item_cost_id property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • sourcing_opportunity_cost_id property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • supplier_item_cost_id property Added
Removed 7 Breaking
DELETE /2024-09/sourcing-opportunities/identifiers/{sourcing_opportunity_identifier}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /2024-09/sourcing-opportunities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /2024-09/sourcing-opportunities
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /2024-09/sourcing-opportunities/{sourcing_opportunity}/identifiers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 7
DELETE /2024-09/supplier-items/identifiers/{supplier_item_identifier}
DELETE /2024-09/supplier-items/{supplier_item}
GET /2024-09/supplier-items
GET /2024-09/supplier-items/{supplier_item}
POST /2024-09/supplier-items
POST /2024-09/supplier-items/{supplier_item}/identifiers
PUT /2024-09/supplier-items/{supplier_item}
15 structure changes including:
4 Additions
11 Modifications
Modified 11 Breaking
GET /2024-09/channels/{channel}/catalog-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
GET /2024-09/marketplaces/catalog-items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
GET /2024-09/products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
GET /2024-09/products/{product}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
GET /2024-09/sourcing-opportunities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
GET /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
POST /2024-09/products
  • Body
  • application/json content type Modified
    • upc, ean, gtin, isbn properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
POST /2024-09/sourcing-opportunities
  • Body
  • application/json content type Modified
    • upc, ean, gtin, isbn properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • upc, ean, gtin, isbn properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • identifiers property Added
PUT /2024-09/products/{product}
  • Body
  • application/json content type Modified
    • upc, ean, gtin, isbn properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Body
  • application/json content type Modified
    • upc, ean, gtin, isbn properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Added 4
DELETE /2024-09/products/identifiers/{product_identifier}
DELETE /2024-09/sourcing-opportunities/identifiers/{sourcing_opportunity_identifier}
POST /2024-09/products/{product}/identifiers
POST /2024-09/sourcing-opportunities/{sourcing_opportunity}/identifiers
1 structure change including:
1 Modification
Modified 1 Breaking
POST /2024-09/marketplaces/catalog-item-imports
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id, marketplace_id, marketplace_identifier, import_reason, completed_at, created_at, updated_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
3 structure changes including:
3 Additions
Added 3
GET /2024-09/forecasting/opportunity-forecasts
GET /2024-09/forecasting/sales-volume-forecasts
POST /2024-09/forecasting/opportunity-forecasts/calculate
38 structure changes including:
1 Addition
37 Modifications
Modified 37 Breaking
GET /2024-09/suppliers/{supplier}
  • Response
  • 403 response Added
GET /2024-09/suppliers/{supplier}/scraping-attempts
  • Response
  • 403 response Added
GET /2024-09/suppliers/{supplier}/scraping-requests/{supplier_scraping_request}
  • Response
  • 403 response Added
PATCH /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Response
  • 403 response Added
POST /2024-09/channels
  • Response
  • 403 response Added
POST /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Response
  • 403 response Added
POST /2024-09/channels/amazon/{channel}/connection-data
  • Response
  • 403 response Added
POST /2024-09/merchants
  • Response
  • 404 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 422 response Added
POST /2024-09/products
  • Response
  • 403 response Added
POST /2024-09/products/{product}/images
  • Response
  • 403 response Added
POST /2024-09/sourcing-opportunities
  • Response
  • 403 response Added
POST /2024-09/suppliers
  • Response
  • 403 response Added
POST /2024-09/suppliers/{supplier}/scraping-requests
  • Response
  • 403 response Added
PUT /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Response
  • 403 response Added
PUT /2024-09/channels/{channel}
  • Response
  • 403 response Added
PUT /2024-09/merchants/{merchant}
  • Response
  • 403 response Added
PUT /2024-09/products/{product}
  • Response
  • 403 response Added
PUT /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Response
  • 403 response Added
PUT /2024-09/suppliers/{supplier}
  • Response
  • 403 response Added
DELETE /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Response
  • 403 response Added
DELETE /2024-09/channels/{channel}
  • Response
  • 403 response Added
DELETE /2024-09/merchants/{merchant}
  • Response
  • 403 response Added
DELETE /2024-09/products/{product}
  • Response
  • 403 response Added
DELETE /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Response
  • 403 response Added
DELETE /2024-09/suppliers/{supplier}
  • Response
  • 403 response Added
GET /2024-09/channels
  • Response
  • 403 response Added
GET /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Response
  • 403 response Added
GET /2024-09/channels/amazon/{channel}/get-auth-url
  • Response
  • 403 response Added
GET /2024-09/channels/{channel}
  • Response
  • 403 response Added
GET /2024-09/channels/{channel}/catalog-search
  • Response
  • 403 response Added
GET /2024-09/merchants/{merchant}
  • Response
  • 403 response Added
GET /2024-09/products
  • Response
  • 403 response Added
GET /2024-09/products/{product}
  • Response
  • 403 response Added
GET /2024-09/products/{product}/images
  • Response
  • 403 response Added
GET /2024-09/sourcing-opportunities
  • Response
  • 403 response Added
GET /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Response
  • 403 response Added
GET /2024-09/suppliers
  • Response
  • 403 response Added
Added 1
GET /2024-09/suppliers/{supplier}/scraping-requests
1 structure change including:
1 Modification
Modified 1
GET /2024-09/suppliers/{supplier}/scraping-attempts
  • Query
  • from_date, to_date, not_started query parameters Added
1 structure change including:
1 Modification
Modified 1
GET /2024-09/suppliers/{supplier}/scraping-attempts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • attempt_started_at property Modified
          • Property is no longer required
          • Type went from string(date-time) to string | null
        • scheduled_to_run_at property Added
3 structure changes including:
3 Additions
Added 3
GET /2024-09/suppliers/{supplier}/scraping-attempts
GET /2024-09/suppliers/{supplier}/scraping-requests/{supplier_scraping_request}
POST /2024-09/suppliers/{supplier}/scraping-requests
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /2024-09/sourcing-opportunities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • supplier_id property Modified
          • Type went from string | null to string(uuid)
            Breaking
        • cost, cost_currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • costs property Added
GET /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • supplier_id property Modified
          • Type went from string | null to string(uuid)
            Breaking
        • cost, cost_currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • costs property Added
POST /2024-09/sourcing-opportunities
  • Body
  • application/json content type Modified
    • supplier_id property Modified
      • Property is now required
        Breaking
      • Type went from string | null to string(uuid)
        Breaking
    • sku property Modified
      • Property is now required
        Breaking
    • cost, cost_currency properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • costs property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • supplier_id property Modified
          • Type went from string | null to string(uuid)
            Breaking
        • cost, cost_currency properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • costs property Added
PUT /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Body
  • application/json content type Modified
    • supplier_id, sku, cost, cost_currency properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • costs property Added
3 structure changes including:
2 Additions
1 Modification
Modified 1
GET /2024-09/marketplaces
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • native_currency property Added
Added 2
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}/current-offers
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}/price-history
8 structure changes including:
8 Modifications
Modified 8
GET /2024-09/sourcing-opportunities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • cost_currency property Added
GET /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • cost_currency property Added
GET /2024-09/suppliers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • default_currency property Added
GET /2024-09/suppliers/{supplier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • default_currency property Added
POST /2024-09/sourcing-opportunities
  • Body
  • application/json content type Modified
    • cost_currency property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • cost_currency property Added
POST /2024-09/suppliers
  • Body
  • application/json content type Modified
    • default_currency property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • default_currency property Added
PUT /2024-09/sourcing-opportunities/{sourcing_opportunity}
  • Body
  • application/json content type Modified
    • cost_currency property Added
PUT /2024-09/suppliers/{supplier}
  • Body
  • application/json content type Modified
    • default_currency property Added
1 structure change including:
1 Addition
Added 1
GET /2024-09/channels/{channel}/catalog-search
1 structure change including:
1 Addition
Added 1
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}/sales-ranks
2 structure changes including:
2 Additions
Added 2
GET /2024-09/marketplaces/catalog-item-imports
POST /2024-09/marketplaces/catalog-item-imports
4 structure changes including:
4 Additions
Added 4
GET /2024-09/marketplaces
GET /2024-09/marketplaces/catalog-items
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}
GET /2024-09/marketplaces/catalog-items/{marketplace_catalog_item}/images
16 structure changes including:
5 Breaking changes
6 Additions
5 Modifications
5 Removals
Modified 5 Breaking
DELETE /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Path went from /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{channel}/call/{endpoint} (same operationId)
  • Path
  • amazon_channel path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • channel path parameter Added
GET /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Path went from /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{channel}/call/{endpoint} (same operationId)
  • Path
  • amazon_channel path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • channel path parameter Added
PATCH /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Path went from /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{channel}/call/{endpoint} (same operationId)
  • Path
  • amazon_channel path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • channel path parameter Added
POST /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Path went from /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{channel}/call/{endpoint} (same operationId)
  • Path
  • amazon_channel path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • channel path parameter Added
PUT /2024-09/channels/amazon/{channel}/call/{endpoint}
  • Path went from /2024-09/channels/amazon/{amazon_channel}/call/{endpoint} to /2024-09/channels/amazon/{channel}/call/{endpoint} (same operationId)
  • Path
  • amazon_channel path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • channel path parameter Added
Removed 5 Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /2024-09/channels/amazon
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /2024-09/channels/amazon/{amazon_channel}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /2024-09/channels/amazon
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /2024-09/channels/amazon/{amazon_channel}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 6
DELETE /2024-09/channels/{channel}
GET /2024-09/channels
GET /2024-09/channels/{channel}
POST /2024-09/channels
POST /2024-09/channels/amazon/{channel}/connection-data
PUT /2024-09/channels/{channel}
10 structure changes including:
5 Breaking changes
5 Additions
5 Removals
Removed 5 Breaking
DELETE /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
DELETE /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
GET /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
PATCH /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
POST /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}
PUT /2024-09/channels/amazon/{amazon_channel}/call/{endpoint}