Fixed
Orders, products, customers and webhooks now match the live API
October 25th, 2026
We corrected the reference for the orders, fulfillments, products, customers and webhooks endpoints to match how the API actually behaves:
- Field names: products and variants return
is_valid_url_format(notis_valid_url). Fulfillments returnid,order_idandstore_id. - Retrieve Orders:
order_date_minandorder_date_maxneed a full date and time, such as2024-01-01T00:00:00Z. A date on its own returns a 400 error. - Create or Update Customer: send the customer as a
customerobject, identified byexternal_id,emailor both. A customer sent with onlyphone_numberis rejected. - Update Order Fulfillment: send the fields inside a
fulfillmentobject. The fulfillment'sexternal_idcan't be changed. - Webhooks:
- Create target, filter and subscription return
201, and delete returns200. - Target and filter IDs are integers.
- A subscription needs
target_id,filter_idandactive. - Target URLs must use
https://.
- Create target, filter and subscription return
- Webhook deliveries: use the
WebhookMessageIdPerTargetheader to ignore duplicates. Review events don't have atopicfield, so read the event name from theX-Yotpo-Webhooks-Event-Typeheader. - Response fields for these endpoints now have descriptions. Retrieve Products also documents the
handlesfilter.
Endpoints affected: Retrieve Orders, Retrieve Order Fulfillments, Update Order Fulfillment, Retrieve Products, Retrieve product variants, Create or Update Customer, Retrieve Customers, all webhook target, filter, store subscription and app subscription endpoints, About Webhooks, Yotpo Events, Guidelines and Conventions.
