The price list scheduler object

A comprehensive list of the price list scheduler resource's attributes and relationships

A price list scheduler object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/price_list_schedulers endpoint.

Fields

FieldTypeDescription

type

string

price_list_schedulers

id

string

The price list scheduler unique identifier

links.self

string

The price list scheduler endpoint URL

attributes.name

string

The price list scheduler's internal name

attributes.starts_at

datetime

The activation date/time of this price list scheduler.

attributes.expires_at

datetime

The expiration date/time of this price list scheduler (must be after starts_at).

attributes.active

boolean

Indicates if the price list scheduler is active (enabled and not expired).

attributes.status

string

The price list scheduler status, one of 'expired', 'pending', 'active', or 'disabled'.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

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.

attributes._disable

boolean

Send this attribute if you want to mark this resource as disabled.

attributes._enable

boolean

Send this attribute if you want to mark this resource as enabled.

attributes.disabled_at

datetime

Time at which this resource was disabled.

relationships.market

object

The associated market.

relationships.price_list

object

The associated price list.

relationships.events

array

The associated events.

relationships.versions

array

The associated changes.

meta.mode

string

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

Last updated