Objects
Field reference for resources you sync or display — products, orders, customers, and related domain models.
Badges show where each object is available today: Merchant API (top-level v1 routes), Nested in API, Webhooks, or Admin / POS (not on Merchant API v1 yet).
product
Merchant APIA product in the shop catalogue.
variant
Nested in APIA sellable variant of a product.
order
Merchant APIAn omnichannel order (POS or storefront).
order_item
Nested in APIA line item on an order.
customer
Merchant APIA customer in the shop directory.
payment
Nested in APIA tender applied to an order.
pagination
Nested in APICursor-less page metadata for list endpoints.
webhook_event
WebhooksPayload delivered to a merchant webhook endpoint.
category
Admin / POSA product category (and optional subcategory tree).
product_option
Admin / POSAn option axis on a product (Size, Colour, …).
product_option_value
Admin / POSA value on a product option (M, Red, …).
product_media
Admin / POSAn image or media asset on a product.
inventory_level
Admin / POSPer-location stock for a variant.
inventory_movement
Admin / POSA stock movement audit row.
shop_location
Admin / POSA physical (or logical) shop location.
gift_card
Admin / POSA shop gift card balance.
discount
Admin / POSA shop discount / promo rule.
address
Admin / POSA shipping or billing address.
suspended_sale
Admin / POSA parked POS basket (suspend / recall).
vendor
Admin / POSA supplier / vendor record.
purchase_order
Admin / POSA purchase order to a vendor.