Improved

Every Core API v3 response field is now described

Every field in every Core API v3 response now has a description. Earlier today this covered the 10 most-used endpoints. It now covers the rest of the reference too.

Newly described:

  • Error bodies on every endpoint, with what each status's message tells you
  • Retrieve fulfillment by ID, Retrieve product variant by ID and Retrieve products in collection
  • The responses of the create calls
  • Webhook targets, filters and subscriptions

Worth knowing: treat an error's message as text for your logs, not a value to match in code. Its wording can change. See Errors.