2024

2024 Documentation Change Log

November

2024-11-18

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

2024-10-17

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

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

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

2024-08-08

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

2024-07-23

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

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


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

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

2024-05-02

2024-05-01


April

2024-04-22

2024-04-17

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

2024-03-22

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

2024-03-06


February

2024-02-22

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

2024-02-06