Fixed
Core API v3 reference now matches live responses
October 24th, 2026
We checked every v3 endpoint against the live API and corrected the reference.
Response fields now match what the API returns.
- Order fulfillments return
idandorder_id(previously documented asyotpo_idandyotpo_order_id). - Products and variants return
is_valid_url_format(previouslyis_valid_url). - Order line items return
product_id(previouslyyotpo_product_id). - Newly documented:
order_number,source,store_id, timestamps,paginationand webhooksource.
Examples and required fields work as written.
- Fixed examples for Update order, Create and Update order fulfillment, Send aggregated order info, and Add and Remove product from collection.
- Corrected required fields for checkouts, customers, webhook filters and webhook subscriptions.
- Customers are identified by
external_idoremail. A customer with onlyphone_numberis rejected. order_date_minandorder_date_maxneed a full date and time.
Webhook payloads on Topics reflect real events.
- Loyalty payloads use
customer.referred_by_customer(previouslyreferred_by) and includewebsite_url,store_nameandpublished_at. - Tier Status Changed uses snake_case
vip_statsfields.
Also: every endpoint now documents its 401 and 403 responses, and the SMS & Email Analytics and Subscribers endpoints are marked deprecated.