API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

product_options

Retrieves a product_options resource.

Retrieves a product_options resource.

Authorizations:
JWT
path Parameters
id
required
string

product_options identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "children": [
    ],
  • "parent": { },
  • "owningCorporation": {
    },
  • "shortcode": "AO",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "number": "string",
  • "priority": 0,
  • "color": "string",
  • "icon": "string",
  • "notes": "string",
  • "parameterTitle": "string",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "getTitle": "string",
  • "optionsListing": "string",
  • "productOptionsListing": "string",
  • "translationsListing": "string",
  • "customPropertiesListing": "string",
  • "toString": "string",
  • "translationDescriptionPropertyName": "string",
  • "childrenListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the product_options resource.

Replaces the product_options resource.

Authorizations:
JWT
path Parameters
id
required
string

product_options identifier

Request Body schema:
required

The updated product_options resource

children
Array of objects (product_options.jsonld-post)

// MUST BE MAPPED IN ENTITY

product_options.jsonld-post (object) or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
number
string or null
priority
integer
color
string or null
icon
string or null
notes
string or null
parameterTitle
string
apiTranslations
Array of strings

Responses

Request samples

Content type
{
  • "children": [
    ],
  • "parent": { },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "number": "string",
  • "priority": 0,
  • "color": "string",
  • "icon": "string",
  • "notes": "string",
  • "parameterTitle": "string",
  • "apiTranslations": [
    ]
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "children": [
    ],
  • "parent": { },
  • "owningCorporation": {
    },
  • "shortcode": "AO",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "number": "string",
  • "priority": 0,
  • "color": "string",
  • "icon": "string",
  • "notes": "string",
  • "parameterTitle": "string",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "getTitle": "string",
  • "optionsListing": "string",
  • "productOptionsListing": "string",
  • "translationsListing": "string",
  • "customPropertiesListing": "string",
  • "toString": "string",
  • "translationDescriptionPropertyName": "string",
  • "childrenListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the product_options resource.

Removes the product_options resource.

Authorizations:
JWT
path Parameters
id
required
string

product_options identifier

Responses