Response shape
Successful JSON responses put the resource under data. A detail request normally returns one object; a list returns an array. Pagination metadata, where supported, is returned alongside data under page.
A write may return the stored record, an identifier or a confirmation object. Check the operation's response schema rather than assuming all writes return the same shape. Operations returning 204 have no response body.
Collection sets, galleries, global option sets, product categories and product groups read the resource back after writes. The result can differ from the submitted payload because the backend normalizes stored values. Inspect the response, particularly after multi-step creation, before treating a synchronization as complete.
Last updated
Was this helpful?