2024

December

2024-12-13

• Updated the Webhook Event Matrix to detail the events that fire for Categories (aka Taxons)
• Updated the Webhook Getting Started Guide to detail the entities that support webhooks from both an Operator and Seller perspective.
  • A reference to this information has also been placed in the Webhook Event Matrix
• Updated Custom Field Guide to
  • Clarify how Custom Field Groups map to their respective parent entities.
  • Clarify how the position index can be used to prioritize both Custom Fields and Groups
• Added the following examples to the Insomnia and Postman collections for Operators:
  • Custom Field Group Create - Seller (includes position index)
  • Custom Field Group Update - Seller (includes position index)
  • Custom Field Group Create - Shipping Rule (includes position index)
  • Custom Field Group Update - Shipping Rule (includes position index)
  • Change Custom Field Group Position Index
  • Change Custom Field Position Index
  • Custom Field Create - Seller - SINGLE SELECT
  • Custom Field Update - Seller - SINGLE SELECT
  • Custom Field Create - Shipping Rule - TEXT
  • Custom Field Update - Shipping Rule - TEXT

November

2024-11-18

• Updated Custom Field Guide covering the inclusion of the position field
• Supported custom field types have also increased

2024-11-06

• Updated the API collections as follows:
  • Operator:
    • Added taxonSearch query
    • Updated Custom Field examples to include recent additions
    • Added schema introspection query
    • Added contextualHistory query
  • Seller:
    • Added taxonSearch query
    • Added schema introspection query

October

2024-10-29

• Updated Custom Field Guide covering the following changes to Custom Fields:
  • Custom Fields can now be defined against Shipping Rules
  • Additional field types now supported including: Single & Multi Select

2024-10-23

• Clarified the use of externalIds when used with LineItemInput in the orderCreate mutation.

2024-10-17

• [Beta] New reference doc format added. This is based on the Operator API schema but it is not dynamically generated in line with Operator API updates unlike GraphDoc and GraphQL Voyager.

2024-10-09

• Updated the operator Creating Orders guide to include creating Click and Collect orders
• Added a Seller Click and Collect guide that details how to query click and collect orders, then transition them through their various states.

2024-10-08

• Added Return Delivery Charges to playbooks section. This describes how you can pass back postage charges to the customer when a return is initiated.

2024-10-03

• Updated How to create orders to remove redundant / non-supported integration patterns.

September

2024-09-26

• Added How to add ExternalIds guide, this covers adding externalIds when objects are created (e.g. using orderCreate), as well as adding externalIds to existing objects, including the ability to add multiple externalIds with 1 call using externalIdsUpsert. The article also discusses querying objects by their externalId.

• Updated the How to add metadata guide, to cover the new functionality provided by metadata2Upsert, which allows for the attachment of multiple metadata with 1 call.

2024-09-23

• Added the Product Creation Primer guide as high-level overview of how to create products taking into account additional concepts such as Catalog Rules and Product Vetting.

2024-09-09

• Added How to upload products via spreadsheet using the API guide.

August

2024-08-21

• Added further definitions to the Glossary and added an Alias column to assist with language consistency between other platforms.

2024-08-16

• Added Seller Integration Playbook. This will assist sellers and channel mangers developing integrations into Marketplacer.

2024-08-08

• Updated Legacy Seller API docs to state new maximum page size of 1100

July

2024-07-25

• Restructured Playbooks from 1 flat structure to the following dedicated sections with a view to enhancing discoverability:
  • General Concepts: Introductory, core-concept and overview playbooks suited to all audiences.
  • Operator: Playbooks aimed specifically at Operators and System Integrators
  • Seller & Channel Manager: Playbooks aimed specifically at Sellers and Channel Managers

2024-07-24

• Added Postman instructions to the Seller Getting Started Guide

2024-07-23

• Restructured Operator Videos section to include a dedicated Integrations sub-section.
• Added How to Manage Webhooks guide to the Operator API How To… section. Covers the creation, updating and querying of webhooks and their associated entitles.

2024-07-22

• Added advertDelete mutation example to both Operator and Seller API collections.

2024-07-19

• Added How to Manage Sellers guide to the Operator API How To… section. Covers the creation and updating of sellers.

2024-07-18

• Added Retrieving products to be vetted video to the operator video collection
• Added the following queries and mutations to the Operator API collections:
  • allSellers: Allows you to return deleted sellers
  • sellersWhere : Allows you to return sellers using a number of filters

2024-07-17

• Updated optionTypeCreateOrUpdate mutation example in the Operator API collection:
  • Add appliedTo
  • Add fieldType
  • Remove category 🧨(deprecated)
• Added Create Taxonomy How to Guide. Details the steps to create: Taxons, Prototypes, Option Types and Option Values.
• Added the following queries and mutations to the Operator API collections:
  • advertUpsert: The ability for Operators to now create Products
  • advertsWhere: The retrieval of Products to be vetted - expands on this example
  • variantUpdate: Update existing variant

2024-07-15

• Updated Webhook Event Matrix to include the events for the Advanced Refunds flow.

• Added a change log for documentation

June

2024-06-28

• Added code example on how to Base64 encode files. This approach can be used anytime files need to be provided to mutations.

• Added a new Utility section to Code Examples. This section will contain examples that are not directly related to any API, but are either ubiquitous across all APIs, or are supporting in nature.

2024-06-27

• Added further Shipping Rules and Return Shipment queries and mutations to the API collections

2024-06-26

• Updated How to Manage Products to reflect the fact the Operators can now create products.

• Added Return Shipment How to Article and updated the main Advanced Refunds Docs.

2024-06-24

• Updated the Shipping Rules How to for Operators to include the mutations and queries that can be used to create and manage things like Zones, Rates etc.

• Created new Shipping Rules How to for Sellers. This covers how to create and manage Shipping Rules from a Seller perspective.

• Added a detailed Advanced Refunds Flow for Sellers.

• Added Most Used Queries and Mutations for Sellers

2024-06-12

• Updated How to Manage Products for both Operators and Sellers to reflect that fact that an externalId can now be used with advertUpsert as an identifier for updates.

May

2024-05-24

• Added instructions on how to convert a JSON formatted GraphQL schema to an SDL formatted based schema definition

• Added a new selection of videos for Sellers

2024-05-16

• Updated the Webhook Event Matrix to reflect the fact that update events that used to follow create events will no longer occur.

2024-05-07

• Added a How to Work with Product Images for both Sellers and Operators.

2024-05-02

• Added Webhook Headers Definitions to Webhooks Overview.

• Added commercetools Connect to Operator Code section.

2024-05-01

• Added Code Section to Docs

April

2024-04-22

• Updated Getting Started with Webhooks to update webhook event retention period

2024-04-17

• Added Promotions How To Guide for Operators

2024-04-08

• Updated How to Manage Products for both Operators and Sellers to reflect that mapping values are available for Brand and Taxon.

March

2024-03-26

• Added User Management How To Guide for Sellers.

2024-03-22

• Added In-line Chat How to Guide for Operators and Sellers

2024-03-18

• Updated Webhook Docs to reflect the fact you can now configure retry parameters

2024-03-15

• Updated Webhook Docs to cover the the renaming of the “blank” status to “skipped”

2024-03-13

• Updated API Collections to include Golden Product Queries and Mutations

2024-03-08

• Added PII disclaimer to Custom Field Documentation

2024-03-06

• Added Golden Product How To Guide for Operators

• Added Contextual History How To Guide for Operators

February

2024-02-22

• Add requiresVetting attribute to the Advert Vetting docs for both Operators and Sellers

2024-02-06

• Add API Key Rotation Policy to Playbooks Section