Skip to content

Public API v2: Data formats

Data Format Example
Field names snake_case product_condition_type
Enum values lowercase strings "decrease_percentage"
Ids (Shopify and the app’s) numeric strings, not numbers, not GIDs "8123456789012"
Money decimal string in the store currency, up to 2 decimals "19.90"
Percentages decimal string, "15.5" is 15.5 % "10"
Dates ISO 8601 in UTC ending in Z; an offset is refused "2026-11-01T01:00:00Z"
Lists arrays; null on a request is the same as leaving it out; reads return [] ["vip", "wholesale"]
  • An unknown field in a request body is refused with 422, so typos do not go unnoticed.
  • Responses may gain new fields and enums may gain new values over time. Ignore fields you do not know and handle unknown values.