The discount engine object

A comprehensive list of the discount engine resource's attributes and relationships

A discount engine object is returned as part of the response body of each successful list or retrieve API call to the /api/discount_engines endpoint.

Fields

Field
Type
Description

type

string

discount_engines

id

string

The discount engine unique identifier

links.self

string

The discount engine endpoint URL

attributes.name

string

The discount engine's internal name.

attributes.manage_gift_cards

boolean

Indicates if the discount engine manages both promotions and gift cards application at once.

attributes.created_at

string

Time at which the resource was created.

attributes.updated_at

string

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.markets

array

The associated markets.

relationships.discount_engine_items

array

The associated discount engine items.

relationships.attachments

array

The associated attachments.

relationships.event_stores

array

The associated event stores.

meta.mode

string

The resource environment (can be one of test or live)

Last updated