Strategy Parameters

List Strategy Postal Codes

Get a list of strategy postal codes with default sort by id DESC. Can be queried by:

  • id,
  • name,
  • value,
  • code,
  • exclude,
  • strategy_id is required and can be sorted by:
  • id,
  • name,
  • value,
  • code,
  • strategy_id.
get/strategy_postal_codes

Request

Query parameters

page_limitinteger
Example:100

Number of elements in the collection to retrieve

page_offsetinteger

Index of the first element in the collection to retrieve

sort_bystring
Example:id, -id, name, -name

The field to sort by. You can use any field name in ascending or descending order. For ascending order, use the field name directly, e.g., id. For descending order, prefix the field name with a hyphen (-), e.g., -id.

qstring

Query search for filtering. This parameter can be used to filter results based on various fields. Supported operators:

  • == - numeric equality or case-sensitive string identity,
  • ==(1,2,3) - IN query (only works for integers),
  • != - numeric inequality or case-sensitive string non-identity,
  • =: - case-insensitive match, allows substring using * wildcards,
  • !: - case-insensitive non-match ("does not contain"), allows substring using * wildcards; rows where the field is NULL are excluded,
  • < - less than,
  • <= - less than or equal to,
  • > - greater than,
  • >= - greater than or equal to. Examples:
  • q=name=:{search}* to find all results with names starting with {search}.
  • Numeric q=id=:*123* searches are treated as exact primary-key matches, equivalent to q=id==123; likewise q=id!:*123* is equivalent to q=id!=123.
  • q=name!:*promo* to exclude all results whose name contains "promo".
  • q=status==true to find all active entities.
  • q=id>=1000 to find all entities with id greater than or equal to 1000.
  • q=id==(1,2,3) to find specific entities by ID.
  • q=created_on>1999-02-02 or q=created_on>1999-02-02T00:00:00Z to find entities created later than date.
  • q=id>5&status==true to find all active entities with id greater than 5.
fullstring
Example:*

To return all fields, set the value to *. For example, full=* will include all properties.

Response

List strategy postal codes response

OR

Example response

{
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.