Change Updates

Do not miss any Admin APIs API changes, ever again

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

RSS
Admin APIs

Changelog

Last update:
Compare
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /items/{itemId}/variants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • category_id, vendor_id, brand_id, category_name, vendor_name, brand_name properties Added
GET /items/{itemId}/variants/{variantId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • category_id, vendor_id, brand_id, category_name, vendor_name, brand_name properties Added
POST /items/{itemId}/variants
  • Body
  • application/json content type Modified
    • variant property Modified
      • title property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • category_id, vendor_id, brand_id, category_name, vendor_name, brand_name properties Added
PUT /items/{itemId}/variants/{variantId}
  • Body
  • application/json content type Modified
    • variant property Modified
      • title property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • category_id, vendor_id, brand_id, category_name, vendor_name, brand_name properties Added
6 structure changes including:
6 Additions
Added 6
DELETE /items/{itemId}
DELETE /items/{itemId}/variants/{variantId}
GET /items/{itemId}
GET /items/{itemId}/variants/{variantId}
PUT /items/{itemId}
PUT /items/{itemId}/variants/{variantId}
14 structure changes including:
14 Additions
Added 14
DELETE /buyers/{buyerId}
DELETE /buyers/{buyerId}/buyer_users/{buyerUserId}
GET /buyers
GET /buyers/{buyerId}
GET /buyers/{buyerId}/buyer_users
GET /buyers/{buyerId}/buyer_users/{buyerUserId}
POST /buyers
POST /buyers/{buyerId}/buyer_users
POST /buyers/{buyerId}/buyer_users/{buyerUserId}/resend_invitation
POST /buyers/{buyerId}/buyer_users/{buyerUserId}/reset_password
PUT /buyers/{buyerId}
PUT /buyers/{buyerId}/buyer_users/{buyerUserId}
PUT /buyers/{buyerId}/buyer_users/{buyerUserId}/activate
PUT /buyers/{buyerId}/buyer_users/{buyerUserId}/deactivate
15 structure changes including:
15 Additions
Added 15
DELETE /item_images/{itemImageId}
DELETE /price_lists/{priceListId}
DELETE /prices/{priceId}
GET /item_images
GET /item_images/{itemImageId}
GET /price_lists
GET /price_lists/{priceListId}
GET /prices
GET /prices/{priceId}
POST /item_images
POST /price_lists
POST /prices
PUT /item_images/{itemImageId}
PUT /price_lists/{priceListId}
PUT /prices/{priceId}
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /items
  • Body
  • application/json content type Modified
    • item property Modified
      • title, product_code, category_id properties Modified
        • Properties are now required
          Breaking
      • options property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • title, product_code, category_id properties Modified
        • Properties are now required
          Breaking
      • options property Modified
4 structure changes including:
4 Additions
Added 4
GET /items
GET /items/{itemId}/variants
POST /items
POST /items/{itemId}/variants
7 structure changes including:
2 Breaking changes
2 Additions
3 Modifications
2 Removals
Modified 3
GET /brands
  • Query
  • page, limit query parameters Added
GET /orders
  • Query
  • page, limit query parameters Added
GET /vendors
  • Query
  • page, limit query parameters Added
Removed 2 Breaking
GET /categories
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /custom_fields
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
GET /categories
GET /custom_fields
7 structure changes including:
2 Additions
5 Modifications
Modified 5 Breaking
POST /brands
  • Body
  • application/json content type Modified
    • handle, title, description, logo properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • brand property Added
  • multipart/form-data content type Modified
    • logo, handle, title, description properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • brand[logo], brand[handle], brand[title], brand[description] properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id, handle, title, description, logo, created_at, updated_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • brand property Added
POST /categories
  • Body
  • application/json content type Modified
    • title, parent_id, handle properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • category property Added
POST /vendors
  • Body
  • application/json content type Modified
    • name, minimum_order_value, minimum_order_quantity, address1, address2, city, state, zip, country, website, email, phone, ein, order_contact_name, order_contact_phone, payment_contact_name, payment_contact_phone, shipping_type, shipping_scheme, status, order_processing_time, order_processing_on, order_shipping_days, order_processing_cut_off_time, order_terms, description, logo properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • vendor property Added
PUT /brands/{brandId}
  • Body
  • application/json content type Modified
    • handle, title, description, logo properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • brand property Added
PUT /vendors/{vendorId}
  • Body
  • application/json content type Modified
    • name, minimum_order_value, minimum_order_quantity, address1, address2, city, state, zip, country, website, email, phone, ein, order_contact_name, order_contact_phone, payment_contact_name, payment_contact_phone, shipping_type, shipping_scheme, status, order_processing_time, order_processing_on, order_shipping_days, order_processing_cut_off_time, order_terms, description, logo properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • vendor property Added
Added 2
GET /custom_fields
POST /custom_fields
15 structure changes including:
5 Additions
10 Modifications
Modified 10
DELETE /vendors/{vendorId}
  • Response
  • 401, 404, 422 responses Added
GET /
  • Response
  • 401 response Added
GET /categories
  • Response
  • 401, 404 responses Added
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • 401 response Added
GET /orders/{orderId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Order alternative Modified
      • OrderVerbose alternative Added
  • 404 response Modified
    • application/json content type Added
  • 401 response Added
GET /vendors
  • Response
  • 401 response Added
GET /vendors/{vendorId}
  • Response
  • 404 response Modified
    • application/json content type Added
  • 401 response Added
POST /categories
  • Response
  • 401, 404, 422 responses Added
POST /vendors
  • Response
  • 401, 422 responses Added
PUT /vendors/{vendorId}
  • Response
  • 404 response Modified
    • application/json content type Added
  • 401, 422 responses Added
Added 5
DELETE /brands/{brandId}
GET /brands
GET /brands/{brandId}
POST /brands
PUT /brands/{brandId}