List product specs

Request

Security

OAuth2(Required scopes: FullAccessProductAdminProductReader)

Path

productIDstringrequired

ID of the product.

Query

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"Name""ID"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ListOrder""Name""ID""!ListOrder""!Name""!ID"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger, <= 100

Number of results to return per page.

Default:20

filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/products/{productID}/specs?search=string&searchOn=Name&sortBy=ListOrder&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(Spec)

Example:

[
  {
    "OwnerID": "",
    "ID": "",
    "ListOrder": 1,
    "Name": "",
    "DefaultValue": "",
    "Required": false,
    "AllowOpenText": false,
    "DefaultOptionID": "",
    "DefinesVariant": false,
    "xp": {},
    "OptionCount": 0,
    "Options": [ … ]
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}