Ribbon Object


A Ribbon is a visual element that you can assign to products to highlight them on your site.

Properties
idstringRead-onlyformat GUID

Ribbon ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the ribbon is updated. To prevent conflicting changes, the current revision must be passed when updating the ribbon.

Ignored when creating a ribbon.


createdDatestringRead-onlyformat date-time

Date and time the ribbon was created.


updatedDatestringRead-onlyformat date-time

Date and time the ribbon was updated.


namestringminLength 1maxLength 30

Ribbon name.


assignedProductCountintegerRead-onlyformat int32

Number of products this ribbon is assigned to.

Note: Returned only when you pass "ASSIGNED_PRODUCT_COUNT" to the fields array in Ribbon API requests.

Ribbon
JSON
{ "ribbon": { "id": "2254c3b3-6bbd-457d-b868-9122657c5d1c", "revision": "1", "createdDate": "2024-06-26T08:34:04.787Z", "updatedDate": "2024-06-26T08:34:04.787Z", "name": "New Arrival!", "assignedProductCount": 3 } }
Did this help?