Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 2.34 KB

list-price-points-filter.md

File metadata and controls

42 lines (34 loc) · 2.34 KB
Raw

List Price Points Filter

Structure

ListPricePointsFilter

Fields

Name Type Tags Description
DateField *models.BasicDateField Optional The type of filter you would like to apply to your search. Use in query: filter[date_field]=created_at.
StartDate *time.Time Optional The start date (format YYYY-MM-DD) with which to filter the date_field. Returns price points with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
EndDate *time.Time Optional The end date (format YYYY-MM-DD) with which to filter the date_field. Returns price points with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
StartDatetime *time.Time Optional The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns price points with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date.
EndDatetime *time.Time Optional The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns price points with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date.
Type []models.PricePointType Optional Allows fetching price points with matching type. Use in query: filter[type]=custom,catalog.
Ids []int Optional Allows fetching price points with matching id based on provided values. Use in query: filter[ids]=1,2,3.
ArchivedAt *models.IncludeNullOrNotNull Optional Allows fetching price points only if archived_at is present or not. Use in query: filter[archived_at]=not_null.

Example (as JSON)

{
  "start_date": "2011-12-17",
  "end_date": "2011-12-15",
  "start_datetime": "12/19/2011 09:15:30",
  "end_datetime": "06/07/2019 17:20:06",
  "type": [
    "catalog",
    "default",
    "custom"
  ],
  "ids": [
    1,
    2,
    3
  ],
  "date_field": "updated_at"
}