Skip to content

Customer Compare Items

The products the customer has added to their compare list. Right-sidebar panel on the Create-Order screen.

EndpointMethod
/api/admin/customers/{customerId}/compare-itemsGET

Response Fields

Returns the standard { data, meta } envelope. Each row in data:

FieldTypeDescription
idintegerCompare item ID.
productIdintegerThe product.
skustringProduct SKU.
namestringProduct name.
pricenumberUnit price.
formattedPricestringCurrency-formatted unit price.
productImagestring | nullProduct thumbnail URL for the badge.

Requires an admin Bearer token.

TIP

For how the Create-Order helper panels fit together, see the Customers overview.

Released under the MIT License.