Combined API documentation for platform services.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31165376","collectionId":"bf5f8042-6aef-4d0d-84aa-0d2868bc526b","publishedId":"2sBYAuRAVv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-27T07:04:33.000Z"},"item":[{"name":"Cart","item":[{"name":"Admin Carts","item":[{"name":"List shopper carts abandoned for a configurable idle period","id":"c576188c-1bb0-4cff-97a1-abb5566b53fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(Required) Store identifier. Determines which store context the request executes against.
\n","key":"x-xm-store","value":"{{xmStore}}"},{"description":"Preferred locale for localized content (e.g. product/category names, descriptions). Falls back to the store's default locale if omitted.
\n","key":"Accept-Language","value":"{{locale}}"},{"key":"Accept","value":"application/json"}],"url":"/admin/carts/abandoned?idle-hours=Returns a paginated report of active carts that still contain items but have had no shopper activity for a specified number of idle hours, helping store admins identify potential cart-recovery or remarketing opportunities. Since carts are deleted once their order is placed, every cart returned by this endpoint represents a shopper who never completed checkout. Results can be filtered by minimum idle time and by a lower bound on last activity date, and support standard pagination and sorting, though sorting is restricted to the lastActivity field (newest first by default) because cart totals are stored as JSON and are not queryable as sortable columns. This endpoint requires store-admin privileges scoped to order/cart management. On success, it returns a paged list of AbandonedCartDto objects along with standard pagination metadata (page number, size, total elements, total pages, etc.). Use this in conjunction with cart or order detail endpoints to follow up on specific abandoned carts.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"bf5f8042-6aef-4d0d-84aa-0d2868bc526b","id":"bf5f8042-6aef-4d0d-84aa-0d2868bc526b","name":"Platform Admin API Documentation","type":"collection"}},"urlObject":{"path":["admin","carts","abandoned"],"host":[""],"query":[{"description":{"content":"Number of hours a cart must have been untouched by the shopper to be considered abandoned. Optional; defaults to 24. Values below 1 are automatically treated as 1.
\n","type":"text/plain"},"key":"idle-hours","value":"Optional lower bound (inclusive) on the cart's last activity date, in ISO format YYYY-MM-DD. Since there is no automatic expiry of old abandoned carts, omitting this parameter causes the report to include carts dating back to store launch.
\n","type":"text/plain"},"key":"date-from","value":"(Required) Store identifier. Determines which store context the request executes against.
\n","key":"x-xm-store","value":"{{xmStore}}"},{"description":"Preferred locale for localized content (e.g. product/category names, descriptions). Falls back to the store's default locale if omitted.
\n","key":"Accept-Language","value":"{{locale}}"},{"key":"Accept","value":"application/json"}],"url":"/admin/carts/:id","description":"Fetches a specific cart belonging to the current store, identified by its numeric ID, and returns it exactly as persisted — with no repricing, tax recalculation, or promotion re-evaluation applied. This endpoint serves as the drill-in detail view for the abandoned carts report (GET /admin/carts/abandoned), but it is not limited to abandoned carts; any cart owned by the store can be retrieved this way, including active or converted ones (though carts are deleted once their order is placed, so completed carts will no longer be retrievable). Typical use cases include store-admin tooling for investigating shopper drop-off, customer support lookups when reconciling a shopper's saved items, and auditing cart contents/totals as they existed at the last point of activity. The caller must have the 'verified' OAuth scope, a valid store context, the ADMIN_ORDER privilege, and either the CART_ADMIN or ADMIN_ORDER authority (privilege and authority are both required — AND relationship; either listed authority satisfies the OR condition among authorities). On success, the response contains the cart's line items, stored totals, and metadata wrapped in a standard success envelope; if no cart with the given ID exists in this store, an error response is returned via the same envelope with success set to false.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"bf5f8042-6aef-4d0d-84aa-0d2868bc526b","id":"bf5f8042-6aef-4d0d-84aa-0d2868bc526b","name":"Platform Admin API Documentation","type":"collection"}},"urlObject":{"path":["admin","carts",":id"],"host":[""],"query":[],"variable":[{"description":{"content":"(Required) The numeric identifier of the cart to retrieve. Required path parameter. Must correspond to an existing cart belonging to the authenticated store; carts are removed once their order is placed, so IDs for converted carts will not resolve.
\n","type":"text/plain"},"type":"any","value":"(Required) Store identifier. Determines which store context the request executes against.
\n","key":"x-xm-store","value":"{{xmStore}}"},{"description":"Preferred locale for localized content (e.g. product/category names, descriptions). Falls back to the store's default locale if omitted.
\n","key":"Accept-Language","value":"{{locale}}"},{"key":"Accept","value":"application/json"}],"url":"/admin/custom-fields?entityType=Retrieves a paginated list of custom fields configured in the system for administrative management purposes. Custom fields allow extending standard entities (like orders, customers, products) with additional data fields specific to business requirements. This endpoint is typically used by admin interfaces to display, manage, and configure custom field definitions. The response includes metadata about field types, validation rules, and entity associations. Requires admin-level authentication with either ADMIN_CUSTOMER privilege or USER_ADMIN authority. Returns a paginated response with total count information for building admin dashboards and management interfaces.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"bf5f8042-6aef-4d0d-84aa-0d2868bc526b","id":"bf5f8042-6aef-4d0d-84aa-0d2868bc526b","name":"Platform Admin API Documentation","type":"collection"}},"urlObject":{"path":["admin","custom-fields"],"host":[""],"query":[{"description":{"content":"Filters custom fields by the entity type they are associated with. This allows retrieving only custom fields that belong to specific business entities like orders, customers, products, etc. When omitted, returns custom fields for all entity types. Must be a valid entity type string as configured in the system.
\n","type":"text/plain"},"key":"entityType","value":"Zero-based page number for pagination. Specifies which page of results to retrieve when the total number of custom fields exceeds the page size. Must be a non-negative integer. Defaults to 0 (first page) if not specified.
\n","type":"text/plain"},"key":"page","value":"Number of custom field records to return per page. Controls the pagination size for the response. Must be a positive integer. When set to -1 or omitted, returns all available records without pagination. Typical values range from 10-100 depending on UI requirements.
\n","type":"text/plain"},"key":"size","value":"